Name-Value Pair API Developer Guide Last updated: February 01, 2013
Name-Value Pair API Developer Guide Document Number: 100018.en_US-201302 © 2013 PayPal, Inc. All rights reserved. PayPal is a registered trademark of PayPal, Inc. The PayPal logo is a trademark of PayPal, Inc. Other trademarks and brands are the property of their respective owners. The information in this document belongs to PayPal, Inc. It may not be used, reproduced or disclosed without the written approval of PayPal, Inc. Copyright © PayPal. All rights reserved. PayPal S.à r.l. et Cie, S.C.A.
Contents What’s New . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 What's New . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 About This Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Where to Go for More Information . . . . . . . . . . .
Contents Address Verify Response Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Chapter 3 Authorization and Capture API Operation Reference . . . . 27 DoCapture API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 DoCapture Request Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 DoCapture Response Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 DoAuthorization API Operation . . . . . . . . . . . . . . . . .
Contents DoNonReferencedCredit Response Message . . . . . . . . . . . . . . . . . . . . . . . . 54 DoNonReferencedCredit Response Fields . . . . . . . . . . . . . . . . . . . . . . . 54 Chapter 6 ExpressCheckout API Operations . . . . . . . . . . . . . . 55 Callback API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 Callback API Request Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 Callback Response Message . . . . . . . . . . . . . . . . . . .
Contents Address Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .124 Payment Information Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .125 Payment Item Information Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . .129 Payment Item Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .130 Auction Information Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .131 Subscription Terms Fields . . . . . .
Contents SetCustomerBillingAgreement API Operation . . . . . . . . . . . . . . . . . . . . . . . .162 SetCustomerBillingAgreement Request Message. . . . . . . . . . . . . . . . . . . .163 SetCustomerBillingAgreement Response Message . . . . . . . . . . . . . . . . . . .166 GetBillingAgreementCustomerDetails API Operation . . . . . . . . . . . . . . . . . . . .167 GetBillingAgreementCustomerDetails Request Message . . . . . . . . . . . . . . . .167 GetBillingAgreementCustomerDetails Response Message . . . .
Contents TransactionSearch API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .239 RefundTransaction API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .240 MassPay API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .244 Recurring Payments Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .247 SetCustomerBillingAgreement Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents New RefundInfoType in RefundTransaction Response . . . . . . . . . . . . . . . . .292 New Field in DoReferenceTransactionResponseDetailsType . . . . . . . . . . . . .293 New Field in DoDirectPaymentResponse . . . . . . . . . . . . . . . . . . . . . . . .293 What’s New in Version 82.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .293 New Field in DoCapture Request . . . . . . . . . . . . . . . . . . . . . . . . . . . .293 New MerchantStoreDetailsType in DoCapture Request . . .
Contents 10 February 01, 2013 Name-Value Pair API Developer Guide
What’s New What's New Maintenance release. See the latest version of the PayPal Merchant API Release Notes for more information: https://www.x.
What's New 12 February 01, 2013 Name-Value Pair API Developer Guide
Preface About This Guide The Name-Value Pair API Developer Guide describes the PayPal Name-Value Pair API. Intended Audience This guide is written for developers who are implementing solutions using the Name-Value Pair API. Where to Go for More Information Express Checkout Integration Guide Express Checkout Advanced Features Guide Merchant Setup and Administration Guide Documentation Feedback Help us improve this guide by sending feedback to: documentationfeedback@paypal.
Documentation Feedback 14 February 01, 2013 Name-Value Pair API Developer Guide
1 PayPal Name-Value Pair API Basics The Name-Value Pair (NVP) API provides parameter-based association between request and response fields of a message and their values. The request message is sent from your website by the API, and a response message is returned by PayPal using a client-server model in which your site is a client of the PayPal server.
1 PayPal Name-Value Pair API Basics PayPal API Client-Server Architecture PayPal Name-Value Pair API Requests and Responses To perform a PayPal NVP API operation, you send an NVP-formatted request to a PayPal NVP server and interpret the response. In the following diagram, your website generates a request. The request is executed on a PayPal server and the response is returned to your site.
PayPal Name-Value Pair API Basics NVP Format 1 1. Invoke an API operation, such as SetExpressCheckout, that sets up the return URL to which PayPal redirects your buyer’s browser after the buyer finishes on PayPal. Other setup actions also can be performed by this API operation. 2. Invoke additional API operations after receiving the buyer’s permission on PayPal, for example, GetExpressCheckoutDetails or DoExpressCheckoutPayment.
1 PayPal Name-Value Pair API Basics Creating an NVP Request Name-value pairs are separated by an ampersand (&). For example: FIRSTNAME=Robert&MIDDLENAME=Herbert&LASTNAME=Moore The values for each value in an NVP string are URL-encoded.
PayPal Name-Value Pair API Basics Creating an NVP Request 1 2. Choose the appropriate version. In most cases, you should use the latest version of the API operation. VERSION=version_number Specifying an API Credential Using Signatures You must specify API credentials in each request to execute a PayPal API operation. You can use either a signature or a certificate, but not both.
1 PayPal Name-Value Pair API Basics Creating an NVP Request SUBJECT=merchantEmailAddress Typically, a merchant grants third-party permissions to a shopping cart. The merchant previously must have given you permission to execute the API operation. NOT E : Specifying Credentials Using cURL The following example shows one way to specify a signature using cURL: curl --insecure https://api-3t.sandbox.paypal.com/nvp -d ^ "METHOD=name^ &VERSION=XX.
PayPal Name-Value Pair API Basics Executing NVP API Operations Language 1 Method Classic ASP Java PHP ColdFusion Encode Server.URLEncode Decode No built-in function. Several implementation examples are available on the Internet. Encode java.net.URLEncoder.encode Decode java.net.URLDecoder.
1 PayPal Name-Value Pair API Basics Responding to an NVP Response To execute a PayPal NVP API operation, submit the request to one of the following end points: Server end point Description https://api3t.sandbox.paypal.com/nvp Sandbox server for use with API signatures; use for testing your API https://api-3t.paypal.com/nvp PayPal “live” production server for use with API signatures https://api.sandbox.paypal.
PayPal Name-Value Pair API Basics Responding to an NVP Response 1 Related information: PayPal API Client-Server Architecture Common Response Fields The PayPal API always returns common fields in addition to fields that are specific to the requested PayPal API operation. A PayPal API response includes the following fields: Field Description ACK Acknowledgement status, which is one of the following values: Success indicates a successful operation.
1 PayPal Name-Value Pair API Basics Responding to an NVP Response Format of an Error Response Response Fields on Error ACK=notSuccess&TIMESTAMP=date/timeOfResponse& CORRELATIONID=debuggingToken&VERSION=VersionNo& BUILD=buildNumber&L_ERRORCODE0=errorCode& L_SHORTMESSAGE0=shortMessage& L_LONGMESSAGE0=longMessage& L_SEVERITYCODE0=severityCode Multiple errors can be returned. Each set of errors has a different numeric suffix, starting with 0 and incremented by one for each error.
2 AddressVerify API Operation The AddressVerify API operation confirms whether a postal address and postal code match those of the specified PayPal account holder. AddressVerify Request Message Address Verify Request Fields Field Description METHOD (Required) Must be AddressVerify. EMAIL (Required) Email address of a PayPal member to verify. Character length and limitations: 255 single-byte characters maximum with the input mask: ?@?.
2 AddressVerify API Operation AddressVerify Response Message AddressVerify Response Message Address Verify Response Fields Field Description CONFIRMATIONCODE Indicates whether the address is a confirmed address on file at PayPal. It is one of the following values: None – The request value of the Email element does not match any email address on file at PayPal. Confirmed – If the response value of the StreetMatch element is Matched, the entire postal address is confirmed.
3 Authorization and Capture API Operation Reference The Authorization and Capture API operations describe the PayPal API operations related to delayed payment settlement: DoCapture API Operation Captures an authorized payment. DoCapture Request Message DoCapture Request Fields Field Description METHOD (Required) Must be DoCapture. AUTHORIZATIONID (Required) Authorization identification number of the payment you want to capture.
3 Authorization and Capture API Operation Reference DoCapture API Operation Field Description INVNUM (Optional) Your invoice number or other identification number that is displayed to you and to the buyer in their transaction history. The value is recorded only if the authorization you are capturing is an Express Checkout order authorization. NOTE: This value on DoCapture overwrites a value previously set on DoAuthorization.
Authorization and Capture API Operation Reference DoCapture API Operation 3 Merchant Store Details Fields Field Description STOREID Identifier of the merchant store at which the refund is given. This field is required for point-of-sale transactions. Character length and limitations: 50 single-byte characters This field is available since version 82.0. TERMINALID (Optional) ID of the terminal. Character length and limitations: 50 single-byte characters This field is available since version 82.0.
3 Authorization and Capture API Operation Reference DoCapture API Operation Field Description PARENTTRANSACTIONID Parent or related transaction identification number. This field is populated for the following transaction types: Reversal. Capture of an authorized transaction. Reversal. Reauthorization of a transaction. Capture of an order. The value of ParentTransactionID is the original OrderID. Authorization of an order. The value of ParentTransactionID is the original OrderID.
Authorization and Capture API Operation Reference DoCapture API Operation Field Description SETTLEAMT Amount deposited in your PayPal account after a currency conversion. Character length and limitations: Value is a positive number which cannot exceed $10,000 USD in any currency. It includes no currency symbol. It must have 2 decimal places, the decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Equivalent to 9 characters maximum for USD.
3 Authorization and Capture API Operation Reference DoAuthorization API Operation Field Description PENDINGREASON NOTE: PendingReason is returned in the response only if PaymentStatus is Pending. This field does not apply to capturing point-of-sale authorizations, which do not create pending payments. Reason the payment is pending. It is one of the following values: none: – No pending reason.
Authorization and Capture API Operation Reference DoAuthorization API Operation Field Description AMT (Required) Amount to authorize. Character length and limitations: Value is a positive number which cannot exceed $10,000 USD in any currency. It includes no currency symbol. It must have 2 decimal places, the decimal separator must be a period (.), and the optional thousands separator must be a comma (,). TRANSACTIONENTITY (Optional) Type of transaction to authorize.
3 Authorization and Capture API Operation Reference DoAuthorization API Operation AuthorizationInfo Fields 34 Field Description PAYMENTSTATUS Status of the payment. It is one of the following values: None – No status. Canceled-Reversal – A reversal has been canceled. For example, when you win a dispute, PayPal returns the funds for the reversal to you. Completed – The payment has been completed, and the funds have been added successfully to your account balance.
Authorization and Capture API Operation Reference DoAuthorization API Operation Field Description PENDINGREASON Reason the payment is pending. It is one of the following values: none – No pending reason. address – The payment is pending because your customer did not include a confirmed shipping address and your Payment Receiving Preferences is set such that you want to manually accept or deny each of these payments. To change your preference, go to the Preferences section of your Profile.
3 Authorization and Capture API Operation Reference DoReauthorization API Operation Field Description PROTECTIONELIGIBILITY TYPE Since version 64.4, the kind of seller protection in force for the transaction. It is one of the following values: Eligible – Merchant is protected by PayPal's Seller Protection Policy for both Unauthorized Payment and Item Not Received. ItemNotReceivedEligible – Merchant is protected by PayPal's Seller Protection Policy for Item Not Received.
Authorization and Capture API Operation Reference DoReauthorization API Operation 3 DoReauthorization Response Message DoReauthorization Response Fields Field Description AUTHORIZATIONID New authorization identification number. Character length and limits:19 single-byte characters MSGSUBID 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.
3 Authorization and Capture API Operation Reference DoReauthorization API Operation Field Description PENDINGREASON Reason the payment is pending. It is one of the following values: none – No pending reason. address – The payment is pending because your customer did not include a confirmed shipping address and your Payment Receiving Preferences is set such that you want to manually accept or deny each of these payments. To change your preference, go to the Preferences section of your Profile.
Authorization and Capture API Operation Reference DoVoid API Operation Field Description PROTECTIONELIGIBILITY TYPE Since version 64.4, the kind of seller protection in force for the transaction. It is one of the following values: Eligible – Merchant is protected by PayPal's Seller Protection Policy for both Unauthorized Payment and Item Not Received. ItemNotReceivedEligible – Merchant is protected by PayPal's Seller Protection Policy for Item Not Received.
3 Authorization and Capture API Operation Reference DoVoid API Operation DoVoid Response Message DoVoid Response Fields 40 Field Description AUTHORIZATIONID Authorization identification number you specified in the request. Character length and limitations: 19 single-byte characters MSGSUBID 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.
4 DoDirectPayment API Operation The DoDirectPayment API Operation enables you to process a credit card payment. DoDirectPayment Request Message DoDirectPayment Request Fields Field Description METHOD (Required) Must be DoDirectPayment. PAYMENTACTION (Optional) How you want to obtain payment. It is one of the following values: Authorization – This payment is a basic authorization subject to settlement with PayPal Authorization and Capture.
4 DoDirectPayment API Operation DoDirectPayment Request Message Credit Card Details Fields Field Description CREDITCARDTYPE (Optional) Type of credit card. For UK, only Maestro, MasterCard, Discover, and Visa are allowable. For Canada, only MasterCard and Visa are allowable and Interac debit cards are not supported. It is one of the following values: Visa MasterCard Discover Amex Maestro: See note. NOTE: If the credit card type is Maestro, you must set CURRENCYCODE to GBP.
DoDirectPayment API Operation DoDirectPayment Request Message Field Description FIRSTNAME (Conditional) Buyer’s first name is required except when the reference transaction is run against a billing agreement. In the case of a billing agreement, the first name field should not be used. Character length and limitations: 25 single-byte characters LASTNAME (Conditional) Buyer’s last name is required except when the reference transaction is run against a billing agreement.
4 DoDirectPayment API Operation DoDirectPayment Request Message Payment Details Fields Field Description AMT (Required) The total cost of the transaction to the buyer. If shipping cost and tax charges are known, include them in this value. If not, this value should be the current subtotal of the order. If the transaction includes one or more one-time purchases, this field must be equal to the sum of the purchases. This field must be set to a value greater than 0.
DoDirectPayment API Operation DoDirectPayment Request Message Field Description HANDLINGAMT (Optional) Total handling costs for this order. NOTE: 4 If you specify a value for HANDLINGAMT, you must also specify a value for ITEMAMT. Character length and limitations: Value is a positive number which cannot exceed $10,000 USD in any currency. It includes no currency symbol. It must have 2 decimal places, the decimal separator must be a period (.), and the optional thousands separator must be a comma (,).
4 DoDirectPayment API Operation DoDirectPayment Request Message Field Description RECURRING ns:RecurringFlagType (Optional) Flag to indicate a recurring transaction. It is one of the following values: Any value other than Y – This is not a recurring transaction (default). Y – This is a recurring transaction. NOTE: To pass Y in this field, you must have established a billing agreement with the buyer specifying the amount, frequency, and duration of the recurring payment.
DoDirectPayment API Operation DoDirectPayment Request Message 4 Ebay Item Payment Details Item Fields Field Description L_EBAYITEMNUMBERn (Optional) Auction item number. These parameters must be ordered sequentially beginning with 0 (for example L_EBAYITEMNUMBER0, L_EBAYITEMNUMBER1). Character length: 765 single-byte characters L_EBAYITEMAUCTIONTX NIDn (Optional) Auction transaction identification number.
4 DoDirectPayment API Operation DoDirectPayment Response Message 3D Secure Request Fields (U.K. Merchants Only) Field Description AUTHSTATUS3DS (Optional) A value returned by the Cardinal Centinel. If the cmpi_lookup request returns Y for Enrolled, set this field to the PAResStatus value returned by cmpi_authenticate. Otherwise, set this field to blank. MPIVENDOR3DS (Optional) A value returned by the Cardinal Centinel. Set this field to the Enrolled value returned by cmpi_lookup.
DoDirectPayment API Operation DoDirectPayment Response Message Field Description L_FMFfilterIDn Filter ID, including the filter type (PENDING, REPORT, or DENY), the filter ID, and the entry number, n, starting from 0.
4 DoDirectPayment API Operation DoDirectPayment Response Message ThreeDSecure Response Fields Field Description VPAS Visa Payer Authentication Service status. The value indicates whether Verified by Visa confirms that the information received is acceptable. It is eturned only for Verified by Visa transactions.
5 DoNonReferencedCredit API Operation The DoNonReferencedCredit API issues a credit to a card not referenced by the original transaction. DoNonReferencedCredit Request Message DoNonReferencedCredit Request Fields Field Description METHOD (Required) Must be DoNonReferencedCredit. AMT (Required) Total of order, including shipping, handling, and tax. Amount = NetAmount + ShippingAmount + TaxAmount Character length and limitations: Must not exceed $10,000 USD in any currency. No currency symbol.
5 DoNonReferencedCredit API Operation DoNonReferencedCredit Request Message Field Description NOTE (Optional) Field used by merchant to record why this credit was issued to a buyer. It is similar to a “memo” field (freeform text or string field). CURRENCYCODE (Required) Currency code (default is USD). NOTE: The only valid currencies are AUD, CAD, EUR, GBP, JPY, and USD. Credit Card Details Type Fields Field Description CREDITCARDTYPE (Optional) Type of credit card.
DoNonReferencedCredit API Operation DoNonReferencedCredit Request Message 5 Payer Name Type Fields Field Description SALUTATION (Optional)Buyer's salutation. Character length and limitations: 20 single-byte characters FIRSTNAME (Optional)Buyer's first name. Character length and limitations: 25 single-byte characters MIDDLENAME (Optional)Buyer's middle name. Character length and limitations: 25 single-byte characters LASTNAME (Optional)Buyer's last name.
5 DoNonReferencedCredit API Operation DoNonReferencedCredit Response Message Field Description STATE (Required) State or province. Character length and limitations: 40 single-byte characters COUNTRYCODE (Required) Country code. Character length and limitationst: 2 single-byte characters ZIP (Required) U.S. ZIP code or other country-specific postal code. Character length and limitations: 20 single-byte characters SHIPTOPHONENUM (Optional) Phone number.
6 ExpressCheckout API Operations Express Checkout API operations include SetExpressCheckout, GetExpressCheckoutDetails, and DoExpressCheckoutPayment. Callback API Operation Updates the PayPal Review page with shipping options, insurance, and tax information. Callback API Request Message Callback Request Fields Field Description METHOD (Required) Must be Callback. TOKEN (Optional) A timestamped token, the value of which was returned by SetExpressCheckout response.
6 ExpressCheckout API Operations Callback API Operation Field Description LOCALECODE (Optional) Locale of pages displayed by PayPal during Express Checkout. Character length and limitations: Any two-character country code.
ExpressCheckout API Operations Callback API Operation Field Description L_DESCn Item description from the Express Checkout API. These parameters must be ordered sequentially beginning with 0 (for example, L_DESC0, L_DESC1). L_AMTn Item unit price from the Express Checkout API. These parameters must be ordered sequentially beginning with 0 (for example, L_AMT0, L_AMT1). L_QTYn Item unit quantity from the Express Checkout API.
6 ExpressCheckout API Operations Callback API Operation Callback Response Message Callback Response Fields Field Description METHOD (Required) The method sent to the PayPal server. The value is always CallbackResponse. CURRENCYCODE (Required) The three-character currency code for the transaction from the Express Checkout API. OFFERINSURANCEOPTIO N (Optional) Indicates whether or not PayPal should display insurance in a drop-down list on the Review page.
ExpressCheckout API Operations SetExpressCheckout API Operation Field Description L_INSURANCEAMOUNTn (Optional) New insurance amount based on this shipping option and the shipping address. N O TE : 6 Character length and limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Equivalent to nine characters maximum for USD.
6 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description MAXAMT (Optional) The expected maximum total amount of the complete order, including shipping cost and tax charges. If the transaction includes one or more one-time purchases, this field is ignored. For recurring payments, you should pass the expected average transaction amount (default 25.00). PayPal uses this value to validate the buyer’s funding source.
ExpressCheckout API Operations SetExpressCheckout API Operation Field Description NOSHIPPING Determines where or not PayPal displays shipping address fields on the PayPal pages. For digital goods, this field is required, and you must set it to 1. It is one of the following values: 0 – PayPal displays the shipping address on the PayPal pages. 1 – PayPal does not display shipping address fields whatsoever.
6 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description LOCALECODE (Optional) Locale of pages displayed by PayPal during Express Checkout.
ExpressCheckout API Operations SetExpressCheckout API Operation Field Description HDRIMG (Optional) URL for the image you want to appear at the top left of the payment page. The image has a maximum size of 750 pixels wide by 90 pixels high. PayPal recommends that you provide an image that is stored on a secure (https) server. If you do not specify an image, the business name displays.
6 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description LANDINGPAGE (Optional) Type of PayPal page to display. It is one of the following values: Billing – Non-PayPal account Login – PayPal account login CHANNELTYPE (Optional) Type of channel. It is one of the following values: Merchant – Non-auction seller eBayItem – eBay auction GIROPAYSUCCESSURL (Optional) The URL on the merchant site to redirect to after a successful giropay payment.
ExpressCheckout API Operations SetExpressCheckout API Operation Field Description GIFTWRAPAMOUNT (Optional) Amount to be charged to the buyer for gift wrapping.. Character length and limitations: Value is a positive number which cannot exceed $10,000 USD in any currency. It includes no currency symbol. It must have 2 decimal places, the decimal separator must be a period (.), and the optional thousands separator must be a comma (,).
6 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description PAYMENTREQUEST_0_SHIPTOCIT Name of city. It is required if using a shipping address. Y Character length and limitations: 40 single-byte characters SHIPTOCITY (deprecated) SHIPTOCITY is deprecated since version 63.0. Use PAYMENTREQUEST_0_SHIPTOCITY instead. PAYMENTREQUEST_0_SHIPTOSTA State or province. It is required if using a shipping address.
ExpressCheckout API Operations SetExpressCheckout API Operation Field Description PAYMENTREQUEST_n_AMT AMT (deprecated) (Required) Total cost of the transaction to the buyer. If shipping cost and tax charges are known, include them in this value. If not, this value should be the current sub-total of the order. If the transaction includes one or more one-time purchases, this field must be equal to the sum of the purchases.
6 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description PAYMENTREQUEST_n_SHI PPINGAMT SHIPPINGAMT (deprecated) (Optional) Total shipping costs for this order. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. NOTE: If you specify a value for PAYMENTREQUEST_n_SHIPPINGAMT, you must also specify a value for PAYMENTREQUEST_n_ITEMAMT. Character length and limitations: Value is a positive number which cannot exceed $10,000 USD in any currency.
ExpressCheckout API Operations SetExpressCheckout API Operation Field Description PAYMENTREQUEST_n_HAN DLINGAMT HANDLINGAMT (deprecated) (Optional) Total handling costs for this order. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. NOTE: 6 If you specify a value for PAYMENTREQUEST_n_HANDLINGAMT, you must also specify a value for PAYMENTREQUEST_n_ITEMAMT. Character length and limitations: Value is a positive number which cannot exceed $10,000 USD in any currency.
6 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description PAYMENTREQUEST_n_INV NUM INVNUM (deprecated) (Optional) Your own invoice or tracking number.You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive; except for digital goods, which supports single payments only. NOTE: The value you specify is available only if the transaction includes a purchase.
ExpressCheckout API Operations SetExpressCheckout API Operation Field Description PAYMENTREQUEST_n_PAY MENTACTION PAYMENTACTION (deprecated) How you want to obtain payment. When implementing parallel payments, this field is required and must be set to Order. When implementing digital goods, this field is required and must be set to Sale. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive; except for digital goods, which supports single payments only.
6 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description L_PAYMENTREQUEST_n_DE SCm L_DESCn (deprecated) (Optional) Item description. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment; except for digital goods, which supports single payments only. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_DESC0, L_PAYMENTREQUEST_n_DESC1).
ExpressCheckout API Operations SetExpressCheckout API Operation Field Description L_PAYMENTREQUEST_n_TA XAMTm L_TAXAMTn (deprecated) (Optional) Item sales tax. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment; except for digital goods, which only supports single payments. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_TAXAMT0, L_PAYMENTREQUEST_n_TAXAMT1).
6 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description L_PAYMENTREQUEST_n_IT EMHEIGHTVALUEm, L_PAYMENTREQUEST_n_IT EMHEIGHTUNITm L_ITEMHEIGHTVALUEn and L_ITEMHEIGHTUNITn (deprecated) (Optional) Item height corresponds to the height of the item. You can pass this data to the shipping carrier as is without having to make an additional database query.
ExpressCheckout API Operations SetExpressCheckout API Operation 6 Ebay Item Payment Details Item Type Fields Field Description L_PAYMENTREQUEST_n_EB AYITEMNUMBERm L_EBAYITEMNUMBERn (deprecated) (Optional) Auction item number. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_EBAYITEMNUMBER0, L_PAYMENTREQUEST_n_EBAYITEMNUMBER1).
6 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description BUYERUSERNAME xs:string (Optional) The user name of the user at the marketplaces site. BUYERREGISTRATIONDA TE xs:dateTime (Optional) Date when the user registered with the marketplace.
ExpressCheckout API Operations SetExpressCheckout API Operation 6 Billing Agreement Details Type Fields Field Description L_BILLINGTYPEn (Required) Type of billing agreement. For recurring payments, this field must be set to RecurringPayments. In this case, you can specify up to ten billing agreements. Other defined values are not valid. Type of billing agreement for reference transactions. You must have permission from PayPal to use this field.
6 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Tax Id Details Type Fields Field Description TAXIDTYPE Buyer’s tax ID type. This field is required for Brazil and used for Brazil only. For Brazil use only: The tax ID type is BR_CPF for individuals and BR_CNPJ for businesses. This field is introduced in API version 72.0. TAXID Buyer’s tax ID. This field is required for Brazil and used for Brazil only.
ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description TOKEN (Required) A timestamped token, the value of which was returned by SetExpressCheckout response. Character length and limitations: 20 single-byte characters 6 GetExpressCheckoutDetails Response Message GetExpressCheckoutDetails Response Fields Field Description TOKEN The timestamped token value that was returned by SetExpressCheckout response and passed on GetExpressCheckoutDetails request.
6 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description CHECKOUTSTATUS ebl:CheckoutStatusType Status of the checkout session. If payment is completed, the transaction identification number of the resulting transaction is returned. It is one of the following values: PaymentActionNotInitiated PaymentActionFailed PaymentActionInProgress PaymentActionCompleted GIFTMESSAGE Gift message entered by the buyer on the PayPal checkout pages.
ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description COUNTRYCODE Buyer’s country of residence in the form of ISO standard 3166 two-character country codes. Character length and limitations: 2 single-byte characters BUSINESS Buyer’s business name. Character length and limitations: 127 single-byte characters 6 Payer Name Fields Field Description FIRSTNAME Buyer's first name.
6 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description PAYMENTREQUEST_n_SHIPTOCIT Name of city. You can specify up to 10 payments, where n is a digit between Y 0 and 9, inclusive. SHIPTOCITY (deprecated) Character length and limitations: 40 single-byte characters SHIPTOCITY is deprecated since version 63.0. Use PAYMENTREQUEST_0_SHIPTOCITY instead. PAYMENTREQUEST_n_SHIPTOSTA State or province.
ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description PAYMENTREQUEST_n_AMT AMT (deprecated) The total cost of the transaction to the buyer. If shipping cost (not applicable to digital goods) and tax charges are known, include them in this value. If not, this value should be the current sub-total of the order. If the transaction includes one or more one-time purchases, this field must be equal to the sum of the purchases.
6 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description PAYMENTREQUEST_n_SHIPP INGAMT SHIPPINGAMT (deprecated) (Optional) Total shipping costs for this order. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. NOTE: If you specify a value for PAYMENTREQUEST_n_SHIPPINGAMT, you must also specify a value for PAYMENTREQUEST_n_ITEMAMT.
ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description PAYMENTREQUEST_n_HANDL INGAMT HANDLINGAMT (deprecated) (Optional) Total handling costs for this order. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. NOTE: 6 If you specify a value for PAYMENTREQUEST_n_HANDLINGAMT, you must also specify a value for PAYMENTREQUEST_n_ITEMAMT.
6 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description PAYMENTREQUEST_n_INVNU M INVNUM (deprecated) (Optional) Your own invoice or tracking number.You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive; except for digital goods, which supports single payments only. NOTE: The value you specify is available only if the transaction includes a purchase.
ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description PAYMENTREQUEST_n_PAYME NTREQUESTID PAYMENTREQUESTID (deprecated) A unique identifier of the specific payment request. Required when implementing parallel payments. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. Character length and limitations: Up to 127 single-byte characters PAYMENTREQUESTID is deprecated since version 63.0. Use PAYMENTREQUEST_0_PAYMENTREQUESTID instead.
6 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description L_PAYMENTREQUEST_n_NUMB ERm L_NUMBERn (deprecated) Item number. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_NUMBER0, L_PAYMENTREQUEST_n_NUMBER1).
ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description L_PAYMENTREQUEST_n_ITEM WIDTHVALUEm, L_PAYMENTREQUEST_n_ITEM WIDTHUNITm L_ITEMWIDTHVALUEn and L_ITEMWIDTHUNITn (deprecated) Width of the item. You can pass this data to the shipping carrier as is without having to make an additional database query. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment.
6 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description L_PAYMENTREQUEST_n_EB AYITEMAUCTIONTXNIDm EBAYITEMAUCTIONTXNIDn (deprecated) Auction transaction identification number. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment. Character length: 255 single-byte characters EBAYITEMAUCTIONTXNIDn is deprecated since 63.0. Use L_PAYMENTREQUEST_0_EBAYAUCTIONTXNIDm instead.
ExpressCheckout API Operations GetExpressCheckoutDetails API Operation 6 Seller Details Type Fields Field Description PAYMENTREQUEST_n_SELLER PAYPALACCOUNTID Unique identifier for the merchant. For parallel payments, this field contains either the Payer Id or the email address of the merchant. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Tax Id Details Type Fields Field Description TAXIDTYPE Buyer’s tax ID type. This field is required for Brazil and used for Brazil only. For Brazil use only: The tax ID type is BR_CPF for individuals and BR_CNPJ for businesses. This field is introduced in API version 72.0. TAXID Buyer’s tax ID. This field is required for Brazil and used for Brazil only.
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PAYMENTACTION (deprecated) (Required) How you want to obtain payment. It is one of the following values: Authorization – This payment is a basic authorization subject to settlement with PayPal Authorization and Capture. Order – This payment is an order authorization subject to settlement with PayPal Authorization and Capture. Sale – This is a final sale for which you are requesting payment.
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description BUTTONSOURCE (Optional) Identification code for use by third-party applications to identify transactions. Character length and limitations: 32 single-byte alphanumeric characters Payment Details Type Fields When implementing parallel payments, you can create up to 10 sets of payment details type parameter fields, each representing one payment you are hosting on your marketplace.
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PAYMENTREQUEST_n_ITEMAMT ITEMAMT (deprecated) Sum of cost of all items in this order. For digital goods, this field is required. PayPal recommends that you pass the same value in the call to DoExpressCheckoutPayment that you passed in the call to SetExpressCheckout. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive; except for digital goods, which supports single payments only.
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PAYMENTREQUEST_n_INSURAN CEOPTIONOFFERED INSURANCEOPTIONOFFERED (deprecated) (Optional) Indicates whether insurance is available as an option the buyer can choose on the PayPal Review page. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. Is one of the following values: true – The Insurance option displays the string ‘Yes’ and the insurance amount.
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PAYMENTREQUEST_n_CUSTOM CUSTOM (deprecated) (Optional) A free-form field for your own use. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. N O TE : 6 The value you specify is available only if the transaction includes a purchase. This field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged.
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PAYMENTREQUEST_n_TRANSAC TIONID TRANSACTIONID (deprecated) (Optional) Transaction identification number of the transaction that was created.You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. N O TE : This field is only returned after a successful transaction for DoExpressCheckout has occurred. TRANSACTIONID is deprecated since version 63.0.
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation 6 Address Fields Field Description PAYMENTREQUEST_0_SHIPTONAM Person’s name associated with this shipping address. It is required if using a E shipping address. SHIPTONAME (deprecated) Character length and limitations: 32 single-byte characters SHIPTONAME is deprecated since version 63.0. Use PAYMENTREQUEST_0_SHIPTONAME instead. PAYMENTREQUEST_0_SHIPTOSTR First street address. It is required if using a shipping address.
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Payment Details Item Type Fields Field Description L_PAYMENTREQUEST_n_NA MEm L_NAMEn (deprecated) Item name. This field is required when L_PAYMENTREQUEST_n_ITEMCATEGORYm is passed. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment; except for digital goods, which supports single payments only.
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description L_PAYMENTREQUEST_n_QT Ym L_QTYn (deprecated) Item quantity. This field is required when L_PAYMENTREQUEST_n_ITEMCATEGORYm is passed. For digital goods (L_PAYMENTREQUEST_n_ITEMCATEGORYm=Digital), this field is required. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment; except for digital goods, which only supports single payments.
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description L_PAYMENTREQUEST_n_IT EMWIDTHVALUEm, L_PAYMENTREQUEST_n_IT EMWIDTHUNITm L_ITEMWIDTHVALUEn and L_ITEMWIDTHUNITn (deprecated) (Optional) Item width corresponds to the width of the item. You can pass this data to the shipping carrier as is without having to make an additional database query.
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation 6 EbayItemPaymentDetailsItemType Fields Field Description L_PAYMENTREQUEST_n_EB AYITEMNUMBERm L_EBAYITEMNUMBERn (deprecated) (Optional) Auction item number. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_EBAYITEMNUMBER0, L_PAYMENTREQUEST_n_EBAYITEMNUMBER1).
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description SHIPPINGOPTIONISDEFA ULT (Optional) Whether the buyer chose the default shipping option. It is one of the following values: true – The buyer chose the default shipping option. false – The buyer did not choose the default shipping option. SHIPPINGOPTIONAMOUNT (Optional) The shipping amount that the buyer chose.
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation 6 DoExpressCheckoutPayment Response Message DoExpressCheckoutPayment Response Fields Field Description TOKEN The timestamped token value that was returned by SetExpressCheckout response and passed on GetExpressCheckoutDetails request. Character length and limitations: 20 single-byte characters PAYMENTTYPE Information about the payment.
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description L_FMFfilterIDn (deprecated) Filter ID, including the filter type, (PENDING, REPORT, or DENY), the filter ID, and the entry number, n, starting from 0.
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PAYMENTINFO_n_SELLE RREGISTRATIONDATE Date when the merchant registered with the marketplace. You can specify up to 10 payments, where ‘n’ is a digit between 0 and 9, inclusive. Character length and limitations: Date and time are in UTC/GMT format. For example: 2011-06-24T05:38:?48Z. PAYMENTINFO_n_PAREN TTRANSACTIONID PARENTTRANSACTIONID (deprecated) Parent or related transaction identification number.
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Payment Information Fields When implementing parallel payments, up to 10 payment information type sets of payment information type parameter fields can be returned, each representing one payment you are hosting on your marketplace. Field Description PAYMENTINFO_n_TRANS ACTIONID TRANSACTIONID (deprecated) Unique transaction ID of the payment. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PAYMENTINFO_n_CURRE NCYCODE CURRENCYCODE (deprecated) A 3-character currency code. Default: USD. CURRENCYCODE is deprecated since version 63.0. Use PAYMENTINFO_0_CURRENCYCODE instead. PAYMENTINFO_n_FEEAM T FEEAMT (deprecated) PayPal fee amount charged for the transaction. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PAYMENTINFO_n_PAYME NTSTATUS PAYMENTSTATUS (deprecated) The status of the payment. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. It is one of the following values: None – No status. Canceled-Reversal – A reversal has been canceled; for example, when you win a dispute and the funds for the reversal have been returned to you.
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PAYMENTINFO_n_PENDI NGREASON PENDINGREASON (deprecated) Reason the payment is pending. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. It is one of the following values: none – No pending reason.
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PAYMENTINFO_n_REASO NCODE REASONCODE (deprecated) Reason for a reversal if TransactionType is reversal. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. It is one of the following values: none – No reason code. chargeback – A reversal has occurred on this transaction due to a chargeback by your buyer.
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description STOREID StoreId as entered in the transaction TERMINALID TerminalId as entered in the transaction PAYMENTINFO_n_EBAYI TEMAUCTIONTXNID EBAYITEMAUCTIONTXNI D (deprecated) eBay transaction identification number. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. Character length and limitations: 255 single-byte characters EBAYITEMAUCTIONTXNID is deprecated since version 63.0.
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Payment Error Type Fields Field Description PAYMENTINFO_n_SHORT MESSAGE xs:string Payment error short message. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. PAYMENTINFO_n_LONGM ESSAGE xs:string Payment error long message. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. PAYMENTINFO_n_ERROR CODE xs:string Payment error code.
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation 6 Seller Details Type Fields Field Description PAYMENTINFO_n_SELLERPAY PALACCOUNTID Unique identifier for the merchant. For parallel payments, this field contains either the Payer Id or the email address of the merchant. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.
6 116 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation February 01, 2013 Name-Value Pair API Developer Guide
7 GetBalance API Operation The GetBalance API Operation obtains the available balance for a PayPal account. GetBalance Request Message GetBalance Request Fields Field Description METHOD (Required) Must be GetBalance. RETURNALLCURRENCIES (Optional) Indicates whether to return all currencies. It is one of the following values: 0 – Return only the balance for the primary currency holding. 1 – Return the balance for each currency holding. NOTE: This field is availalble since version 51.
7 118 GetBalance API Operation GetBalance Response Message February 01, 2013 Name-Value Pair API Developer Guide
8 GetPalDetails API Operation The GetPalDetails API operation obtains your Pal ID, which is the PayPal-assigned merchant account number, and other information about your account. You need the account number when working with dynamic versions of PayPal buttons and logos. GetPalDetails Request Message GetPalDetails Request Fields Field Description METHOD (Required) Must be GetPalDetails.
8 GetPalDetails API Operation GetPalDetails Response Message Field Description LOCALE Country code representing the merchant's default locale.
9 GetTransactionDetails API Operation The GetTransactionDetails API operation obtains information about a specific transaction. GetTransactionDetails Request Message GetTransactionDetails Request Fields Field Description METHOD Must be GetTransactionDetails. TRANSACTIONID (Required) Unique identifier of a transaction. NOTE: The details for some kinds of transactions cannot be retrieved with GetTransactionDetails. You cannot obtain details of bank transfer withdrawals, for example.
9 GetTransactionDetails API Operation GetTransactionDetails Response Message GetTransactionDetails Response Fields Field Description SHIPPINGCALCULATION MODE Describes how the options that were presented to the buyer were determined. It is one of the following values: Callback – Shipping option rates are based on the buyer’s location. FlatRate – Shipping options are flat rates. INSURANCEOPTIONSELE CTED Whether the buyer selected the insurance option.
GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description BUYERMARKETINGEMAIL The email address the buyer entered on the PayPal pages to be notified of promotions or special events. Limitations: 127 single-byte characters SURVEYQUESTION Text for the survey question on the PayPal pages. If the survey question is present, at least 2 survey answer options need to be present.
9 GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description PAYERBUSINESS Buyer’s business name. Character length and limitations: 127 single-byte characters Payer Name Fields Field Description SALUTATION Buyer's salutation. Character length and limitations: 20 single-byte characters FIRSTNAME Buyer's first name. Character length and limitations: 25 single-byte characters MIDDLENAME Buyer's middle name.
GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description SHIPTOSTREET2 Second street address. Character length and limitations: 100 single-byte characters SHIPTOSECONDARYADDR ESSLINE2 Second line of street address for secondary address. Character length and limitations: 100single-byte characters SHIPTOCITY Name of city. Character length and limitations: 40 single-byte characters SHIPTOSECONDARYCITY Name of city for secondary address.
9 GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description PARENTTRANSACTIONID Parent or related transaction identification number. This value in this field is for the following transaction types: Reversal – Capture of an authorized transaction. Reversal – Reauthorization of a transaction. Capture of an order – The value of ParentTransactionID is the original OrderID. Authorization of an order – The value of ParentTransactionID is the original OrderID.
GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description SETTLEAMT Amount deposited in your PayPal account after a currency conversion. Character length and limitations: Value is a positive number which cannot exceed $10,000 USD in any currency. It includes no currency symbol. It must have 2 decimal places, the decimal separator must be a period (.), and the optional thousands separator must be a comma (,). TAXAMT Tax charged on the transaction.
9 GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description PENDINGREASON The reason the payment is pending. It is one of the following values: none – No pending reason. address – The payment is pending because your buyer did not include a confirmed shipping address and your Payment Receiving Preferences is set such that you want to manually accept or deny each of these payments. To change your preference, go to the Preferences section of your Profile.
GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description PROTECTIONELIGIBILI TY Prior to version 64.4, the kind of seller protection in force for the transaction. It is one of the following values: Eligible – Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received. PartiallyEligible – Merchant is protected by PayPal's Seller Protection Policy for Item Not Received.
9 GetTransactionDetails API Operation GetTransactionDetails Response Message Payment Item Fields Field Description L_EBAYITEMTXNIDn (Optional) The eBay auction transaction ID of the item that you use to identify items that the buyer purchased. Character length and limitations: 255 single-byte characters These parameters must be ordered sequentially beginning with 0 (for example L_EBAYITEMTXNID0, L_EBAYITEMTXNID1). L_NAMEn Item name set by you or entered by the customer.
GetTransactionDetails API Operation GetTransactionDetails Response Message 9 Auction Information Fields Field Description BUYERID Buyer's auction ID. CLOSINGDATE Auction's close date. MULTIITEM Counter used for multi-item auction payments. Subscription Terms Fields Field Description AMOUNT Amount subscriber is to be charged in 1 payment. Character length and limitations: No limit PERIOD Period of time that the subscriber is charged.
9 132 GetTransactionDetails API Operation GetTransactionDetails Response Message February 01, 2013 Name-Value Pair API Developer Guide
10 ManagePendingTransactionStatu s API Operation The ManagePendingTransactionStatus API operation accepts or denys a pending transaction held by Fraud Management Filters. ManagePendingTransactionStatus Request Message ManagePendingTransactionStatus Request Fields Field Description METHOD (Required) Must be ManagePendingTransactionStatus. TRANSACTIONID (Required) The transaction ID of the payment transaction. ACTION (Required) The operation you want to perform on the transaction.
10 134 ManagePendingTransactionStatus API Operation ManagePendingTransactionStatus Response Message Field Description STATUS Displays in the following message: “The Status of the transaction after running your action (accept/deny) is TransactionStatus.
11 MassPay API Operation The MassPay API operation makes a payment to one or more PayPal account holders. MassPay Request Message MassPay Request Fields Field Description METHOD (Required) Must be MassPay. EMAILSUBJECT (Optional) The subject line of the email that PayPal sends when the transaction completes. The subject line is the same for all recipients. Character length and limitations: 255 single-byte alphanumeric characters CURRENCYCODE Currency code.
11 136 MassPay API Operation MassPay Response Message February 01, 2013 Name-Value Pair API Developer Guide
12 Recurring Payments and Reference Transactions API Operations The PayPal API includes the following API operations supporting recurring payments and reference transactions: CreateRecurringPaymentsProfile API Operation The CreateRecurringPaymentsProfile API operation creates a recurring payments profile. You must invoke the CreateRecurringPaymentsProfile API operation for each profile you want to create. The API operation creates a profile and an associated billing agreement.
12 Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation Field Description TOKEN A timestamped token, the value of which was returned in the response to the first call to SetExpressCheckout. You can also use the token returned in the SetCustomerBillingAgreement response. Either this token or a credit card number is required.
Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation 12 Billing Period Details Fields Field Description BILLINGPERIOD (Required) Unit for billing during this subscription period. It is one of the following values: Day Week SemiMonth Month Year For SemiMonth, billing is done on the 1st and 15th of each month. NOTE: BILLINGFREQUENCY The combination of BillingPeriod and BillingFrequency cannot exceed one year.
12 Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation Field Description TRIALBILLINGFREQUEN CY Number of billing periods that make up one billing cycle; required if you specify an optional trial period. The combination of billing frequency and billing period must be less than or equal to one year. For example, if the billing cycle is Month, the maximum value for billing frequency is 12.
Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation 12 Actvation Details Fields Field Description INITAMT (Optional) Initial non-recurring payment amount due immediately upon profile creation. Use an initial amount for enrolment or set-up fees. NOTE: All amounts included in the request must have the same currency. Character length and limitations: Value is a positive number which cannot exceed $10,000 USD in any currency.
12 Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation Field Description SHIPTOZIP 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 SHIPTOCOUNTRY Country code. It is required if using a shipping address.
Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation 12 Payer Information Fields Field Description EMAIL (Required) Email address of buyer. Character length and limitations: 127 single-byte characters PAYERID (Optional) Unique PayPal Customer Account identification number. Character length and limitations:13 single-byte alphanumeric characters PAYERSTATUS (Optional) Status of buyer.
12 Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation Field Description CITY (Required) Name of city. Character length and limitations: 40 single-byte characters STATE (Required) State or province. Character length and limitations: 40 single-byte characters COUNTRYCODE (Required) Country code. Character length and limitationst: 2 single-byte characters ZIP (Required) U.S. ZIP code or other country-specific postal code.
Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation Field Description L_PAYMENTREQUEST_n_AM Tm Cost of item. This field is required when ItemCategory is passed. Cost of item. This field is required when L_PAYMENTREQUEST_n_ITEMCATEGORYm is passed. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_AMT0, L_PAYMENTREQUEST_n_AMT1).
12 Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation Field Description PROFILESTATUS Status of the recurring payment profile. ActiveProfile – The recurring payment profile has been successfully created and activated for scheduled payments according the billing instructions from the recurring payments profile. PendingProfile – The system is in the process of creating the recurring payment profile.
Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation Field Description STATUS Status of the recurring payment profile. It is one of the following values: Active Pending Cancelled Suspended Expired DESC Description of the recurring payment.
12 Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation Field Description PROFILEREFERENCE The merchant’s own unique reference or invoice number. Character length and limitations: 127 single-byte alphanumeric characters. Ship To AddressType Fields Field Description ADDRESSSTATUS Status of street address on file with PayPal.
Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation Field Description REGULARBILLINGPERIO D Unit for billing during this regular subscription period. It is one of the following values: Day Week SemiMonth Month Year 12 For SemiMonth, billing is done on the 1st and 15th of each month. NOTE: The combination of RegularBillingPeriod and RegularBillingFrequency cannot exceed one year. This field is available since version 53.0.
12 Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation Field Description AMT Billing amount for each billing cycle during this payment period. This amount does not include shipping and tax amounts. NOTE: All amounts in the CreateRecurringPaymentsProfile request must have the same currency. Character length and limitations: Value is a positive number which cannot exceed $10,000 USD in any currency. It includes no currency symbol.
Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation Field Description REGULARTAXAMT Tax amount for each billing cycle during this regular payment period. NOTE: 12 All amounts in the request must have the same currency. Character length and limitations: Value is a positive number which cannot exceed $10,000 USD in any currency. It includes no currency symbol. It must have 2 decimal places, the decimal separator must be a period (.
12 Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation Credit Card Details Fields Field Description CREDITCARDTYPE Type of credit card. Is one of the following values: Visa MasterCard Discover Amex Maestro – See note. NOTE: If the credit card type is Maestro, you must set the currencyId to GBP. In addition, you must specify either StartMonth and StartYear or IssueNumber.
Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation 12 Address Fields Field Description ADDRESSOWNER eBay company that maintains this address. It is one of the following values: eBay PayPal ADDRESSSTATUS Status of street address on file with PayPal. It is one of the following values: none Confirmed Unconfirmed SHIPTOSECONDARYNAME Person’s name associated with this secondary address.
12 Recurring Payments and Reference Transactions API Operations ManageRecurringPaymentsProfileStatus API Operation Field Description SHIPTOPHONENUM Phone number. Character length and limitations: 20 single-byte characters SHIPTOSECONDARYPHON ENUM Phone number for secondary addresss.
Recurring Payments and Reference Transactions API Operations BillOutstandingAmount API Operation 12 ManageRecurringPaymentsProfileStatus Response Message ManageRecurringPaymentsProfileStatus Response Fields Field Description PROFILEID Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response. For each action, an error is returned if the recurring payments profile has a status that is not compatible with the action.
12 Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation Field Description NOTE (Optional) The reason for the non-scheduled payment. For profiles created using Express Checkout, this message is included in the email notification to the buyer for the non-scheduled payment transaction, and can also be seen by both you and the buyer on the Status History page of the PayPal account.
Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation Field Description DESC (Optional) Description of the recurring payment. Character length and limitations: 127 single-byte alphanumeric characters SUBSCRIBERNAME (Optional) Full name of the person receiving the product or service paid for by the recurring payment. If not present, the name in the buyer’s PayPal account is used.
12 Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation Field Description AUTOBILLOUTAMT (Optional) This field indicates whether you would like PayPal to automatically bill the outstanding balance amount in the next billing cycle. It is one of the following values: NoAutoBill – PayPal does not automatically bill the outstanding balance.
Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation 12 Billing Period Details Fields Field Description TOTALBILLINGCYCLES (Optional) Number of billing cycles for payment period. For the regular payment period, if no value is specified or the value is 0, the regular payment period continues until the profile is canceled or deactivated.
12 Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation Credit Card Details Fields NOTE: Credit card information cannot be updated for profiles created through Express Checkout, since the payment is tied to the PayPal account and not a credit card. Field Description CREDITCARDTYPE (Optional) Type of credit card. For UK, only Maestro, MasterCard, Discover, and Visa are allowable.
Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation Field Description FIRSTNAME (Conditional) Buyer’s first name is required except when the reference transaction is run against a billing agreement. In the case of a billing agreement, the first name field should not be used.
12 Recurring Payments and Reference Transactions API Operations CreateBillingAgreement API Operation CreateBillingAgreement API Operation The CreateBillingAgreement API operation creates a billing agreement with a PayPal account holder. CreateBillingAgreement is only valid for reference transactions. CreateBillingAgreement Request Message CreateBillingAgreement Request Fields Field Description METHOD (Required) Must be CreateBillingAgreement.
Recurring Payments and Reference Transactions API Operations SetCustomerBillingAgreement API Operation 12 SetCustomerBillingAgreement Request Message SetCustomerBillingAgreement Request Fields Field Description METHOD (Required) Must be SetCustomerBillingAgreement. RETURNURL (Required) URL to which the buyer’s browser is returned after choosing to pay with PayPal. NOTE: PayPal recommends that the value be the final review page on which the buyer confirms the billing agreement.
12 Recurring Payments and Reference Transactions API Operations SetCustomerBillingAgreement API Operation Field Description LOCALECODE (Optional) Locale of pages displayed by PayPal during checkout.
Recurring Payments and Reference Transactions API Operations SetCustomerBillingAgreement API Operation Field Description HDRIMG (Optional) A URL for the image you want to appear at the top left of the payment page. The image has a maximum size of 750 pixels wide by 90 pixels high. PayPal recommends that you provide an image that is stored on a secure (https) server.
12 Recurring Payments and Reference Transactions API Operations SetCustomerBillingAgreement API Operation Field Description BILLINGTYPE Type of billing agreement for reference transactions. You must have permission from PayPal to use this field. For reference transactions, this field must be set to one of the following values: MerchantInitiatedBilling - PayPal creates a billing agreement for each transaction associated with buyer. You must specify version 54.0 or higher to use this option.
Recurring Payments and Reference Transactions API Operations GetBillingAgreementCustomerDetails API Operation 12 GetBillingAgreementCustomerDetails API Operation The GetBillingAgreementCustomerDetails API operation obtains information about a billing agreement's PayPal account holder. GetBillingAgreementCustomerDetails Request Message GetBillingAgreementCustomerDetails Request Fields Field Description METHOD (Required) Must be GetBillingAgreementCustomerDetails.
12 Recurring Payments and Reference Transactions API Operations GetBillingAgreementCustomerDetails API Operation PayerNameType Fields Field Description SALUTATION Buyer's salutation. Character length and limitations: 20 single-byte characters FIRSTNAME Buyer's first name. Character length and limitations: 25 single-byte characters MIDDLENAME Buyer's middle name. Character length and limitations: 25 single-byte characters LASTNAME Buyer's last name.
Recurring Payments and Reference Transactions API Operations BAUpdate API Operation 12 BAUpdate API Operation The BAUpdate API operation updates or deletes a billing agreement. BAUpdate Request Message BAUpdate Request Fields Field Description METHOD (Required) Must be BillAgreementUpdate. REFERENCEID (Required) An ID, such as a billing agreement ID or a reference transaction ID that is associated with a billing agreement. BILLINGAGREEMENTSTA TUS (Optional) Use to cancel a billing agreement.
12 Recurring Payments and Reference Transactions API Operations BAUpdate API Operation Field Description L_BILLINGAGREEMENTC USTOMn Custom annotation field for your own use. Character length and limitations: 256 single-byte alphanumeric characters BILLINGAGREEMENTSTA TUS (Optional) Use to cancel a billing agreement. To cancel a billing agreement, pass the value Canceled. N O TE : L_BILLINGAGREEMENTM AXn If you do not pass the value Canceled, BAUpdate returns the buyer’s latest billing address.
Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description MIDDLENAME Buyer's middle name. Character length and limitations: 25 single-byte characters LASTNAME Buyer's last name. Character length and limitations: 25 single-byte characters SUFFIX Buyer's suffix. Character length and limitations: 12 single-byte characters 12 Bill To Address Fields Field Description BILLINGNAME Billing name associated with this billing address.
12 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation DoReferenceTransaction Request Message DoReferenceTransaction Request Fields Field Description METHOD (Required) Must be DoReferenceTransaction. REFERENCEID (Required) A transaction ID from a previous purchase, such as a credit card charge using the DoDirectPayment API, or a billing agreement ID. PAYMENTACTION (Optional) How you want to obtain payment.
Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description SOFTDESCRIPTOR (Optional) Per transaction description of the payment that is passed to the consumer’s credit card statement.
12 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description SHIPTOSTREET First street address. It is required if using a shipping address. Character length and limitations: 100 single-byte characters SHIPTOSTREET2 (Optional) Second street address. Character length and limitations: 100 single-byte characters SHIPTOCITY Name of city. It is required if using a shipping address.
Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description SHIPPINGAMT (Optional) Total shipping costs for this order. NOTE: 12 If you specify a value for SHIPPINGAMT, you must also specify a value for ITEMAMT. Character length and limitations: Value is a positive number which cannot exceed $10,000 USD in any currency. It includes no currency symbol. It must have 2 decimal places, the decimal separator must be a period (.
12 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description NOTIFYURL (Optional) Your URL for receiving Instant Payment Notification (IPN) about this transaction. If you do not specify this value in the request, the notification URL from your Merchant Profile is used, if one exists. I MP O R T ANT : The notify URL applies only to DoExpressCheckoutPayment. This value is ignored when set in SetExpressCheckout or GetExpressCheckoutDetails.
Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description L_NUMBERn (Optional) Item number. These parameters must be ordered sequentially beginning with 0 (for example L_NUMBER0, L_NUMBER1). Character length and limitations: 127 single-byte characters L_QTYn Item quantity. This field is required when you pass a value for L_PAYMENTREQUEST_n_ITEMCATEGORYm.
12 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Reference Credit Card Details Fields Field Description CREDITCARDTYPE (Optional) Type of credit card. Is one of the following values: Visa MasterCard Discover Amex Maestro: See note. For UK, only Maestro, MasterCard, Discover, and Visa are allowable. For Canada, only MasterCard and Visa are allowable. Interac debit cards are not supported.
Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description LASTNAME (Conditional) Buyer’s last name is required except when the reference transaction is run against a billing agreement. In the case of a billing agreement, the last name field should not be used. Character length and limitations: 25 single-byte characters 12 Address Fields Field Description STREET (Optional) First street address.
12 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description L_FMFfilterIDn Filter ID, including the filter type (PENDING, REPORT, or DENY), the filter ID, and the entry number, n, starting from 0.
Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description PARENTTRANSACTIONID Parent or related transaction identification number. This value in this field is for the following transaction types: Reversal – Capture of an authorized transaction. Reversal – Reauthorization of a transaction. Capture of an order – The value of ParentTransactionID is the original OrderID.
12 182 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description SETTLEAMT Amount deposited in your PayPal account after a currency conversion. Character length and limitations: Value is a positive number which cannot exceed $10,000 USD in any currency. It includes no currency symbol. It must have 2 decimal places, the decimal separator must be a period (.), and the optional thousands separator must be a comma (,).
Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description PENDINGREASON The reason the payment is pending. It is one of the following values: none – No pending reason. address – The payment is pending because your buyer did not include a confirmed shipping address and your Payment Receiving Preferences is set such that you want to manually accept or deny each of these payments.
12 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description PROTECTIONELIGIBILI TY Prior to version 64.4, the kind of seller protection in force for the transaction. It is one of the following values: Eligible – Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received. PartiallyEligible – Merchant is protected by PayPal's Seller Protection Policy for Item Not Received.
13 RefundTransaction API Operation The RefundTransaction API operation issues a refund to the PayPal account holder associated with a transaction. RefundTransaction Request Message RefundTransaction Request Fields Field Description METHOD (Required) Must be RefundTransaction. TRANSACTIONID (Required) Unique identifier of the transaction to be refunded. NOTE: Either the transaction ID or the payer ID must be specified.
13 RefundTransaction API Operation RefundTransaction Request Message Field Description CURRENCYCODE ISO 4217 3-letter currency code. USD for US Dollars. This field is required for partial refunds, and is also required for refunds greater than 100%. Character length and limitations: 3 single-byte characters NOTE (Optional) Custom memo about the refund. Character length and limitations: 255 single-byte alphanumeric characters RETRYUNTIL (Optional) Maximum time until you must retry the refund.
RefundTransaction API Operation RefundTransaction Response Message 13 Merchant Store Details Fields Field Description STOREID Identifier of the merchant store at which the refund is given. This field is required for point-of-sale transactions. Character length and limitations: 50 single-byte characters This field is available since version 82.0. TERMINALID (Optional) ID of the terminal. Character length and limitations: 50 single-byte characters This field is available since version 82.0.
13 RefundTransaction API Operation RefundTransaction Response Message Field Description TOTALREFUNDEDAMT Total amount refunded so far from the original purchase. Say, for example, a buyer makes $100 purchase, the buyer was refunded $20 a week ago and is refunded $30 in this transaction. The gross refund amount is $30 (in this transaction). The total refunded amount is $50. Character length and limitations: Value is a positive number which cannot exceed $10,000 USD in any currency.
14 TransactionSearch API Operation The TransactionSearch API searches transaction history for transactions that meet the specified criteria. NOT E : The maximum number of transactions that can be returned from a TransactionSearch API call is 100. TransactionSearch Request Message TransactionSearch Request Fields Field Description METHOD (Required) Must be TransactionSearch. STARTDATE (Required) The earliest transaction date at which to start the search.
14 TransactionSearch API Operation TransactionSearch Request Message Field Description ACCT (Optional) Search by credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale. NOTE: No wildcards are allowed. Character length and limitations: Must be at least 11 and no more than 25 single-byte numeric characters maximum. Special punctuation, such as dashes or spaces, is ignored.
TransactionSearch API Operation TransactionSearch Response Message Field Description STATUS (Optional) Search by transaction status. It is one of the following values: Pending – The payment is pending. The specific reason the payment is pending is returned by the GetTransactionDetails API PendingReason field. Processing – The payment is being processed. Success – The payment has been completed and the funds have been added successfully to your account balance. Denied – You denied the payment.
14 192 TransactionSearch API Operation TransactionSearch Response Message Field Description L_TIMEZONEn Time zone of the transaction. The value is always GMT. L_TYPEn Type of the transaction. It is one of the following values: Currency Conversion (credit) Currency Conversion (debit) Payment Recurring Payment Temporary Hold Transfer Donation L_EMAILn Email address of either the buyer or the payment recipient (the “payee”).
A API Error Codes The PayPal API can return multiple errors for any operation. General API Errors General API Errors Error Code Short Message Long Message Correcting This Error 10002 Authentication/Authoriza tion Failed Username/Password is incorrect This error can be caused by an incorrect API username, an incorrect API password, or an invalid API signature. Make sure that all three of these values are correct.
A API Error Codes Validation Errors Error Code Short Message Long Message Correcting This Error 10002 Authentication/Authoriza tion Failed Client certificate is disabled 10006 Version error Version is not supported 10008 Security error Security header is not valid 10014 API call was rate limited. The API call has been denied as it has exceeded the permissible call rate limit. 10101 This API Temporarily Unavailable This API is temporarily unavailable. Please try later.
API Error Codes Validation Errors Error Code Short Message Long Message 81112 Missing Parameter NoShipping : Required parameter missing 81113 Missing Parameter AddrOverride : Required parameter missing 81114 Missing Parameter LocaleCode : Required parameter missing 81115 Missing Parameter PaymentAction : Required parameter missing 81116 Missing Parameter Email : Required parameter missing 81117 Missing Parameter Token : Required parameter missing 81118 Missing Parameter PayerID : Req
A 196 API Error Codes Validation Errors Error Code Short Message Long Message 81143 Missing Parameter RefundType : Required parameter missing 81144 Missing Parameter StartDate : Required parameter missing 81145 Missing Parameter EndDate : Required parameter missing 81146 Missing Parameter MPID : Required parameter missing 81147 Missing Parameter CreditCardType : Required parameter missing 81148 Missing Parameter User : Required parameter missing 81149 Missing Parameter Pwd : Requir
API Error Codes DirectPayment API Errors Error Code Short Message Long Message 81229 Invalid Parameter CompleteType : Invalid parameter 81230 Invalid Parameter CurrencyCode : Invalid parameter 81232 Invalid Parameter TransactionEntity : Invalid parameter 81234 Invalid Parameter ExpDate : Invalid parameter 81235 Invalid Parameter FirstName : Invalid parameter 81236 Invalid Parameter LastName : Invalid parameter 81237 Invalid Parameter Street : Invalid parameter 81238 Invalid Paramet
A API Error Codes DirectPayment API Errors Error Code 198 Short Message Long Message Corrective Action 10401 Order total is missing. Transaction refused because of an invalid argument. See additional error messages for details. 10418 The currencies of the shopping Transaction refused cart amounts must be the same. because of an invalid argument. See additional error messages for details. 10426 Item total is invalid. Transaction refused because of an invalid argument.
API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10505 Gateway Decline This transaction cannot be processed. The transaction was refused because the AVS response returned the value of N, and the merchant account is not able to accept such transactions. 10507 Invalid Configuration This transaction cannot be processed. Please contact PayPal Customer Service. Your PayPal account is restricted. Contact PayPal for more information.
A 200 API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10527 Invalid Data This transaction cannot be processed. Please enter a valid credit card number and type. The credit card entered is invalid. 10534 Gateway Decline This transaction cannot be processed. Please enter a valid credit card number and type. The credit card entered is currently restricted by PayPal. Contact PayPal for more information.
API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10546 Gateway Decline This transaction cannot be processed. The transaction was declined by PayPal because of possible fraudulent activity on the IP address. Contact PayPal for more information. 10547 Internal Error This transaction cannot be processed. None. This is a PayPal internal error. 10548 Invalid Configuration This transaction cannot be processed.
A 202 API Error Codes DirectPayment API Errors Error Code Short Message Long Message 10562 Invalid Data This transaction cannot be processed. Please enter a valid credit card expiration year. 10563 Invalid Data This transaction cannot be processed. Please enter a valid credit card expiration month. 10564 Gateway Decline This transaction cannot be processed. 10565 Merchant country unsupported The merchant country is not supported.
API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10706 Invalid Data There’s an error with this transaction. Please enter a valid postal code in the billing address. There was a problem with a particular field in the address. The long error message tells you which field is invalid. 10707 Invalid Data There’s an error with this transaction. Please enter a valid country in the billing address.
A 204 API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10716 Invalid Data There’s an error with this transaction. Please enter your five digit postal code in the billing address. There was a problem with a particular field in the address. The long error message tells you which field is invalid. 10717 Invalid Data There’s an error with this transaction. Please enter a valid postal code in the billing address.
API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10727 Invalid Data There’s an error with this transaction. Please enter an address1 in the shipping address. There was a problem with a particular field in the address. The long error message tells you which field is invalid. 10727 Invalid Data There’s an error with this transaction. Please enter an address1 in the shipping address. There was a problem with a particular field in the address.
A 206 API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10736 Invalid Data There’s an error with this transaction. Please enter a valid city and state in the shipping address. There was a problem with a particular field in the address. The long error message tells you which field is invalid. 10744 Invalid Data This transaction cannot be processed. Please enter a valid country code in the billing address.
API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10756 Gateway Decline The transaction cannot be processed. The country and billing address associated with this credit card do not match. None. This is a PayPal internal error. 10758 Invalid Configuration There’s been an error due to invalid API username and/or password. The API username or password is incorrect for this merchant. 10759 Gateway Decline This transaction cannot be processed.
A API Error Codes DirectPayment API Errors Error Code 208 Short Message Long Message 11612 Could not process your request to accept/deny the transaction Could not process your request to accept/deny the transaction 11821 This transaction cannot be processed This transaction cannot be processed because it has already been denied by a Fraud Management Filter You cannot capture a payment after it has been denied by a Fraud Management Filter.
API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message 15008 Invalid Data This transaction has been completed, but the total of items in the cart did not match the total of all items. 15011 Gateway Decline This credit card was issued from an unsupported country. A Corrective Action SetExpressCheckout API Errors SetExpressCheckout API Errors Error Code Short Message Long Message 10001 ButtonSource value truncated.
A API Error Codes SetExpressCheckout API Errors Error Code 210 Short Message Long Message 10004 Transaction refused because of an invalid argument. See additional error messages for details. Invalid item URL. 10004 Transaction refused because of an invalid argument. See additional error messages for details. OtherPaymentMethodType is invalid. 10004 Transaction refused because of an invalid argument. See additional error messages for details. RegistrationDate of buyer is invalid.
API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message 10004 Transaction refused because of an invalid argument. See additional error messages for details. Invalid eBay seller feedback overall positive count. 10004 Transaction refused because of an invalid argument. See additional error messages for details. Invalid eBay seller feedback overall negative count. 10004 Transaction refused because of an invalid argument. See additional error messages for details.
A API Error Codes SetExpressCheckout API Errors Error Code 212 Short Message Long Message 10004 Transaction refused because of an invalid argument. See additional error messages for details. AllowPushFunding value specified is invalid. It must be 0 or 1 or an empty string. 10005 Option not supported. Merchant not enabled to use enhanced checkout data. 10005 Option not supported. Merchant not enabled to use OtherPaymentMethodDetails. 10005 Option not supported.
API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message 10405 Transaction refused because of an invalid argument. See additional error messages for details. CancelURL is missing. 10407 Transaction refused because of an invalid argument. See additional error messages for details. Invalid buyer email address (BuyerEmail). 10409 You’re not authorized to access this info. Express Checkout token was issued for a merchant account other than yours.
A 214 API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error... 10412 Duplicate invoice Payment has already been made for this InvoiceID. PayPal checks that InvoiceID values are unique for any particular merchant. If you send an InvoiceID value already associated with another transaction in the PayPal system, PayPal returns error code 10412. You might not be able to correct this error during an actual checkout.
API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message 10427 Transaction refused because of an invalid argument. See additional error messages for details Shipping total is invalid. 10428 Transaction refused because of an invalid argument. See additional error messages for details Handling total is invalid. 10429 Transaction refused because of an invalid argument. See additional error messages for details Tax total is invalid.
A API Error Codes SetExpressCheckout API Errors Error Code 216 Short Message Long Message 10438 Transaction refused because of an invalid argument. See additional error messages for details. cpp-header-image value exceeds maximum allowable length. 10439 Transaction refused because of an invalid argument. See additional error messages for details. cpp-header-image value exceeds maximum allowable length. 10440 Transaction refused because of an invalid argument.
API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message 10465 Error occurred in communicating to eBay eBay user invalid 10467 Error occurred in communicating to eBay Duplicate Item ID 10468 Transaction refused because of an invalid argument.
A 218 API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message 10480 Invalid Data Invalid billing agreement type 10485 Payment not authorized Payment has not been authorized by the user. 10537 Risk Control Country Filter Failure The transaction was refused because the country was prohibited as a result of your Country Monitor Risk Control Settings.
API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message 11001 Exceeds maximum length. OtherPaymentMethodLongDescripti on exceeds maximum length. 11001 Exceeds maximum length. OtherPaymentMethodLongDescripti onTitle exceeds maximum length. 11001 Exceeds maximum length. OtherPaymentMethodIcon exceeds maximum length. 11068 Seller restriction. All sellers restricted.
A API Error Codes SetExpressCheckout API Errors Error Code 220 Short Message Long Message 11810 Transaction refused because of an invalid argument. See additional error messages for details Invalid Insurance Amount. 11811 Transaction refused because of an invalid argument. See additional error messages for details Invalid Shipping Discount. 11812 Invalid Data The value of Description parameter has been truncated. 11813 Transaction refused because of an invalid argument.
API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message 11827 Line items missing Line items missing; line items are required when you specify a callback URL for flat-rate shipping options 11828 Maximum amount of order not specified Maximum amount of order not specified; you must specify the estimated value of the order when using a flat-rate shipping option 11829 Shipping total is missing Shipping total is missing; you must specify a shipping total when using a flat-r
A API Error Codes SetExpressCheckout API Errors Error Code 222 Short Message Long Message 12207 Cart ID is required for Immediate Payment item. Cart ID is required for Immediate Payment item. 12208 eBay item amount does not match Express Checkout API item amount. eBay item amount must match Express Checkout API item amount.
API Error Codes GetExpressCheckoutDetails API Errors A GetExpressCheckoutDetails API Errors GetExpressCheckoutDetails API Errors Error Code Short Message Long Message 10001 Internal Error Internal Error 10001 Internal Error Transaction failed due to internal error 10001 ButtonSource value truncated. The transaction could not be loaded 10001 ButtonSource value truncated. The transaction could not be loaded 10003 Missing argument. OtherPaymentMethodID is missing. 10003 Missing argument.
A API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message 10007 Permission denied You do not have permission to make this API call 10014 API call was rate limited. The API call has been denied as it has exceeded the permissible call rate limit. 10408 Express Checkout token is missing. Express Checkout token is missing. 10409 You’re not authorized to access this info. Express Checkout token was issued for a merchant account other than yours.
API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message 10004 Transaction refused because of an invalid argument. See additional error messages for details. Transaction refused because of an invalid argument. See additional error messages for details. 10004 Transaction refused because of an invalid argument. See additional error messages for details. The transaction id is not valid 10004 Transaction refused because of an invalid argument.
A API Error Codes DoExpressCheckoutPayment API Errors Error Code 226 Short Message Long Message 10004 Transaction refused because of an invalid argument. See additional error messages for details. Invalid eBay item transaction date. 10004 Transaction refused because of an invalid argument. See additional error messages for details. Invalid eBay item buyer protection type. 10004 Transaction refused because of an invalid argument. See additional error messages for details.
API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message Correcting This Error... 10412 Duplicate invoice Payment has already been made for this InvoiceID. You may have made a second DoExpressCheckoutPayment API call for the same payment. Or you may have used the same invoice ID for separate transactions, in which case inform the customer and redirect them to restart the Express Checkout flow. 10413 Transaction refused because of an invalid argument.
A API Error Codes DoExpressCheckoutPayment API Errors Error Code 228 Short Message Long Message Correcting This Error... 10421 This Express Checkout session belongs to a different customer. This Express Checkout session belongs to a different customer. Token value mismatch. Verify that your programs are properly associating the Tokens and PayerIDs. 10422 Customer must choose new funding sources. The customer must return to PayPal to select new funding sources.
API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message 10434 Transaction refused because of an invalid argument. See additional error messages for details. Value of Custom element has been truncated. 10435 Transaction refused because of an invalid argument. See additional error messages for details. The customer has not yet confirmed payment for this Express Checkout session. 10441 Transaction refused because of an invalid argument.
A API Error Codes DoExpressCheckoutPayment API Errors Error Code 230 Short Message Long Message 10482 Transaction refused because of an invalid argument. See additional error messages for details. PaymentAction of Order is not allowed with Unilateral and Non-Credentialed authentication. 10486 This transaction couldn't be completed. This transaction couldn't be completed. Please redirect your customer to PayPal.
API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message Correcting This Error... 11084 User does not have a good funding source with which to pay. User does not have a good funding source with which to pay. Inform the customer that PayPal declined the transaction and to contact PayPal Customer Service for more information: https://www.paypal.com/contactus 11607 Duplicate request for specified Message Submission ID.
A API Error Codes DoExpressCheckoutPayment API Errors Error Code 232 Short Message Long Message 12125 PP incentive no longer available. There's a problem with the redemption code(s) you entered and can't be used at this time. Your payment has not been processed. Please go back to PayPal so that the code(s) can be removed, your order total can be updated and then you'll be able to complete checkout. 12126 Payment could not be processed at this time. Incentive temporarily unavailable.
API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message 13101 Invalid Data Payment action of Order is only supported for parallel payments 13102 Payment Request ID is missing Payment Request ID is mandatory for parallel payments 13103 Duplicate Payment Request ID passed Payment Request ID must be unique for parallel payments 13104 Transaction refused because of an invalid argument. See Additional error messages for details.
A API Error Codes Authorization and Capture API Errors Error Code 13751 Short Message Long Message Correcting This Error... Could not retrieve the original successful response. Transaction completed successfully, but could not retrieve the original successful response. Authorization and Capture API Errors Authorization and Capture API Error Messages 234 Error Code Short Message Long Message Returned By API Call...
API Error Codes Authorization and Capture API Errors Error Code Short Message Long Message Returned By API Call... Correcting This Error... 10601 Authorization expired. Authorization has expired. DoAuthorization DoCapture DoReauthorization DoVoid Close the order or authorization. 10602 Authorization completed. Authorization has already been completed. DoAuthorization DoCapture DoReauthorization DoVoid Close the order or authorization. 10603 The buyer is restricted.
A 236 API Error Codes Authorization and Capture API Errors Error Code Short Message Returned By API Call... Correcting This Error... 10611 Not enabled. Authorization & Capture feature is not enabled for the merchant. Contact customer service. DoAuthorization DoCapture DoReauthorization Contact PayPal Customer Service. 10612 No more settlement. Maxmimum number of allowable settlements has been reached. No more settlement for the authorization. DoCapture Close the order.
API Error Codes Authorization and Capture API Errors Error Code Short Message Returned By API Call... Correcting This Error... 10621 Order has expired. Order has expired. DoAuthorization DoCapture DoVoid Close this order. 10622 Order is voided. Order is voided. DoAuthorization DoCapture DoVoid Close this order. 10623 Maximum number of authorization allowed for the order is reached. Maximum number of authorization allowed for the order is reached.
A API Error Codes GetTransactionDetails API Errors Error Code Short Message Returned By API Call... Correcting This Error... 10630 Item amount is invalid. Item amount is invalid. DoAuthorization DoCapture Check the item amount to ensure that it is not zero or negative. 10631 Processor Warning. The authorization is being processed. DoAuthorization 11094 This authorization cannot be voided, reauthorized, or captured against.
API Error Codes TransactionSearch API Errors A TransactionSearch API Errors TransactionSearch API Errors Error Code Short Message Long Message 10001 Internal Error Internal Error 10001 ButtonSource value truncated. The transaction could not be loaded 10003 Transaction refused because of an invalid argument. See additional error messages for details. Start date is a required parameter 10004 Transaction refused because of an invalid argument. See additional error messages for details.
A API Error Codes RefundTransaction API Errors Error Code Short Message Long Message 10004 Transaction refused because of an invalid argument. See additional error messages for details. Receiver email is invalid 10004 Transaction refused because of an invalid argument. See additional error messages for details. You can not search for a transaction id and a receipt id 10004 Transaction refused because of an invalid argument. See additional error messages for details.
API Error Codes RefundTransaction API Errors Error Code Short Message Long Message 10003 Missing argument A transaction id is required 10004 Transaction refused because of an invalid argument. See additional error messages for details. The partial refund amount must be a positive amount 10004 Transaction refused because of an invalid argument. See additional error messages for details.
A 242 API Error Codes RefundTransaction API Errors Error Code Short Message Long Message 10009 Transaction refused The partial refund amount must be less than or equal to the original transaction amount 10009 Transaction refused The partial refund amount must be less than or equal to the remaining amount 10009 Transaction refused The partial refund amount is not valid 10009 The PayerID is invalid. The PayerID is invalid. Make the API call again with a valid PayerID.
API Error Codes RefundTransaction API Errors Error Code Short Message Long Message 10014 API call was rate limited. The API call has been denied as it has exceeded the permissible call rate limit. 10406 Transaction refused because of an invalid argument. See additional error messages for details. The PayerID value is invalid. 10414 Transaction refused because of an invalid argument. See additional error messages for details. The amount exceeds the maximum amount for a single transaction.
A API Error Codes MassPay API Errors Error Code Short Message Long Message 11996 Use Adaptive Payment Refund API To do a refund on an Adaptive Payment transaction, please use the Adaptive Payment Refund API 12302 Dispute Refund Not Allowed This transaction already has a PayPal dispute filed 13122 Transaction refused Transaction violates PayPal Use Agreement 13513 Duplicate request for specified Invoice ID. The specified Invoice ID is a duplicate.
API Error Codes MassPay API Errors Error Code Short Message Long Message 10001 Transaction refused because of an invalid argument. See additional error messages for details. The masspay receiver_type is not a recognizable type 10002 Account locked The user account is locked 10004 Transaction refused because of an invalid argument. See additional error messages for details. The number of input records is greater than maximum allowed 10004 Transaction refused because of an invalid argument.
A API Error Codes MassPay API Errors Error Code 246 Short Message Long Message 10004 Transaction refused because of an invalid argument. See additional error messages for details. The unique id string length exceeds the maximum limit of 30 characters 10004 Transaction refused because of an invalid argument. See additional error messages for details. The unique id string contains a space as a character 10004 Transaction refused because of an invalid argument.
API Error Codes Recurring Payments Errors Error Code Short Message Long Message 10327 Masspay Invalid UserID The masspay input file includes invalid UserID A Recurring Payments Errors The following table lists errors for the following APIs that handle recurring payments profiles: CreateRecurringPaymentsProfile GetRecurringPaymentsProfileDetails ManageRecurringPaymentsProfileStatus UpdateRecurringPaymentsProfile BillOutstandingAmount Recurring Payments Errors Error Code Short Mes
A 248 API Error Codes Recurring Payments Errors Error Code Short Message Long Message 10014 API call was rate limited. The API call has been denied as it has exceeded the permissible call rate limit. 10478 Invalid Data Recurring payments profile description must be provided if the billing agreement type is recurring payments. 10501 Invalid Configuration This transaction cannot be processed due to an invalid merchant configuration. Occurs when the billing agreement is disabled or inactive.
API Error Codes Recurring Payments Errors Error Code Short Message Long Message Additional Information 10513 Invalid Data This transaction cannot be processed. Please enter a last name. The last name of the buyer is required for this merchant. 10535 Gateway decline This transaction cannot be processed. Please enter a valid credit card number and type. 10544 Gateway Decline This transaction cannot be processed. 10544 Transaction cannot be processed. Please use a different payment card.
A 250 API Error Codes Recurring Payments Errors Error Code Short Message Long Message Additional Information 10713 Invalid Data There’s an error with this transaction. Please enter a country in the billing address. There was a problem with a particular field in the address. The long error message tells you which field is invalid. 10744 Invalid Data This transaction cannot be processed. Please enter a valid country code in the billing address.
API Error Codes Recurring Payments Errors Error Code Short Message Long Message 11506 Invalid max failed payments Max failed payments, if supplied, must be >= 0 11507 Invalid trial amount Trial amount must be >= 0 11508 Invalid trial total billing cycles Trial total billing cycles must be > 0 11509 Invalid trial billing period Trial billing period must be one of Day, Week, Month, SemiMonth, or Year 11510 Invalid trial amount Trial amount must be >= 0 11511 Invalid currency for trial amou
A 252 API Error Codes Recurring Payments Errors Error Code Short Message Long Message 11531 Invalid profile status The profile status must be one of (A)ctive, (C)ancelled, or e(X)pired 11543 Invalid payer country The payer’s country is currently not supported 11544 Invalid period status The trial period status must be one of (A)ctive or (C)ancelled 11545 Denied Payer’s account is denied 11546 Denied Merchant account is denied 11547 This feature is not available at this time Recurring
API Error Codes Recurring Payments Errors Error Code Short Message Long Message 11564 The number of failed payments should be greater than the current number of failed payments The number of failed payments should be greater than the current number of failed payments 11567 The time of the update is too close to the billing date The time of the update is too close to the billing date 11568 Invalid currency for delinquent amount Invalid currency for delinquent amount 11569 Cannot increase delinq
A API Error Codes SetCustomerBillingAgreement Errors Error Code Short Message Long Message Additional Information 11590 Profile update is not required Based on your input request, profile already up to date. 11592 Subscription profiles are not supported for recurring payments Subscription profiles are not supported for recurring payments 11607 Duplicate request for specified Message Submission ID.
API Error Codes SetCustomerBillingAgreement Errors Error Code Short Message Long Message 10004 Transaction refused because of an invalid argument. See additional error messages for details. Invalid value for request billing address parameter. 10405 Transaction refused because of an invalid argument. See additional error messages for details. CancelURL is missing. CancelURL tag has no content. 10407 Transaction refused because of an invalid argument. See additional error messages for details.
A API Error Codes GetBillingAgreementCustomerDetails Errors Error Code Short Message Long Message Additional Information 10476 Transaction refused because of an invalid argument. See additional error messages for details. 10477 Transaction refused because of an invalid argument. See additional error messages for details. 10485 Payment not authorized Payment has not been authorized by the user.
API Error Codes CreateBillingAgreement Errors A CreateBillingAgreement Errors CreateBillingAgreement Errors Error Code Short Message Long Message 10014 API call was rate limited. The API call has been denied as it has exceeded the permissible call rate limit. 10408 Missing token Token is missing Token is missing. 10409 You’re not authorized to access this info. Express Checkout token was issued for a merchant account other than yours. Token belongs to a different merchant.
A API Error Codes DoReferenceTransaction Errors Error Code Short Message Long Message 10014 API call was rate limited. The API call has been denied as it has exceeded the permissible call rate limit. 10201 Billing Agreement was cancelled Billing Agreement was cancelled 10204 User’s account is closed or restricted User’s account is closed or restricted 10209 Disabled Preapproved Payments not enabled. Merchant pull is not enabled for the country or merchant is not enabled for merchant pull.
API Error Codes DoReferenceTransaction Errors Error Code Short Message Long Message Additional Information 10003 Missing argument Item name, amount and quantity are required if item category is provided. Scenario: Merchant passes item category as either Digital or Physical but does not also pass one of the following parameters: name, amount, or quantity. 10004 Transaction refused because of an invalid argument. See additional error messages for details.
A API Error Codes DoReferenceTransaction Errors Error Code Short Message Long Message Additional Information 10201 Agreement canceled Billing Agreement was cancelled Inform the customer that the billing agreement has been cancelled and the customer needs to create a new one. Offer the customer the chance to signup for a new billing agreement through Express Checkout.
API Error Codes DoReferenceTransaction Errors Error Code Short Message Long Message 10213 Invalid Soft Descriptor The soft descriptor passed in contains invalid characters 10214 A Additional Information Soft descriptor format error. 10215 Soft Descriptor truncated The soft descriptor was truncated 10216 Confirmed address required Transaction refused because a confirmed address is not available Transaction refused because a confirmed address is not available.
A API Error Codes DoReferenceTransaction Errors Error Code 262 Short Message Long Message Additional Information 10417 Transaction cannot complete. The transaction cannot complete successfully. Instruct the customer to use an alternative payment method. Account not associated with a usable funding source, or credit card or Billing Agreement is required to complete payment.
API Error Codes DoReferenceTransaction Errors Error Code Short Message Long Message Additional Information 10429 Transaction refused because of an invalid argument. See additional error messages for details. Item sales tax is invalid PaymentDetailsItem.Tax field is invalid. Warning only; API executes. 10430 Transaction refused because of an invalid argument. See additional error messages for details. Item amount is missing. PaymentDetailsItem.Amount field is missing. Warning only; API executes.
A 264 API Error Codes DoReferenceTransaction Errors Error Code Short Message Long Message Additional Information 10507 Invalid Configuration This transaction cannot be processed. Please contact PayPal Customer Service. Inform the customer that PayPal declined the transaction and to contact PayPal Customer Service for more information: https://www.paypal.com/contact us 10527 Invalid Data This transaction cannot be processed. Please enter a valid credit card number and type.
API Error Codes DoReferenceTransaction Errors Error Code Short Message Long Message 10622 Order is voided. Order is voided. 10623 Maximum number of authorization allowed for the order is reached. Maximum number of authorization allowed for the order is reached. 10725 Shipping Address Country Error There was an error in the Shipping Address Country field Shipping address error in country field.
A API Error Codes DoReferenceTransaction Errors Error Code 266 Short Message Long Message Additional Information 11091 The transaction was blocked as it would exceed the sending limit for this buyer. The transaction was blocked as it would exceed the sending limit for this buyer. Inform the customer that PayPal declined the transaction and to contact PayPal Customer Service for more information: https://www.paypal.
API Error Codes DoReferenceTransaction Errors Error Code Short Message Long Message Additional Information 11452 Merchant not enabled for reference transactions Merchant not enabled for reference transactions This merchant is not enabled for Mark reference transaction. 11453 Reference transactions temporarily unavailable. Reference transaction feature not currently available; try again later Feature wired off. 11453 Reference transactions temporarily unavailable.
A API Error Codes AddressVerify API Errors Error Code Short Message Long Message Additional Information 13701 Invalid Data Item Category value is invalid. Only Digital or Physical are allowed. Scenario: When merchant passes an item category value other than Digital or Physical. 18014 Gateway Decline This transaction cannot be processed. This transaction cannot be processed without a Credit Card Verification number.
API Error Codes ManagePendingTransactionStatus API Errors Error Code Short Message Long Message 11614 The transaction has already been Accepted/Denied and the status cannot be changed The transaction has already been Accepted/Denied and the status cannot be changed Name-Value Pair API Developer Guide February 01, 2013 A 269
A 270 API Error Codes ManagePendingTransactionStatus API Errors February 01, 2013 Name-Value Pair API Developer Guide
B Countries and Regions Supported by PayPal PayPal uses 2-character IS0-3166-1 codes for specifying countries and regions that are supported in fields and variables. Countries marked with an asterisk ( * ) are not supported for PayPal Payments Pro and Virtual Terminal. NOT E : It is important that you pass the correct country code when sending a charge transaction to PayPal in API calls such as: DoExpressCheckoutPayment, DoReferenceTransaction and SetExpressCheckout.
B 272 Countries and Regions Supported by PayPal Country or Region Country or Region Code BHUTAN BT BOSNIA-HERZEGOVINA BA BOTSWANA BW BOUVET ISLAND * BV * BRAZIL BR BRITISH INDIAN OCEAN TERRITORY * IO * BRUNEI DARUSSALAM BN BULGARIA BG BURKINA FASO BF CANADA CA CAPE VERDE CV CAYMAN ISLANDS KY CENTRAL AFRICAN REPUBLIC * CF * CHILE CL CHINA CN (For domestic Chinese bank transactions only) C2 (For CUP, bank card and cross-border transactions) CHRISTMAS ISLAND * CX * COCOS (K
Countries and Regions Supported by PayPal Country or Region Country or Region Code ESTONIA EE FALKLAND ISLANDS (MALVINAS) FK FAROE ISLANDS FO FIJI FJ FINLAND FI FRANCE FR FRENCH GUIANA GF FRENCH POLYNESIA PF FRENCH SOUTHERN TERRITORIES TF GABON GA GAMBIA GM GEORGIA GE GERMANY DE GHANA GH GIBRALTAR GI GREECE GR GREENLAND GL GRENADA GD GUADELOUPE GP GUAM GU GUERNSEY GG GUYANA GY HEARD ISLAND AND MCDONALD ISLANDS * HM * HOLY SEE (VATICAN CITY STATE) VA HONDURA
B 274 Countries and Regions Supported by PayPal Country or Region Country or Region Code ISLE OF MAN IM ISRAEL IL ITALY IT JAMAICA JM JAPAN JP JERSEY JE JORDAN JO KAZAKHSTAN KZ KIRIBATI KI KOREA, REPUBLIC OF KR KUWAIT KW KYRGYZSTAN KG LATVIA LV LESOTHO LS LIECHTENSTEIN LI LITHUANIA LT LUXEMBOURG LU MACAO MO MACEDONIA MK MADAGASCAR MG MALAWI MW MALAYSIA MY MALTA MT MARSHALL ISLANDS MH MARTINIQUE MQ MAURITANIA MR MAURITIUS MU MAYOTTE YT MEXICO MX
Countries and Regions Supported by PayPal Country or Region Country or Region Code MONACO MC MONGOLIA MN MONTENEGRO ME MONTSERRAT MS MOROCCO MA MOZAMBIQUE MZ NAMIBIA NA NAURU NR NEPAL * NP * NETHERLANDS NL NETHERLANDS ANTILLES AN NEW CALEDONIA NC NEW ZEALAND NZ NICARAGUA NI NIGER NE NIUE NU NORFOLK ISLAND NF NORTHERN MARIANA ISLANDS MP NORWAY NO OMAN OM PALAU PW PALESTINE PS PANAMA PA PARAGUAY PY PERU PE PHILIPPINES PH PITCAIRN PN POLAND PL PORTUGAL
B 276 Countries and Regions Supported by PayPal Country or Region Country or Region Code REUNION RE ROMANIA RO RUSSIAN FEDERATION RU RWANDA RW SAINT HELENA SH SAINT KITTS AND NEVIS KN SAINT LUCIA LC SAINT PIERRE AND MIQUELON PM SAINT VINCENT AND THE GRENADINES VC SAMOA WS SAN MARINO SM SAO TOME AND PRINCIPE * ST * SAUDI ARABIA SA SENEGAL SN SERBIA RS SEYCHELLES SC SINGAPORE SG SLOVAKIA SK SLOVENIA SI SOLOMON ISLANDS SB SOUTH AFRICA ZA SOUTH GEORGIA AND THE SOUT
Countries and Regions Supported by PayPal Country or Region Country or Region Code TIMOR-LESTE TL TOGO TG TOKELAU TK TONGA TO TRINIDAD AND TOBAGO TT TUNISIA TN TURKEY TR TURKMENISTAN TM TURKS AND CAICOS ISLANDS TC TUVALU TV UGANDA UG UKRAINE UA UNITED ARAB EMIRATES AE UNITED KINGDOM GB UNITED STATES US UNITED STATES MINOR OUTLYING ISLANDS UM URUGUAY UY UZBEKISTAN UZ VANUATU VU VENEZUELA VE VIET NAM VN VIRGIN ISLANDS, BRITISH VG VIRGIN ISLANDS, U.S.
B 278 Countries and Regions Supported by PayPal February 01, 2013 Name-Value Pair API Developer Guide
C State and Province Codes Canadian Province or U.S.
C 280 State and Province Codes Canadian Province or U.S.
State and Province Codes Canadian Province or U.S.
C 282 State and Province Codes February 01, 2013 Name-Value Pair API Developer Guide
D Currency Codes PayPal uses 3-character ISO-4217 codes for specifying currencies in fields and variables. Currencies and Currency Codes Supported by PayPal Currency Currency Code Australian Dollar AUD Brazilian Real BRL N O TE : This currency is supported as a payment currency and a currency balance for in-country PayPal accounts only.
D Currency Codes Currency Currency Code Swiss Franc CHF Taiwan New Dollar TWD N O TE : This currency does not support decimals. Decimal amounts will throw an error. Thai Baht THB Turkish Lira TRY N O TE : This currency is supported as a payment currency and a currency balance for in-country PayPal accounts only. U.S.
Currency Codes Direct Payment Currency for Specified Card in United States Direct Payment Currency for Specified Card in United Kingdom Direct Payment Currency for Specified Card in Canada SEK Visa, MasterCard Visa, MasterCard Swiss Franc CHF Visa, MasterCard Visa, MasterCard U.S.
D 286 Currency Codes February 01, 2013 Name-Value Pair API Developer Guide
E AVS and CVV2 Response Codes AVS Response Codes Related information: DoDirectPayment Response Fields AVS Response Codes for Visa, MasterCard, Discover, and American Express AVS Code Meaning Matched Details A Address Address only (no ZIP code) B International “A” Address only (no ZIP code) C International “N” None NOT E : The transaction is declined.
E AVS and CVV2 Response Codes AVS Response Codes AVS Code Meaning Matched Details W Whole ZIP Nine-digit ZIP code (no Address) X Exact match Address and nine-digit ZIP code Y Yes Address and five-digit ZIP Z ZIP Five-digit ZIP code (no Address) All others Error Not applicable Related information: DoDirectPayment Response Fields AVS Response Codes for Maestro AVS Code Meaning Matched Details 0 All the address information matched.
AVS and CVV2 Response Codes CVV2 Response Codes E CVV2 Response Codes CVV2 Response Codes for Visa, MasterCard, Discover, and American Express CVV2 Code Meaning Matched Details E Error - Unrecognized or Unknown response Not applicable I Invalid or Null Not applicable M Match CVV2CSC N No match None P Not processed Not applicable S Service not supported Not applicable U Service not available Not applicable X No response Not applicable CVV2 Response Codes for Maestro CVV2 Code M
E 290 AVS and CVV2 Response Codes CVV2 Response Codes February 01, 2013 Name-Value Pair API Developer Guide
About Previous Versions of the API Previous versions of the API can still be used; however, PayPal recommends using the latest version whenever possible. Unless specifically specified, API operations default to the latest version. What's New in Version 95.0 Maintenance release. Updated for 95.0. Added new 11800 error field and fulfillmentReferenceNumber field related to Global Shipping Program (GSP). See PayPal Release Notes for more information: https://www.x.
About Previous Versions of the API What's New in Version 88.0 What's New in Version 88.0 Maintenance release, updated for 88.0. What’s New in Version 85.0 No new features added; solely a maintenance release. What’s New in Version 84.0 New Field in RefundTransaction Response Field Description REFUNDINFO Contains refund payment status information. This field is available since version 84.0. New RefundInfoType in RefundTransaction Response Field Description REFUNDSTATUS Status of the refund.
About Previous Versions of the API What’s New in Version 82.0 New Field in DoReferenceTransactionResponseDetailsType Field Description PAYMENTADVICECODE Response code from the processor when a recurring transaction is declined. For details on the meanings of the codes, see: https://merchant.paypal.com/us/cgi-bin/?&cmd=_rendercontent&content_ID=merchant/cc_compliance_error_codes This field is available since version 84.0.
About Previous Versions of the API What’s New in Version 82.0 Field Description TERMINALID (Optional) ID of the terminal. Character length and limitations: 50 single-byte characters This field is available since version 82.0. New Fields in RefundTransaction Request Field Description MERCHANTSTOREDETAILS (Optional) Information about the merchant store. This field is available since version 82.0. RETRYUNTIL (Optional) Maximum time until you must retry the refund.
About Previous Versions of the API What’s New in Version 80.0 Field Description TERMINALID (Optional) ID of the terminal. Character length and limitations: 50 single-byte characters This field is available since version 82.0. What’s New in Version 80.0 New Fields in PaymentDetailsType in DoReferenceTransaction Request Field Description RECURRING (Optional) Flag to indicate a recurring transaction.
About Previous Versions of the API What’s New in Version 72.0 New DoExpressCheckoutPayment Error Code Error Code 13751 Short Message Long Message Could not retrieve the original successful response. Transaction completed successfully, but could not retrieve the original successful response. Correcting This Error... What’s New in Version 72.0 New TaxIdDetailsType Structure in SetExpressCheckout Request TaxIdDetailsType Fields Field Description TAXIDTYPE New field The buyer’s tax ID type.
About Previous Versions of the API What's New in Version 69 What's New in Version 69 New PaymentDetailsItemType Structure in CreateRecurringPaymentsProfile Request PaymentDetailsItemType Fields Field Description L_PAYMENTREQUEST_n_IT EMCATEGORYm New field Indicates whether the item is digital or physical goods. For digital goods, this field is required and you must set it to Digital to get the best rates.
About Previous Versions of the API What's New in Version 69 Field Description L_PAYMENTREQUEST_n_QT Ym New field Item quantity. This field is required when you pass a value for ItemCategory. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_QTY0, L_PAYMENTREQUEST_n_QTY1). Character length and limitations: Any positive integer L_PAYMENTREQUEST_n_TA XAMTm New field (Optional) Item sales tax.
About Previous Versions of the API What's New in Version 66 Field Description L_QTYn Item quantity. This field is required when you pass a value for ItemCategory. These parameters must be ordered sequentially beginning with 0 (for example L_QTY0, L_QTY1).
About Previous Versions of the API What's New in Version 66 Field Description L_PAYMENTREQUEST_n_NAME Item name. For digital goods, this field is required. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_NAME0, L_PAYMENTREQUEST_n_NAME1).
About Previous Versions of the API What's New in Version 66 Changes to PaymentDetailsItemType in GetExpressCheckoutDetails Response Field Description L_PAYMENTREQUEST_n_ITEMC ATEGORYm New field Inicates whethe item is digital or physical goods. For digital goods this field is required and you must set it to Digital. It is one of the following values: Digital Physical This field is available since version 65.1.
About Previous Versions of the API What's New in Version 66 302 February 01, 2013 Name-Value Pair API Developer Guide
Revision History Date Description 01 February 2013 Maintenance release. Updated for 98.0. See PayPal Merchant API Release Notes for more information: https://www.x.com/developers/paypal/documentation-tools/releasenotes#MerchantAPI 14 December 2012 Maintenance release. See PayPal Merchant API Release Notes for more information: https://www.x.com/developers/paypal/documentationtools/release-notes 14 November 2012 Maintenance release.
Revision History 304 Date Description 14 February 2012 Maintenance release 24 January 2012 Maintenance release, updated for 85.0. 1November 2011 Updated for 84.0. Added new field and a new type to RefundTransaction API request. Added new field to DoDirectPayment API and DoReferenceTransaction API responses. Edits to improve accuracy. 1 September 2011 General edits to improve consistency. 5 April 2011 Updated for 71.0.
Revision History Date Description April 2008 Added Fraud Management Filters information. Changed recurring payments information. February 2008 Added that ther VERSION parameter must be 50.0 in the API call to use recurring payments. January 2008 September 2007 Added billing agreement fields to SetExpressCheckout for recurring payments Updated CreateRecurringPaymentsProfile for new recurring payments features.
Revision History 306 February 01, 2013 Name-Value Pair API Developer Guide
Index Numerics 3-D Secure request fields 48 3D Secure response fields 50 A ACCT request field 42, 52, 142, 160, 178, 190 ACCT response field 152 ACTION request field 133, 154 Activation Details request fields 141 ADDITIONALBILLINGCYCLES request field 157 Address request fields 43, 53, 143, 161, 179 Address response fields 124, 153 Address Verify request fields 25 Address Verify response fields 26 ADDRESSOWNER response field 124, 153 ADDRESSSTATUS response field 82, 124, 148, 153, 168 AddressVerify API ope
Index BUYERID request field 75 BUYERID response field 131 BUYERMARKETINGEMAIL request field 93 BUYERMARKETINGEMAIL response field 80, 123 BUYERREGISTRATIONDATE request field 76 BUYERUSERNAME request field 76 C CAD 283, 284 Callback API operation 55 CALLBACK request field 60 Callback request fields 55 Callback request message 55 Callback response fields 58 Callback response message 58 CALLBACKTIMEOUT request field 60 CALLBACKVERSION request field 61 Canadian Dollar 283, 284 CANCELURL request field 60, 163
Index DoDirectPayment API operation 41 DoDirectPayment request message 41 DoDirectPayment response message 48 DoExpressCheckoutPayment API operation 92 DoExpressCheckoutPayment request message 92 DoExpressCheckoutPayment response message 105 DoNonReferencedCredit API operation 51 DoNonReferencedCredit request message 51 DoNonReferencedCredit response message 54 DoReauthorization API operation 36 DoReauthorization request message 36 DoReauthorization response message 37 DoReferenceTransaction API operation
Index ISSUENUMBER response field 152 ITE MAMT request field 44 ITEMAMT request field 67, 95, 174, 299 ITEMAMT response field 83 GetTransactionDetails API operation 121 GetTransactionDetails request message 121 GetTransactionDetails response message 121 GIFTMESSAGE request field 93 GIFTMESSAGE response field 80, 122 GIFTMESSAGEENABLE request field 64 GIFTRECEIPTENABLE request field 64, 93 GIFTRECEIPTENABLE response field 80, 122 GIFTW RAPENABLE request field 64 GIFTWRAPAMOUNT request field 65, 93 GIFTWRAPA
Index L_FMFfilterI Dn response field 106 L_FMFfilterIDn response field 49, 113, 180 L_FMFfilterNAM E n response field 113 L_FMFfilterNAMEn response field 49, 106, 180 L_INSURANCEAMOUNT response field 59 L_ITEMCATEGORYn 176, 298 L_ITEMHEIGHTUNITn request field 57, 74, 102 L_ITEMHEIGHTUNITn response field 89 L_ITEMHEIGHTVALUEn request field 57, 74, 102 L_ITEMHEIGHTVALUEn response field 89 L_ITEMLENGHTUNITn request field 73, 101 L_ITEMLENGTHUNITn request field 57 L_ITEMLENGTHUNITn response field 88 L_ITEMLENG
Index L_PAYMENTREQUEST_n_ITEMWIDTHVALUEm response field 89 L_PAYMENTREQUEST_n_NAMEm request field 71, 100, 144, 297, 300 L_PAYMENTREQUEST_n_NAMEm response field 87 L_PAYMENTREQUEST_n_NU MBERm response field 88 L_PAYMENTREQUEST_n_NUMBERm request field 72, 100, 145, 297 L_PAYMENTREQUEST_n_QTYm request field 72, 101, 145, 298, 300 L_PAYMENTREQUEST_n_QTYm response field 88 L_PAYMENTREQUEST_n_TAXAMTm request field 73, 88, 101, 145, 298 L_PAYMENTTYPEn request field 77, 166 L_QTY request field 46, 177, 299 L_QTYn
Index N NETAMT request field 51 NETREFUNDAMT response field 187 New Zealand Dollar 283, 284 NEXTBILLINGDATE response field 151 NO_SHIPPING_OPTION_DETAILS response field 59 NOK 283, 284 Norwegian Krone 283, 284 NOSHIPPING request field 61 NOTE request field 28, 39, 52, 154, 156 NOTE response field 79, 105, 129 NOTETEXT request field 70, 97 NOTETEXT response field 86 NOTIFY URL request field 97 NOTIFYURL request field 45, 70, 176 NOTIFYURL response field 86 NUMCYCLESREMAINING response field 151 NUMCYCYLESCOM
Index PAYMENTINFO_n_SEVERITYCODE response field 91, 114 PAYMENTINFO_n_SHORTMESSAGE response field 91, 114 PAYMENTINFO_n_TAXAMT response field 109 PAYMENTINFO_n_TRANSACTIONID response field 108, 109 PAYMENTINFO_n_TRANSACTIONTYPE response field 108 PaymentItemType response fields 130 PaymentPeriod.
Index PAYMENTREQUEST_n_SHIPTOSTREET request field 65, 99 PAYMENTREQUEST_n_SHIPTOSTREET response field 81 PAYMENTREQUEST_n_SHIPTOSTREET2 request field 65, 99 PAYMENTREQUEST_n_SHIPTOSTREET2 response field 81 PAYMENTREQUEST_n_SHIPTOZIP request field 66, 99 PAYMENTREQUEST_n_SHIPTOZIP response field 82 PAYMENTREQUEST_n_SOFTDESCRIPTOR request field 97 PAYMENTREQUEST_n_TAXAMT request field 69, 96 PAYMENTREQUEST_n_TAXAMT response field 85 PAYMENTREQUEST_n_TRANSACTIONID request field 70 PAYMENTREQUEST_n_TRANSACTION
Index REGULARTOTALBILLINGCYCLES response field 149 REQCONFIRMSHIPPING request field 60, 172 RET URNURL request field 60 RETRYUNTIL req uest field 186 RETURNALLCURRENCIES request field 117 RETURNFMFDETAILS request field 41, 93, 172 RETURNURL request field 163 S SALESTAX response field 129 SALUTATION request field 53, 143, 191 SALUTATION response field 124, 168, 170 Schedule Details request fields 138 SEK 283, 285 Seller Details request fields 104 SELLERID request field 104 SELLERREGISTRATIONDATE re quest f
Index SUBSCRIBERNAME response field 147 Subscription Terms response fields 131 SUCCESSPAGEREDIRECTREQUESTED response field 105 SUFFIX request field 53, 143, 191 SUFFIX response field 81, 124, 168, 171 SURVEYCHOICESELECTED request field 93 SURVEYCHOICESELECTED response field 80, 123 SURVEYENABLE request field 65 SURVEYQUESTION request field 65, 93 SURVEYQUESTION response field 80, 123 Swedish Krona 283, 285 Swiss Franc 284, 285 T Taiwan New Dollar 284 TAXAMT request field 45, 51, 69, 96, 157, 159, 175 TAXA
Index 318 February 01, 2013 Name-Value Pair API Developer Guide
