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
DoDirectPayment API
DoDirectPayment Request
32 08 April 2009 Name-Value Pair API Developer Guide
Payment Details Type Fields
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.
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