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 145
Recurring Payments and Reference Transactions API Operations
DoReferenceTransaction API
PAYMENTTYPE Indicates whether the payment is instant or delayed.
Character length and limitations: Seven single-byte characters
Valid values:
z none
z echeck
z instant
ORDERTIME Time/date stamp of payment
AMT The final amount charged, including any shipping and taxes from your Merchant
Profile.
Character length and limitations: Does not exceed $10,000 USD in any currency. No
currency symbol. Regardless of currency, decimal separator is a period (.), and the
optional thousands separator is a comma (,). Equivalent to nine characters maximum
for USD.
CURRENCYCODE (Optional) A three-character currency code. Default: USD.
FEEAMT PayPal fee amount charged for the transactionCharacter length and limitations: Does
not exceed $10,000 USD in any currency. No currency symbol. Regardless of
currency, decimal separator is a period (.), and the optional thousands separator is a
comma (,). Equivalent to nine characters maximum for USD.
SETTLEAMT Amount deposited in your PayPal account after a currency conversion.
TAXAMT Tax charged on the transaction.
Character length and limitations: Does not exceed $10,000 USD in any currency. No
currency symbol. Regardless of currency, decimal separator is a period (.), and the
optional thousands separator is a comma (,). Equivalent to nine characters maximum
for USD.
EXCHANGERATE Exchange rate if a currency conversion occurred. Relevant only if your are billing in
their non-primary currency. If the customer chooses to pay with a currency other than
the non-primary currency, the conversion occurs in the customer’s account.Character
length and limitations: a decimal that does not exceed 17 characters, including
decimal point
PAYMENTSTATUS Status of the payment:Completed: The payment has been completed, and the funds
have been added successfully to your account balance.
Pending: The payment is pending. See the PendingReason element for more
information.
Field Description