DoAuthorization API Operation (SOAP)
APILegacyLast updated: October 12th 2021, @ 6:58:00 pm
Authorizes a payment.
DoAuthorization Request Message
Note: Only the fields described in this documentation are available for use.
DoAuthorization Request Fields
Field | Description |
---|---|
|
(Required) Value of the order's transaction identification number returned by PayPal. `partial:partials/docs/shared/cl_transactionid.en-XC` |
|
(Required) Amount to authorize. Character length and limitations: `partial:partials/docs/shared/cl_currencylimit.en-XC` |
| (Optional) Type of transaction to authorize. The only allowable value is |
|
(Optional) Details about each individual item included in the order. |
| (Optional) Shipping address for this order. |
|
(Optional) Sum of cost of all items in this order. You must set the Character length and limitations: `partial:partials/docs/shared/cl_currencylimit.en-XC` |
|
(Optional) Total shipping costs for this order. You must set the Character length and limitations: `partial:partials/docs/shared/cl_currencylimit.en-XC` |
|
(Optional) Total handling costs for this order. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies. Character length and limitations: `partial:partials/docs/shared/cl_currencylimit.en-XC` |
|
(Optional) Sum of tax for all items in this order. Character length and limitations: `partial:partials/docs/shared/cl_currencylimit.en-XC` |
|
(Optional) Total shipping insurance costs for this order. Character length and limitations: `partial:partials/docs/shared/cl_currencylimit.en-XC` |
|
(Optional) Shipping discount for this order, specified as a negative number. Character length and limitations: `partial:partials/docs/shared/cl_currencylimit_neg.en-XC` |
|
(Optional) Description of items the customer is purchasing. Character length and limitations: 127 single-byte alphanumeric characters. |
|
(Optional) A free-form field for your own use. Character length and limitations: 256 single-byte alphanumeric characters. |
|
(Optional) IP address of the buyer. |
|
(Optional) Indicates if the item purchased will be shipped to a store location. |
| (Optional) A message ID used for idempotence to uniquely identify a message. This ID can later be used to request the latest results for a previous request without generating a new request. Examples of this include requests due to timeouts or errors during the original request. Character length and limitations: string of up to 38 single-byte characters. This field is available since version 92.0. |
AddressType Fields
Field | Description |
---|---|
|
Person's name associated with this shipping address. It is required if using a shipping address. Character length and limitations: 128 double-byte characters |
|
First street address. It is required if using a shipping address. Character length and limitations: 100 single-byte characters |
|
(Optional) Second street address. Character length and limitations: 100 single-byte characters |
|
Name of city. It is required if using a shipping address. Character length and limitations: 40 single-byte characters |
|
State or province. Character length and limitations: 40 single-byte characters |
|
U.S. ZIP code or other country-specific postal code. It is required if using a U.S. shipping address; may be required for other countries. Character length and limitations: 20 single-byte characters |
|
Country code. It is required if using a shipping address. Character length and limitations: 2 single-byte characters |
|
(Optional) Phone number. Character length and limitations: 20 single-byte characters |
PaymentDetailsItemType Fields
Field | Description |
---|---|
| (Optional) Item name. Character length and limitations: 127 single-byte characters |
| (Optional) Item number. Character length and limitations: 127 single-byte characters |
| (Optional) Item quantity. Character length and limitations: Any positive integer |
|
(Optional) Item sales tax. Note: You must set the Character length and limitations: `partial:partials/docs/shared/cl_currencylimit.en-XC` |
|
(Optional) Cost of item. Note: You must set the Character length and limitations: `partial:partials/docs/shared/cl_currencylimit.en-XC` |
| (Optional) Information relating to an auction sale on eBay. |
|
(Optional) Promotional financing code for item. Part of the Merchant Services Promotion Financing feature. |
|
(Optional) |
|
(Optional) Item description. Character length and limitations: 127 single-byte characters |
|
(Optional) Information about the Item weight. |
|
(Optional) Information about the Item length. |
|
(Optional) Information about the Item width. |
|
(Optional) Information about the Item height. |
|
(Optional) URL for the item. Character length and limitations: no limit. |
|
(Optional) Enhanced data for each item in the cart. |
|
(Optional) Item category - physical or digital. |
DoAuthorization Response Message
Note: Only the fields described in this documentation are available for use.