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
Name-Value Pair API Developer Guide 08 April 2009 49
Express Checkout API Operations
SetExpressCheckout API
SHIPPINGAMT (Optional) Total shipping costs for this order.
NOTE: 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.
NOTE: If you specify a value for SHIPPINGAMT, you must also specify a value for
ITEMAMT.
INSURANCEAMT (Optional) Total shipping insurance costs for this order. The value must be a non-
negative currency amount or null if insurance options are offered.
NOTE: 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.
SHIPPINGDISCOUNT (Optional) Shipping discount for this order, specified as a negative number.
NOTE: 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.
INSURANCEOPTIONOFFE
RED
(Optional) If true, the Insurance drop-down on the PayPal Review page displays the
string ‘Yes’ and the insurance amount. If true, the total shipping insurance for this
order must be a positive number.
Character length and limitations: true or false
HANDLINGAMT (Optional) Total handling costs for this order.
NOTE: 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.
NOTE: If you specify a value for HANDLINGAMT, you must also specify a value for
ITEMAMT.
TAXAMT (Optional) Sum of tax for all items in this order.
NOTE: 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.
NOTE: TAXAMT is required if you specify L_TAXAMTn
DESC (Optional) Description of items the customer is purchasing.
Character length and limitations: 127 single-byte alphanumeric characters
CUSTOM (Optional) A free-form field for your own use.
Character length and limitations: 256 single-byte alphanumeric characters
Field Description