Name-Value Pair API Developer Guide Last updated: August 2012
Name-Value Pair API Developer Guide Document Number: 100018.en_US-201208 © 2012 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 in Version 93.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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 CreateBillingAgreement API Response Message . . . . . . . . . . . . . . . . . . . .162 SetCustomerBillingAgreement API Operation . . . . . . . . . . . . . . . . . . . . . . . .162 SetCustomerBillingAgreement Request Message. . . . . . . . . . . . . . . . . . . .162 SetCustomerBillingAgreement Response Message . . . . . . . . . . . . . . . . . . .165 GetBillingAgreementCustomerDetails API Operation . . . . . . . . . . . . . . . . . . . .166 GetBillingAgreementCustomerDetails Request Message . . . .
Contents GetTransactionDetails API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .237 TransactionSearch API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .237 RefundTransaction API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .239 MassPay API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .242 Recurring Payments Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents What’s New in Version 82.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .283 New Field in DoCapture Request . . . . . . . . . . . . . . . . . . . . . . . . . . . .283 New MerchantStoreDetailsType in DoCapture Request . . . . . . . . . . . . . . . . .283 New Fields in RefundTransaction Request . . . . . . . . . . . . . . . . . . . . . . .283 New MerchantStoreDetailsType in RefundTransaction Request . . . . . . . . . . . .284 What’s New in Version 80.0 . . . . . . . . . . . . . .
Contents 10 August 2012 Name-Value Pair API Developer Guide
What’s New What’s New in Version 93.0 Maintenance release. New 10486 error code added for redirects when the process declines the transaction: The transaction couldn’t be completed. Please redirect your customer to PayPal.
What’s New in Version 93.
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 August 2012 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. Creating an NVP Request The Name-Value Pair request format specifies the API operation to perform, credentials that authorize PayPal to access your account, and fields containing additional information to be used in the request.
PayPal Name-Value Pair API Basics Creating an NVP Request 1 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. When you execute a PayPal API operation, you use credentials, such as a signature, to authenticate that you are requesting the API operation.
1 PayPal Name-Value Pair API Basics Creating an NVP Request curl --insecure https://api-3t.sandbox.paypal.com/nvp -d ^ "METHOD=name^ &VERSION=XX.0^ &USER=API_username^ &PWD=API_password^ &SIGNATURE=API_signature^ &..." This example does not establish a secure connection and should not be used live on paypal.com. NOT E : URL Encoding All requests to execute PayPal API operations sent using HTTP must be URL-encoded.
PayPal Name-Value Pair API Basics Executing NVP API Operations Language 1 Method PHP ColdFusion Encode urlencode() Decode urldecode() Encode URLEncodedFormatstring [, charset] Decode URLDecodeurlEncodedString[, charset]) Related information: URL Decoding List Syntax for Name-Value Pairs The PayPal API uses a special syntax for NVP fields defined as lists. The NVP interface to the PayPal API requires a unique name for each field. In the API, lists are prefixed by L_.
1 PayPal Name-Value Pair API Basics Responding to an NVP Response Server end point Description https://api-3t.paypal.com/nvp PayPal “live” production server for use with API signatures https://api.sandbox.paypal.com/nvp Sandbox server for use with API certificates; use for testing your API https://api.paypal.com/nvp PayPal “live” production server for use with API certificates NOT E : You must use different API credentials for each server end point.
PayPal Name-Value Pair API Basics Responding to an NVP Response 1 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 In this case, the parameter ID is ProcessorResponse, which indicates an error response by a credit or debit card processor. The value contains the processor-specific error. These values are not set by PayPal; rather, they are passed through from the source. NOT E : PayPal only passes selected values in the L_ERRORPARAMIDn and L_ERRORPARAMVALUEn fields.
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 A d d r e s s Ve r i f y R e s p o n s e M e s s a g e 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 TRANSACTIONENTITY (Optional) Type of transaction to authorize. The only allowable value is Order, which means that the transaction represents a buyer order that can be fulfilled over 29 days. CURRENCYCODE (Optional) A 3-character currency code. MSGSUBID (Optional) A message ID used for idempotence to uniquely identify a message.
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 Authorization Information Fields Field Description PAYMENTSTATUS Status of the payment. It is one of the following values: None – No status. Canceled-Reversal – A reversal has been canceled.
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 40 Authorization and Capture API Operation Reference DoVoid API Operation August 2012 Name-Value Pair API Developer Guide
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 LASTNAME (Required) Buyer’s last name. Character length and limitations: 25 single-byte characters 4 Address Fields Field Description STREET (Required) First street address. Character length and limitations: 100 single-byte characters STREET2 (Optional) Second street address. Character length and limitations: 100 single-byte characters CITY (Required) Name of city.
4 DoDirectPayment API Operation DoDirectPayment Request Message Field Description ITEMAMT (Optional) Sum of cost of all items in this order. NOTE: ITEMAMT is required if you specify L_AMTn. 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 (,).
DoDirectPayment API Operation DoDirectPayment Request Message Field Description DESC (Optional) Description of items the buyer is purchasing. NOTE: 4 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. Character length and limitations: 127 single-byte alphanumeric characters CUSTOM (Optional) A free-form field for your own use.
4 DoDirectPayment API Operation DoDirectPayment Request Message Payment Details Item Fields Field Description L_NAMEn (Optional) Item name. These parameters must be ordered sequentially beginning with 0 (for example L_NAME0, L_NAME1). Character length and limitations: 127 single-byte characters L_DESCn (Optional) Item description. Character length and limitations: 127 single-byte characters L_AMTn (Optional) Cost of item.
DoDirectPayment API Operation DoDirectPayment Request Message Field Description L_EBAYITEMORDERIDn (Optional) Auction order identification number. These parameters must be ordered sequentially beginning with 0 (for example L_EBAYITEMORDERID0, L_EBAYITEMORDERID1). Character length: 64 single-byte characters 4 Ship To Address Fields Field Description SHIPTONAME Person’s name associated with this shipping address. It is required if using a shipping address.
4 DoDirectPayment API Operation DoDirectPayment Response Message Field Description CAVV (Optional) A value returned by the Cardinal Centinel. If the cmpi_lookup request returns Y for Enrolled, set this field to the Cavv value returned by cmpi_authenticate. Otherwise, set this field to blank. ECI3DS (Optional) A value returned by the Cardinal Centinel. If the cmpi_lookup request returns Y for Enrolled, set this field to the EciFlag value returned by cmpi_authenticate.
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 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 AddressType Fields Field Description PAYMENTREQUEST_n_SHIPTONAM Person’s name associated with this shipping address. It is required if using a E shipping address. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. SHIPTONAME (deprecated) Character length and limitations: 32 single-byte characters SHIPTONAME is deprecated since version 63.0. Use PAYMENTREQUEST_0_SHIPTONAME instead.
ExpressCheckout API Operations SetExpressCheckout API Operation Field 6 Description PAYMENTREQUEST_n_SHIPTOPHO (Optional) Phone number. You can specify up to 10 payments, where n is a NENUM digit between 0 and 9, inclusive. SHIPTOPHONENUM (deprecated) Character length and limitations: 20 single-byte characters SHIPTOPHONENUM is deprecated since version 63.0. Use PAYMENTREQUEST_0_SHIPTOPHONENUM instead.
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. TAXIDDETAILS 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 PaymentCompleted 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 SALUTATION Buyer’s salutation.
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. TAXIDDETAILS 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_n_SHIPTONAM Person’s name associated with this shipping address. It is required if using a E shipping address. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. SHIPTONAME (deprecated) Character length and limitations: 32 single-byte characters SHIPTONAME is deprecated since version 63.0. Use PAYMENTREQUEST_0_SHIPTONAME instead.
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PAYMENTREQUEST_n_SHIPTOPHO (Optional) Phone number. You can specify up to 10 payments, where n is a NENUM digit between 0 and 9, inclusive. SHIPTOPHONENUM (deprecated) Character length and limitations: 20 single-byte characters SHIPTOPHONENUM is deprecated since version 63.0. Use PAYMENTREQUEST_0_SHIPTOPHONENUM instead.
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description L_PAYMENTREQUEST_n_NU MBERm L_NUMBERn (deprecated) (Optional) 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).
6 102 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description L_PAYMENTREQUEST_n_IT EMLENGTHVALUEm, L_PAYMENTREQUEST_n_IT EMLENGTHUNITm L_ITEMLENGTHVALUEn and L_ITEMLENGHTUNITn (deprecated) (Optional) Item length corresponds to the length 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 Field Description L_PAYMENTREQUEST_n_IT EMCATEGORYm Indicates whether an item is digital or physical. For digital goods, this field is required and must be set to Digital. 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_EB AYCARTIDm L_EBAYITEMCARTIDn (deprecated) (Optional) The unique identifier provided by eBay for this order from the buyer. 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.
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PAYMENTREQUEST_n_SELL ERUSERNAME SELLERUSERNAME (deprecated) xs:string (Optional) Current name of the merchant or business at the marketplace site. This name may be shown to the buyer. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. SELLERUSERNAME is deprecated since version 63.0. Use PAYMENTREQUEST_0_SELLERUSERNAME instead.
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description SUCCESSPAGEREDIRECT REQUESTED Flag to indicate whether you would like to redirect the buyer to sign up for PayPal after completing the transaction. If set to true, you can redirect users to the following URL with the token value appended:: https://www.paypal.
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PAYMENTINFO_n_SELLE RID Unique, non-changing identifier for the merchant at the marketplace site. (Optional) You can specify up to 10 payments, where ‘n’ is a digit between 0 and 9, inclusive. Character length and limitations: 13 single-byte alphanumeric characters. PAYMENTINFO_n_SELLE RUSERNAME Current name of the merchant or business at the marketplace site. This name may be shown to the buyer.
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PAYMENTINFO_n_OFFER TRACKINGID Unique identification for merchant/buyer/offer combo. 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.
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PAYMENTINFO_n_ORDER TIME ORDERTIME (deprecated) Time/date stamp of payment. Character length and limitations: Date and time are in UTC/GMTformat, for example, 2011-06-24T05:38:48Z ORDERTIME is deprecated since version 63.0. Use PAYMENTINFO_0_ORDERTIME instead. PAYMENTINFO_n_AMT AMT (deprecated) The final amount charged, including any shipping and taxes from your Merchant Profile.
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PAYMENTINFO_n_EXCHA NGERATE EXCHANGERATE (deprecated) Exchange rate if a currency conversion occurred. Relevant only if your are billing in their non-primary currency. If the buyer chooses to pay with a currency other than the non-primary currency, the conversion occurs in the buyer’s account. Exchange rate if a currency conversion occurred. Relevant only if your are billing in their non-primary currency.
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PAYMENTINFO_n_PENDI NGREASON PENDINGREASON (deprecated) Reason the payment is pending. It is one of the following values: 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. It is one of the following values: 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.
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PAYMENTINFO_n_PROTE CTIONELIGIBILITYTYP E Since version 64.4, the kind of seller protection in force for the transaction. It is one of the following values: Since version 64.4, the kind of seller protection in force 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 L_PAYMENTINFO_n_FMF Filter ID, including the filter type, (PENDING, REPORT, or DENY), the filter ID, and the entry number, m, starting from 0.
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation 6 Payment Error Type Fields Field Description PAYMENTREQUEST_n_SH ORTMESSAGE xs:string Payment error short message. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. PAYMENTREQUEST_n_LO NGMESSAGE xs:string Payment error long message. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. PAYMENTREQUEST_n_ER RORCODE xs:string Payment error code.
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Seller Details Type Fields 116 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.
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 August 2012 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 Field Description INSURANCEOPTIONSELE CTED Whether the buyer selected the insurance option. It is one of the following values: true – The buyer selected Yes for the insurance option. false – The buyer did not select the insurance option. The option is No. The value true is returned if the buyer selected the option. Otherwise false is returned.
GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description SURVEYCHOICESELECTE D Survey response the buyer selected on the PayPal pages. Limitations: 15 single-byte characters 9 Receiver Information Fields Field Description RECEIVERBUSINESS Details about a single transaction. This field is not application for point-of-sale transactions. RECEIVEREMAIL Primary email address of the payment recipient (the merchant).
9 GetTransactionDetails API Operation GetTransactionDetails Response Message 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. 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.
GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description SHIPTOCOUNTRYCODE Country code. Character length and limitations: 2 single-byte characters SHIPTOPHONENUM Phone number. Character length and limitations: 20 single-byte characters 9 Payment Information Fields Field Description TRANSACTIONID Unique transaction ID of the payment.
9 126 GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description AMT The final amount charged, including any shipping and taxes from your Merchant Profile. 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 (,).
GetTransactionDetails API Operation GetTransactionDetails Response Message 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 and the funds for the reversal have been returned to you. Completed – The payment has been completed, and the funds have been added successfully to your account balance. Denied – You denied the payment.
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 EbayItemTxnId L_EBAYITEMTXNID xs:string (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 L_DESCn Item name set by you or entered by the customer. NOTE: Character length and limitations: 127 single-byte alphanumeric characters.
GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description L_OPTIONSNAMEn PayPal option names for an item in the shopping cart; each name corresponds to an option value. There can be multiple option names per item. The option names are ordered sequentially beginning with 0 (for example, L_OPTIONSNAMES0, L_OPTIONSNAME1). L_OPTIONSVALUEn PayPal option values corresponding to option names of an item in the shopping cart.
9 132 GetTransactionDetails API Operation GetTransactionDetails Response Message August 2012 Name-Value Pair API Developer Guide
10 ManagePendingTransactionStatus 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 ManagePendingTransactionStatus API Operation ManagePendingTransactionStatus Response Message M a n a g e P e n d i n g Tr a n s a c t i o n Sta t u s R e s p o n s e M e s s a g e ManagePendingTransactionStatus Response Fields 134 Field Description TRANSACTIONID The transaction ID of the transaction whose payment has been denied or accepted. 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 August 2012 Name-Value Pair API Developer Guide
Recurring Payments and Reference Transactions API Operations 12 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 Recurring Payments Profile Details Fields Field Description 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. Character length and limitations: 32 single-byte characters PROFILESTARTDATE (Required) The date when billing for this profile begins.
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 DESC Description of the recurring payment. Character length and limitations: 127 single-byte alphanumeric characters AUTOBILLOUTAMT Indicates whether you would like PayPal to automatically bill the outstanding balance amount in the next billing cycle. The outstanding balance is the total amount of any previously failed scheduled payments that have yet to be successfully paid.
12 Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation Ship To AddressType Fields Field Description ADDRESSSTATUS Status of street address on file with PayPal. It is one of the following values: none Confirmed Unconfirmed SHIPTONAME Person’s name associated with this address. Character length and limitations: 32 single-byte characters SHIPTOSTREET First street address.
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 SHIPTONAME Person’s name associated with this address.
12 Recurring Payments and Reference Transactions API Operations ManageRecurringPaymentsProfileStatus API Operation M a n a g e R e c u r r i n g P a y m e n ts P r o f i l e Sta t u s A P I O p e r a t i o n The ManageRecurringPaymentsProfileStatus API operation cancels, suspends, or reactivates a recurring payments profile.
Recurring Payments and Reference Transactions API Operations BillOutstandingAmount API Operation 12 BillOutstandingAmount API Operation The BillOutstandingAmount API operation bills the buyer for the outstanding balance associated with a recurring payments profile. BillOutstandingAmount Request Message BillOutstandingAmount Request Fields Field Description METHOD (Required) Must be BillOutstandingAmount.
12 Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation UpdateRecurringPaymentsProfile API Operation The UpdateRecurringPaymentsProfile API operation updates a recurring payments profile. UpdateRecurringPaymentsProfile Request Message UpdateRecurringPaymentsProfile Request Fields Field Description METHOD (Required) Must be UpdateRecurringPaymentsProfile.
Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation Field Description SHIPPINGAMT (Optional) Shipping amount for each billing cycle during the 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 UpdateRecurringPaymentsProfile API Operation Field Description 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. Character length and limitations: 40 single-byte characters SHIPTOSTATE State or province. It is required if using a shipping address.
Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation Field Description TRIALAMT Billing amount for each billing cycle during this payment period; required if you specify an optional trial period. This amount does not include shipping and tax amounts. NOTE: 12 All amounts in the CreateRecurringPaymentsProfile request must have the same currency.
12 Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation Field Description ACCT (Required) Credit card number. Character length and limitations: Numeric characters only with no spaces or punctutation. The string must conform with modulo and length required by each credit card type. EXPDATE Credit card expiration date. This field is required if you are using recurring payments with direct payments.
Recurring Payments and Reference Transactions API Operations CreateBillingAgreement API Operation 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.
12 Recurring Payments and Reference Transactions API Operations SetCustomerBillingAgreement API Operation CreateBillingAgreement API Response Message CreateBillingAgreement Response Fields Field Description BILLINGAGREEMENTID Identification number of the billing agreement. SetCustomerBillingAgreement API Operation The SetCustomerBillingAgreement API operation initiates the creation of a billing agreement. NOT E : If you are using Express Checkout with version 54.
Recurring Payments and Reference Transactions API Operations SetCustomerBillingAgreement API Operation Field Description LOCALECODE (Optional) Locale of pages displayed by PayPal during checkout.
12 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.
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.
12 Recurring Payments and Reference Transactions API Operations GetBillingAgreementCustomerDetails API Operation 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.
Recurring Payments and Reference Transactions API Operations GetBillingAgreementCustomerDetails API Operation 12 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.
12 Recurring Payments and Reference Transactions API Operations BAUpdate API Operation 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.
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 12 If you do not pass the value Canceled, BAUpdate returns the buyer’s latest billing address.
12 Recurring Payments and Reference Transactions API Operations BAUpdate 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 Bill To Address Fields 170 Field Description BILLINGNAME Billing name associated with this billing address.
Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation 12 D o R e f e r e n c e Tr a n s a c t i o n A P I O p e r a t i o n The DoReferenceTransaction API operation processes a payment from a buyer’s account, which is identified by a previous transaction. DoReferenceTransaction Request Message DoReferenceTransaction Request Fields Field Description METHOD (Required) Must be DoReferenceTransaction.
12 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.
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.
12 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description SHIPPINGAMT (Optional) Total shipping costs for this order. NOTE: 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 (.
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 : 12 The notify URL applies only to DoExpressCheckoutPayment. This value is ignored when set in SetExpressCheckout or GetExpressCheckoutDetails.
12 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.
Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation 12 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.
12 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description LASTNAME (Required) Buyer’s last name. Character length and limitations: 25 single-byte characters Address Fields Field Description STREET (Optional) First street address. Character length and limitations: 100 single-byte characters STREET2 (Optional) Second street address. Character length and limitations: 100 single-byte characters CITY (Optional) Name of city.
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.
12 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.
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 (,).
12 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.
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.
12 184 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation August 2012 Name-Value Pair API Developer Guide
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. Character length and limitations: 17 single-byte alphanumeric characters INVOICEID (Optional) Your own invoice or tracking number.
13 RefundTransaction API Operation RefundTransaction Request Message Field Description RETRYUNTIL (Optional) Maximum time until you must retry the refund. NOTE: This field does not apply to point-of-sale transactions. This field is available since version 82.0. REFUNDSOURCE (Optional)Type of PayPal funding source (balance or eCheck) that can be used for auto refund. It is one of the following values: any – The merchant does not have a preference. Use any available funding source.
RefundTransaction API Operation RefundTransaction Response Message Field Description TERMINALID (Optional) ID of the terminal. Character length and limitations: 50 single-byte characters This field is available since version 82.0. 13 RefundTransaction Response Message RefundTransaction Response Fields Field Description REFUNDTRANSACTIONID Unique transaction ID of the refund.
13 RefundTransaction API Operation RefundTransaction Response Message Field Description CURRENCYCODE Currency code. Character length and limitations: 3 single-byte characters REFUNDINFO Contains refund payment status information. This field is available since version 84.0. MSGSUBID (Optional) A message ID used for idempotence to uniquely identify a message. This ID can later be used to request the latest results for a previous request without generating a new request.
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 Request 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 TransactionSearch API Operation TransactionSearch Response Message Tr a n s a c t i o n S e a r c h R e s p o n s e M e s s a g e TransactionSearch Response Fields 192 Field Description L_TIMESTAMPn Date and time in UTC/GMT that the transaction occurred. L_TIMEZONEn Time zone of the transaction. The value is always GMT. L_TYPEn Type of the transaction.
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 10101 This API Temporarily Unavailable This API is temporarily unavailable. Please try later.
API Error Codes Validation Errors Error Code Short Message Long Message 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 : Required parameter missing 81119 Missing Parameter ItemAmt : Required parameter missing 81120 Missing Parameter ShippingAmt : Require
A 196 API Error Codes Validation Errors Error Code Short Message Long Message 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 : Required parameter missing 81150 Missing Parameter Version : Required parameter missing 81200 Missing Parameter Amt : Invalid paramet
API Error Codes DirectPayment API Errors Error Code Short Message Long Message 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 Parameter Street2 : Invalid parameter 81239 Invalid Parameter City : Invalid parameter 81243 Invalid Parameter RefundTyp
A API Error Codes DirectPayment API Errors Error Code 198 Short Message Long Message Corrective Action 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. See additional error messages for details. 10427 Shipping total is invalid. Transaction refused because of an invalid argument.
API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10507 Invalid Configuration This transaction cannot be processed. Please contact PayPal Customer Service. Your PayPal account is restricted. Contact PayPal for more information. 10508 Invalid Data This transaction cannot be processed. Please enter a valid credit card expiration date. The expiration date must be a two-digit month and four-digit year.
A 200 API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10535 Gateway Decline This transaction cannot be processed. Please enter a valid credit card number and type. The credit card entered is invalid. 10536 Invalid Data This transaction cannot be processed. The merchant entered an invoice ID that is already associated with a transaction by the same merchant. By default, the invoice ID must be unique for all transactions.
API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10548 Invalid Configuration This transaction cannot be processed. The merchant’s account is not able to process transactions. The merchant account attempting the transaction is not a business account at PayPal. Check your account settings. 10549 Invalid Configuration This transaction cannot be processed. The merchan’s account is not able to process transactions.
A 202 API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10564 Gateway Decline This transaction cannot be processed. There was a problem processing this transaction. 10565 Merchant country unsupported The merchant country is not supported. 10566 Credit card type unsupported The credit card type is not supported. 10567 Invalid Data This transaction cannot be processed. Please enter a valid credit card number and type.
API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10708 Invalid Data There’s an error with this transaction. Please enter a complete billing address. There was a problem with a particular field in the address. The long error message tells you which field is invalid. 10709 Invalid Data There’s an error with this transaction. Please enter an address1 in the billing address. There was a problem with a particular field in the address.
A 204 API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10717 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. 10718 Invalid Data There’s an error with this transaction. Please enter a valid city and state 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. 10728 Invalid Data There’s an error with this transaction. Please enter a city 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 10744 Invalid Data This transaction cannot be processed. Please enter a valid country 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. 10745 Invalid Data This transaction cannot be processed. Please enter a valid country code in the shipping address.
API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10759 Gateway Decline This transaction cannot be processed. Please enter a valid credit card number and type. The transaction was declined by PayPal. Contact PayPal for more information. 10760 Invalid Configuration This transaction cannot be processed. The country listed for your business address is not currently supported.
A API Error Codes DirectPayment API Errors Error Code 208 Short Message Long Message Corrective Action 12001 Transaction is not compliant due to missing or invalid 3-D Secure authentication values. Transaction is not compliant due to missing or invalid 3-D Secure authentication values. Check ECI, ECI3DS, CAVV, XID fields. 15001 Gateway Decline This transaction cannot be processed.
API Error Codes SetExpressCheckout API Errors A SetExpressCheckout API Errors SetExpressCheckout API Errors Error Code Short Message Long Message 10001 ButtonSource value truncated. The transaction could not be loaded 10001 Internal Error Internal Error 10003 Missing argument. OtherPaymentMethodID is missing. 10003 Missing argument. OtherPaymentMethodLabel is missing. 10003 Missing argument. OtherPaymentMethodType is missing. 10003 Missing argument.
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 eBay buyer feedback overall positive count. 10004 Transaction refused because of an invalid argument. See additional error messages for details. Invalid eBay buyer feedback overall negative count. 10004 Transaction refused because of an invalid argument. See additional error messages for details.
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 total negative count. 10004 Transaction refused because of an invalid argument. See additional error messages for details. Invalid eBay seller feedback recent positive count. 10004 Transaction refused because of an invalid argument. See additional error messages for details.
A 212 API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message 10010 Invalid Invoice Non-ASCII invoice id is not supported. 10101 Option not supported. Express Checkout temporarily unavailable. Please try later. 10102 PaymentAction of Order Temporarily Unavailable PaymentAction of Order is temporarily unavailable. Please try later or use other PaymentAction. 10103 Please use another Solution Type. Your Solution Type is temporarily unavailable.
API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error... 10411 This Express Checkout session has expired. This Express Checkout session has expired. Token value is no longer valid. If you receive this error, you must return your buyer to PayPal to approve the use of PayPal again. Display an error message to inform the buyer that the transaction expired, and provide a button to return to PayPal.
A API Error Codes SetExpressCheckout API Errors Error Code 214 Short Message Long Message Correcting This Error... 10415 Transaction refused because of an invalid argument. See additional error messages for details. A successful transaction has already been completed for this token. PayPal allows a token only once for a successful transaction.
API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message 10432 Transaction refused because of an invalid argument. See additional error messages for details Invoice ID value exceeds maximum allowable length. 10433 Transaction refused because of an invalid argument. See additional error messages for details Value of Order Description has been truncated. 10434 Transaction refused because of an invalid argument.
A API Error Codes SetExpressCheckout API Errors Error Code 216 Short Message Long Message 10457 Error occurred in communicating to eBay eBay API creation error 10458 Error occurred in communicating to eBay eBay API unknown failure 10459 Error occurred in communicating to eBay eBay API failure 10460 Error occurred in communicating to eBay Parsing error 10461 Error occurred in communicating to eBay Item number invalid, removed, or unavailable 10462 Error occurred in communicating to eBay
API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message 10474 Invalid Data This transaction cannot be processed. The country code in the shipping address must match the buyer's country of residence 10475 Transaction refused because of an invalid argument.
A API Error Codes SetExpressCheckout API Errors Error Code 218 Short Message Long Message 10729 Shipping Address State Empty The field Shipping Address State is required 10730 Shipping Address Postal Code Empty The field Shipping Address Postal Code is required 10731 Shipping Address Country Empty The field Shipping Address Country is required 10736 Shipping Address Invalid City State Postal Code A match of the Shipping Address City, State, and Postal Code failed.
API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message 11802 Invalid Data You cannot pass both the new and deprecated Custom parameter. 11803 Invalid Data You cannot pass both the new and deprecated Invoice ID parameter. 11804 Invalid Data You cannot pass both the new and deprecated order description. 11805 Invalid Data You cannot pass both the new and deprecated order total or amount parameters.
A API Error Codes SetExpressCheckout API Errors Error Code 220 Short Message Long Message Invalid callback timeout The callback timeout is is zero; you must specify a longer timeout Line items missing Line items are required when specify a callback URL for flate rate shipping options Callback URL is too long The callback URL must not exceed 1,024 characters Multiple default shipping options specified You can only specify one default shipping option at a time No default shipping option specifie
API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message 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-rate shipping option 11830 Insurance amount is missing Insurance amount is missing; you have offered insurance but have not specified
A API Error Codes SetExpressCheckout API Errors Error Code 222 Short Message Long Message 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 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. 10410 Invalid token Invalid token. 10411 This Express Checkout session has expired. This Express Checkout session has expired.
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. Invalid item URL. 10004 Transaction refused because of an invalid argument. See additional error messages for details. SellerRegistrationDate is invalid. 10004 Transaction refused because of an invalid argument. See additional error messages for details. Invalid eBay seller feedback overall positive count.
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 payment hold risk. 10004 Transaction refused because of an invalid argument. See additional error messages for details. Multiple eBay order IDs not allowed.
API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message 10416 Transaction refused because of an invalid argument. See additional error messages for details. You have exceeded the maximum number of payment attempts for this token. 10417 Transaction cannot complete. The transaction cannot complete successfully. Instruct the customer to use an alternative payment method. 10418 Transaction refused because of an invalid argument.
A API Error Codes DoExpressCheckoutPayment API Errors Error Code 228 Short Message Long Message 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. 10431 Item amount is invalid. Item amount is invalid. 10432 Transaction refused because of an invalid argument.
API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message 10445 This transaction cannot be processed at this time. Please try again later. This transaction cannot be processed at this time. Please try again later. 10446 Unconfirmed email A confirmed email is required to make this API call. 10474 Invalid Data This transaction cannot be processed. The country code in the shipping address must match the buyer’s country of residence.
A API Error Codes DoExpressCheckoutPayment API Errors Error Code 230 Short Message Long Message 10728 Shipping Address City Empty The field Shipping Address City is required 10729 Shipping Address State Empty The field Shipping Address State is required 10730 Shipping Address Postal Code Empty The field Shipping Address Postal Code is required 10731 Shipping Address Country Empty The field Shipping Address Country is required 10736 Shipping Address Invalid City State Postal Code A match
API Error Codes DoExpressCheckoutPayment API Errors Error Code 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.
A 232 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.
API Error Codes Authorization and Capture API Errors A Authorization and Capture API Errors Authorization and Capture API Error Messages Error Code Short Message Long Message 10001 Internal Error Internal Error 10001 Internal Error Transaction failed due to internal error 10004 Internal Error Invalid argument 10007 Permission denied You do not have permissions to make this API call 10009 Transaction refused Account is locked or inactive 10010 Transaction refused because of an invalid ar
A 234 API Error Codes Authorization and Capture API Errors Error Code Short Message Returned By API Call... Correcting This Error... 10604 Authorization must include both buyer and seller. Authorization transaction cannot be unilateral. It must include both buyer and seller to make an auth. DoAuthorization Review the order to ensure customer and seller are both PayPal members. 10605 Unsupported currency. Currency is not supported.
API Error Codes Authorization and Capture API Errors Error Code Short Message Returned By API Call... Correcting This Error... 10615 Cannot reauth reauth. You can reauthorize only the original authorization, not a reauthorization. DoReauthorization Capture the reauthorization. 10616 Maximum number of reauthorization allowed for the auth is reached. Maximum number of reauthorization allowed for the auth is reached. DoReauthorization Capture or close the authorization.
A 236 API Error Codes Authorization and Capture API Errors Error Code Short Message Long Message Returned By API Call... Correcting This Error... 10625 Transaction refused because of an invalid argument. See additional error messages for details. The amount exceeds the maximum amount for a single transaction. DoAuthorization DoCapture DoReauthorization Reattempt the request with a lower amount. 10626 Risk Transaction refused due to risk model.
API Error Codes GetTransactionDetails API Errors A GetTransactionDetails API Errors GetTransactionDetails API Errors Error Code Short Message Long Message 10001 Internal Error Internal Error 10004 Transaction refused because of an invalid argument. See additional error messages for details. Store ID is required if Terminal ID is specified.
A API Error Codes TransactionSearch API Errors Error Code 238 Short Message Long Message 10004 Transaction refused because of an invalid argument. See additional error messages for details. Receipt id is not valid 10004 Transaction refused because of an invalid argument. See additional error messages for details. Payer email is invalid 10004 Transaction refused because of an invalid argument. See additional error messages for details.
API Error Codes RefundTransaction API Errors A RefundTransaction API Errors RefundTransaction API Errors Error Code Short Message Long Message 10001 Internal Error Internal Error 10001 Internal Error Warning an internal error has occurred. The transaction id may not be correct 10001 Internal Error The transaction could not be loaded. 10002 Restricted account Account is restricted. 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 Correcting This Error...
API Error Codes RefundTransaction API Errors Error Code Short Message Long Message 10009 Transaction refused The account for the counterparty is locked or inactive 10009 Transaction refused This transaction already has a chargeback filed 10009 Transaction refused You have not filled out the Direct Debit Instruction 10011 Invalid transaction id value Transaction refused because of an invalid transaction id value 10755 Unsupported currency Currency is not supported 11603 Conflict with prio
A API Error Codes MassPay API Errors MassPay API Errors MassPay API Errors 242 Error Code Short Message Long Message 10001 Invalid account number. The transaction failed as a result of an invalid credit card number. Check the number or attempt with another card. 10001 Internal Error Internal Error 10001 Internal Error The transaction could not be loaded 10001 ButtonSource value truncated. The transaction could not be loaded 10001 Transaction refused because of an invalid argument.
API Error Codes MassPay API Errors Error Code Short Message Long Message 10004 Transaction refused because of an invalid argument. See additional error messages for details. The amount is not a valid number 10004 Transaction refused because of an invalid argument. See additional error messages for details. The amount exceeds the max limit of a single mass pay item ~1 10004 Transaction refused because of an invalid argument. See additional error messages for details.
A API Error Codes Recurring Payments Errors Error Code Short Message Long Message 10311 Unable to submit payment Unable to submit payments for masspay 10312 Masspay server error The masspay server has reported errors 10313 Masspay Invalid Data The masspay input file includes invalid data 10314 Masspay input parse error The input to the masspay server is incorrect. Please make sure that you are using a correctly formatted input.
API Error Codes Recurring Payments Errors Error Code Short Message Long Message Additional Information 10004 Cart item calculation mismatch. Cart item calculation mismatch. The regular non-trial billing period amount is different than the sum of the amounts for each item in the cart. Scenario: When the regular nontrial billing period amount is different than the sum of the amounts for each item in the cart. 10004 Tax calculation mismatch. Tax calculation mismatch.
A 246 API Error Codes Recurring Payments Errors Error Code Short Message Long Message Additional Information 10511 Invalid Data This transaction cannot be processed. The merchant selected an value for the PaymentAction field that is not supported. 10512 Invalid Data This transaction cannot be processed. Please enter a first name. The first name of the buyer is required for this merchant. 10513 Invalid Data This transaction cannot be processed. Please enter a last name.
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. There was a problem with a particular field in the address.
A API Error Codes Recurring Payments Errors Error Code 248 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 tr
API Error Codes Recurring Payments Errors Error Code Short Message Long Message 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 payments feature is not currently available; try again later 11548 Invalid currency code Invalid currency c
A API Error Codes Recurring Payments Errors Error Code 250 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 increas
API Error Codes SetCustomerBillingAgreement Errors Error Code Short Message Long Message 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 13122 Transaction refused Transaction violates PayPal use 13701 Invalid Data Item Category value is invalid. Only Digital or Physical are allowed.
A API Error Codes SetCustomerBillingAgreement Errors Error Code 252 Short Message Long Message Additional Information 10436 Transaction refused because of an invalid argument. See additional error messages for details. PageStyle value exceeds maximum allowable length. PageStyle tag is too long. 10437 Transaction refused because of an invalid argument. See additional error messages for details. cpp-header-image value exceeds maximum allowable length.
API Error Codes GetBillingAgreementCustomerDetails Errors Error Code Short Message Long Message Additional Information 11453 Reference transactions temporarily unavailable. Reference transaction feature not currently available; try again later Feature not enabled because system is running in standin mode. Warning only.
A API Error Codes UpdateBillingAgreement Errors Error Code Short Message Long Message Additional Information 11455 Buyer did not accept billing agreement Buyer did not accept billing agreement Buyer has not agreed to the billing agreement. 11456 A successful Billing Agreement has already been created for this token. Transaction refused because of an invalid argument. See additional error messages for details. Token has already been used to create a billing agreement.
API Error Codes DoReferenceTransaction Errors Error Code Short Message Long Message 10211 Invalid billing agreement ID Invalid transaction or billing agreement ID; could not find Billing Agreement in database 11451 Billing Agreement Id or transaction Id is not valid Billing Agreement Id or transaction Id is not valid ReferenceID field is empty.
A API Error Codes DoReferenceTransaction Errors Error Code Short Message Long Message 10004 Transaction refused because of an invalid argument. See additional error messages for details. Invalid payment type argument 10009 Transaction refused The account for the counterparty is locked or inactive Merchant is locked/close/restricted. 10010 Invalid Invoice Non-ASCII invoice id is not supported Non-ASCII characters are used in InvoiceID field.
API Error Codes DoReferenceTransaction Errors Error Code Short Message Long Message Additional Information 10400 Transaction refused because of an invalid argument. See additional error messages for details. Order total is missing. TotalOrder amount is missing. 10401 Transaction refused because of an invalid argument. See additional error messages for details. Order total is invalid. TotalOrder amount is invalid. 10402 Authorization only is not allowed for merchant.
A API Error Codes DoReferenceTransaction Errors Error Code 258 Short Message Long Message Additional Information 10426 Transaction refused because of an invalid argument. See additional error messages for details. Item total is invalid. ItemTotal amount is invalid. 10427 Transaction refused because of an invalid argument. See additional error messages for details. Shipping total is invalid. ShippingTotal amount is invalid. 10428 Transaction refused because of an invalid argument.
API Error Codes DoReferenceTransaction Errors Error Code Short Message Long Message Additional Information 10441 Transaction refused because of an invalid argument. See additional error messages for details. The NotifyURL element value exceeds maximum allowable length. NotifyURL field is too long; maximum length for notify URL is 2048. 10442 ButtonSource value truncated. The ButtonSource element value exceeds maximum allowable length. ButtonSource field is too long; maximum length is 32.
A API Error Codes DoReferenceTransaction Errors Error Code 260 Short Message Long Message Additional Information 10725 Shipping Address Country Error There was an error in the Shipping Address Country field Shipping address error in country field. 10727 Shipping Address1 Empty The field Shipping Address1 is required Shipping address error in address1 field. 10728 Shipping Address City Empty The field Shipping Address City is required Shipping address error in city field.
API Error Codes DoReferenceTransaction Errors Error Code Short Message Long Message Additional Information 11451 Billing Agreement Id or transaction Id is not valid Billing Agreement Id or transaction Id is not valid Reference transaction is not associated with a billing agreement. 11451 Billing Agreement Id or transaction Id is not valid Billing Agreement Id or transaction Id is not valid Reference id either not found or could not be decrypted.
A API Error Codes AddressVerify API Errors AddressVerify API Errors AddressVerify API Errors Error Code Short Message Long Message 10004 Transaction refused because of an invalid argument. See additional error messages for details. Invalid email format. 10004 Transaction refused because of an invalid argument. See additional error messages for details. Invalid street format 10004 Transaction refused because of an invalid argument. See additional error messages for details.
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.
B 264 Countries and Regions Supported by PayPal Country or Region Country or Region Code 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 CHRISTMAS ISLAND * CX * COCOS (KEELING) ISLANDS CC COLOMBIA CO COOK ISLANDS CK COSTA RICA CR CYPRUS CY CZECH REPUBLIC CZ DENMARK DK DJIBOUTI DJ DOMINICA
Countries and Regions Supported by PayPal Country or Region Country or Region Code 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 HONDURAS HN HONG KONG HK HUNGARY HU ICELAND IS INDIA IN INDONESIA ID I
B 266 Countries and Regions Supported by PayPal Country or Region Country or Region Code 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 MICRONESIA, FEDERATED STATES OF FM MOLDOVA, REPUBLI
Countries and Regions Supported by PayPal Country or Region Country or Region Code 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 PT PUERTO RICO PR QATAR QA REUNION RE ROMANIA RO
B 268 Countries and Regions Supported by PayPal Country or Region Country or Region Code 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 SOUTH SANDWICH ISLANDS GS SPAIN ES SURINAME SR SVALBARD AND
Countries and Regions Supported by PayPal Country or Region Country or Region Code 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 270 Countries and Regions Supported by PayPal August 2012 Name-Value Pair API Developer Guide
C State and Province Codes Canadian Province or U.S.
C 272 State and Province Codes Canadian Province or U.S.
State and Province Codes Canadian Province or U.S.
C 274 State and Province Codes August 2012 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 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.
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 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. All information matched 1 None of 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 280 AVS and CVV2 Response Codes CVV2 Response Codes August 2012 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 92.0 Updated for 92.0. Added new MsgSubID field for the following APIs for both requests and responsees: RefundTransaction; DoReferenceTransaction; DoAuthorization; and DoCapture. What’s New in Version 89.0 Updated for 89.0.
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. It is one of the following values: instant delayed This field is available since version 84.0. PENDINGREASON Reason that the payment is delayed. It is one of the following values: none – The refund is instant.
What’s New in Version 82.0 What’s New in Version 82.0 New Field in DoCapture Request Field Description MERCHANTSTOREDETAILS (Optional) Information about the merchant store. This field is available since version 82.0. New MerchantStoreDetailsType in DoCapture Request Field Description STOREID ID of the merchant store. This field is required for point-of-sale transactions. Character length and limitations: 50 single-byte characters This field is available since version 84.0.
What’s New in Version 82.0 Field Description REFUNDSOURCE (Optional)Type of PayPal funding source (balance or eCheck) that can be used for auto refund. It is one of the following values: any – The merchant does not have a preference. Use any available funding source. default – Use the merchant’s preferred funding source, as configured in the merchant’s profile. instant – Use the merchant’s balance as the funding source. eCheck – The merchant prefers using the eCheck funding source.
What’s New in Version 80.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. 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.
What’s New in Version 72.0 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. 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. TAXID New field The buyer’s tax ID. This field is required for Brazil and used for Brazil only.
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.
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.
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).
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). Character length and limitations: 127 single-byte characters L_NAMEn is deprecated since version 63.0.
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.
What’s New in Version 66 292 August 2012 Name-Value Pair API Developer Guide
Revision History Date Description 10 August 2012 Maintenance release. Added CVV2 response codes E and I for Visa, Mastercard, Discover and American Express. 7 August 2012 Maintenance release. New 10486 error code added for redirects when the process declines the transaction: The transaction couldn’t be completed. Please redirect your customer to PayPal. 10 July 2012 Updated for 92.0.
Date Description 11 May 2010 Updated for 63.0. Added new NVP API fields to use in version 63.0 Express Checkout integrations. Deprecated old fields. Updated billing agreement API with functionality to obtain the latest billing address and to skip billing agreement creation. Added ReverseTransaction API. 10 March 2010 Updated information for 62.0: Describes Express Checkout fields recommended to be used in applications that enable implementing parallel payments for a marketplace.
Date Description April 2007 Added Recurring Payments APIs: SetCustomerBillingAgreement, GetBillingAgreementCustomerDetails, and CreateRecurringPaymentsProfile. February 2007 Bug fixes including updating Line Item Details for Direct Payment and Express Checkout APIs, changing some parameters to optional in DoDirectPayment, adding SHIPTOCOUNTRYCODE, and adding Switch/Solo codes for AVS and CVV2. December 2006 Updates for bug fixes. October 2006 First public release.
August 2012 Name-Value Pair API Developer Guide
Index Numerics 3-D Secure request fields 47 3D Secure response fields 50 A ACCT request field 42, 52, 142, 160, 177, 190 ACCT response field 152 ACTION request field 133, 154 Activation Details request fields 141 ADDITIONALBILLINGCYCLES request field 156 Address request fields 43, 53, 143, 160, 178 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, 167 AddressVerify API ope
Index BUYERID request field 75 BUYERID response field 131 BUYERMARKETINGEMAIL request field 93 BUYERMARKETINGEMAIL response field 80, 122 BUYERREGISTRATIONDATE request field 76 BUYERUSERNAME request field 76 C CAD 275, 276 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 275, 276 CANCELURL request field 60, 162
Index DoCapture request message 27 DoCapture response message 29 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 DoReauthorizatio
Index INVNUM response field 79, 86, 129 IPADDRESS request field 41, 171 Israeli Sheqel 275 ISSUENUMBER request field 42, 52, 142, 160, 177 ISSUENUMBER response field 152 ITE MAMT request field 44 ITEMAMT request field 67, 95, 173, 289 ITEMAMT response field 83 GetRecurringPaymentsProfileDetails request message 146 GetRecurringPaymentsProfileDetails response message 146 GetTransactionDetails API operation 121 GetTransactionDetails request message 121 GetTransactionDetails response message 121 GIFTMESSAGE r
Index L_EBAYITEMORDERIDn request field 47, 75, 103, 176 L_EBAYITEMTXNID response field 130 L_EMAILn response field 192 L_FEEAMTn response field 192 L_FMFfilterIDn response field 49, 106, 114, 179 L_FMFfilterNAM E n response field 114 L_FMFfilterNAMEn response field 49, 106, 179 L_INSURANCEAMOUNT response field 59 L_ITEMCATEGORYn 175, 288 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_ITEMLEN
Index L_PAYMENTREQUEST_n_ITEMWIDTHUNITm request field 73, 102 L_PAYMENTREQUEST_n_ITEMWIDTHUNITm response field 89 L_PAYMENTREQUEST_n_ITEMWIDTHVALUEm request field 73, 102 L_PAYMENTREQUEST_n_ITEMWIDTHVALUEm response field 89 L_PAYMENTREQUEST_n_NAMEm request field 71, 100, 144, 287, 290 L_PAYMENTREQUEST_n_NAMEm response field 87 L_PAYMENTREQUEST_n_NU MBERm response field 88 L_PAYMENTREQUEST_n_NUMBERm request field 72, 101, 145, 287 L_PAYMENTREQUEST_n_QTYm request field 72, 101, 145, 288, 290 L_PAYMENTREQUEST
Index MSGSUBID request field 28, 29, 33, 172, 179, 186, 188 MULTIITEM response field 131 MXN 275 MYR 275 N NETAMT request field 51 NETREFUNDAMT response field 187 New Zealand Dollar 275, 276 NEXTBILLINGDATE response field 151 NO_SHIPPING_OPTION_DETAILS response field 59 NOK 275, 276 Norwegian Krone 275, 276 NOSHIPPING request field 61 NOTE request field 28, 39, 52, 154, 155, 156 NOTE response field 79, 105, 129 NOTETEXT request field 70, 97 NOTETEXT response field 86 NOTETOBUYER request field 65 NOTIFY UR
Index PAYMENTINFO_n_TRANSACTIONID response field 108, 109 PAYMENTINFO_n_TRANSACTIONTYPE response field 108 PaymentItemType response fields 130 PaymentPeriod.
Index PAYMENTREQUEST_n_SHIPTOSTATE request field 66, 99 PAYMENTREQUEST_n_SHIPTOSTATE response field 82 PAYMENTREQUEST_n_SHIPTOSTREET request field 66, 99 PAYMENTREQUEST_n_SHIPTOSTREET response field 81 PAYMENTREQUEST_n_SHIPTOSTREET2 request field 66, 99 PAYMENTREQUEST_n_SHIPTOSTREET2 response field 81 PAYMENTREQUEST_n_SHIPTOZIP request field 66, 99 PAYMENTREQUEST_n_SHIPTOZIP response field 82 PAYMENTREQUEST_n_SHORTMESSAGE response field 91, 115 PAYMENTREQUEST_n_SOFTDESCRIPTOR request field 97 PAYMENTREQUES
Index REGULARBILLINGFREQUENCY response field 149 REGULARBILLINGPERIOD response field 149 REGULARCURRENCYCODE response field 151 REGULARSHIPPINGAMT response field 150 REGULARTAXAMT response field 151 REGULARTOTALBILLINGCYCLES response field 149 REQCONFIRMSHIPPING request field 60, 171 RET URNURL request field 60 RETRYUNTIL request field 186 RETURNALLCURRENCIES request field 117 RETURNFMFDETAILS request field 41, 93, 171 RETURNURL request field 162 S SALESTAX response field 129 SALUTATION request field 53,
Index STREET request field 25, 43, 53, 143, 160, 178 STREET2 request field 43, 53, 143, 160, 178 STREETMATCH response field 26 SUBSCRIBERNAME request field 138, 156 SUBSCRIBERNAME response field 147 Subscription Terms response fields 131 SUCCESSPAGEREDIRECTREQUESTED response field 106 SUFFIX request field 53, 143, 191 SUFFIX response field 81, 124, 167, 170 SURVEYCHOICESELECTED request field 93 SURVEYCHOICESELECTED response field 80, 123 SURVEYENABLE request field 65 SURVEYQUESTION request field 65, 93 SUR
Index 308 August 2012 Name-Value Pair API Developer Guide
