2009
Table Of Contents
- Name-Value Pair API Developer Guide
- Preface
- This Document
- Intended Audience
- Revision History
- PayPal NVP API Overview
- Authorization and Capture API Operation Reference
- DoDirectPayment API
- Express Checkout API Operations
- GetTransactionDetails API
- MassPay API
- RefundTransaction API
- TransactionSearch API
- Recurring Payments and Reference Transactions API Operations
- DoNonReferencedCredit API
- ManagePendingTransactionStatu s API
- GetBalance API
- AddressVerify API
- API Error Codes
- General API Errors
- Validation Errors
- Direct Payment API Errors
- SetExpressCheckout API Errors
- GetExpressCheckoutDetails API Errors
- DoExpressCheckoutPayment API Errors
- Authorization and Capture API Errors
- GetTransactionDetails API Errors
- TransactionSearch API Errors
- RefundTransaction API Errors
- Mass Pay API Errors
- Recurring Payments Errors
- SetCustomerBillingAgreement Errors
- GetBillingAgreementCustomerDetails Errors
- CreateBillingAgreement Errors
- UpdateBillingAgreement Errors
- DoReferenceTransaction Errors
- AddressVerify API Errors
- ManagePendingTransactionStatus API Errors
- Country Codes
- State and Province Codes
- Currency Codes
- AVS and CVV2 Response Codes
Express Checkout API Operations
SetExpressCheckout API
44 08 April 2009 Name-Value Pair API Developer Guide
SetExpressCheckout Request Fields
Field Description
METHOD (Required) Must be SetExpressCheckout.
TOKEN (Optional) A timestamped token, the value of which was returned by
SetExpressCheckout response.
Character length and limitations: 20 single-byte characters
MAXAMT (Optional) The expected maximum total amount of the complete order, including
shipping cost and tax charges.
If the transaction does not include a one-time purchase, this field is ignored.
Limitations: Must not exceed $10,000 USD in any currency. No currency symbol.
Must have two decimal places, decimal separator must be a period (.), and the
optional thousands separator must be a comma (,).
RETURNURL (Required) URL to which the customer’s browser is returned after choosing to pay
with PayPal.
NOTE: PayPal recommends that the value be the final review page on which the
customer confirms the order and payment or billing agreement.
Character length and limitations: 2048 characters
CANCELURL (Required) URL to which the customer is returned if he does not approve the use of
PayPal to pay you.
NOTE: PayPal recommends that the value be the original page on which the
customer chose to pay with PayPal or establish a billing agreement.
Character length and limitations: 2048 characters
CALLBACKURL (Optional) URL to which the callback request from PayPal is sent. It must start with
HTTPS for production integration. It can start with HTTPS or HTTP for sandbox
testing.
Character length and limitations: 1024 characters
CALLBACKURL (Optional) An override for you to request more or less time to be able to process the
callback request and respond. The acceptable range for the override is 1 to 6 seconds.
If you specify a value greater than 6, PayPal uses the default value of 3 seconds.
Character length and limitations: An integer between 1 and 6
REQCONFIRMSHIPPING (Optional) The value 1 indicates that you require that the customer’s shipping address
on file with PayPal be a confirmed address.
NOTE: Setting this field overrides the setting you have specified in your Merchant
Account Profile.
Character length and limitations: One single-byte numeric character.
Allowable values: 0, 1
NOSHIPPING (Optional) The value 1 indicates that on the PayPal pages, no shipping address fields
should be displayed whatsoever.
Character length and limitations: One single-byte numeric character.
Allowable values: 0, 1