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
48 08 April 2009 Name-Value Pair API Developer Guide
Address Fields
Payment Details Type Fields
Field Description
NAME Person’s name associated with this shipping address. Required if using a
shipping address.
Character length and limitations: 32 single-byte characters.
SHIPTOSTREET First street address. 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. Required if using a shipping address.
Character length and limitations: 40 single-byte characters.
SHIPTOSTATE State or province. Required if using a shipping address.
Character length and limitations: 40 single-byte characters.
SHIPTOZIP U.S. ZIP code or other country-specific postal code. 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. Required if using a shipping address.
Character limit: 2 single-byte characters.
PHONENUM (Optional) Phone number.
Character length and limit: 20 single-byte characters.
Field Description
AMT (Required) The total cost of the transaction to the customer. If shipping cost and tax
charges are known, include them in this value; if not, this value should be the current
sub-total of the order.
If the transaction includes one or more one-time purchases, this field must be equal to
the sum of the purchases.
Set this field to 0 if the transaction does not include a one-time purchase; for example,
when you set up a billing agreement for a recurring payment that is not immediately
charged.
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 (,).
CURRENCYCODE (Optional) A three-character currency code. Default: USD.
ITEMAMT (Optional) Sum of cost of all items in this order.
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 (,).
NOTE: ITEMAMT is required if you specify L_AMTn.