2012
Table Of Contents
- Name-Value Pair API Developer Guide
- Contents
- What’s New
- Preface
- PayPal Name-Value Pair API Basics
- AddressVerify API Operation
- Authorization and Capture API Operation Reference
- DoDirectPayment API Operation
- DoNonReferencedCredit API Operation
- ExpressCheckout API Operations
- GetBalance API Operation
- GetPalDetails API Operation
- GetTransactionDetails API Operation
- ManagePendingTransactionStatus API Operation
- MassPay API Operation
- Recurring Payments and Reference Transactions API Operations
- CreateRecurringPaymentsProfile API Operation
- GetRecurringPaymentsProfileDetails API Operation
- ManageRecurringPaymentsProfileStatus API Operation
- BillOutstandingAmount API Operation
- UpdateRecurringPaymentsProfile API Operation
- CreateBillingAgreement API Operation
- SetCustomerBillingAgreement API Operation
- GetBillingAgreementCustomerDetails API Operation
- BAUpdate API Operation
- DoReferenceTransaction API Operation
- RefundTransaction API Operation
- TransactionSearch API Operation
- API Error Codes
- General API Errors
- Validation Errors
- DirectPayment 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
- MassPay API Errors
- Recurring Payments Errors
- SetCustomerBillingAgreement Errors
- GetBillingAgreementCustomerDetails Errors
- CreateBillingAgreement Errors
- UpdateBillingAgreement Errors
- DoReferenceTransaction Errors
- AddressVerify API Errors
- ManagePendingTransactionStatus API Errors
- Countries and Regions Supported by PayPal
- State and Province Codes
- Currency Codes
- AVS and CVV2 Response Codes
- About Previous Versions of the API
- Revision History
- Index
ExpressCheckout API Operations
DoExpressCheckoutPayment API Operation
6
110 August 2012 Name-Value Pair API Developer Guide
PAYMENTINFO_n_EXCHA
NGERATE
EXCHANGERATE
(deprecated)
Exchange rate if a currency conversion occurred. Relevant only if your are billing in
their non-primary currency. If the buyer chooses to pay with a currency other than the
non-primary currency, the conversion occurs in the buyer’s account.
Exchange rate if a currency conversion occurred. Relevant only if your are billing in
their non-primary currency. If the buyer chooses to pay with a currency other than the
non-primary currency, the conversion occurs in the buyer’s account. You can specify
up to 10 payments, where
n is a digit between 0 and 9, inclusive.
Character length and limitations: Decimal value that does not exceed 17 characters,
including decimal point
EXCHANGERATE is deprecated since version 63.0. Use
PAYMENTINFO_0_EXCHANGERATE instead.
PAYMENTINFO_
n_PAYME
NTSTATUS
PAYMENTSTATUS
(deprecated)
The status of the payment. It is one of the following values:
The status of the payment. You can specify up to 10 payments, where
n is a digit
between 0 and 9, inclusive. It is one of the following values:
None – No status.
Canceled-Reversal – A reversal has been canceled; for example, when you
win a dispute and the funds for the reversal have been returned to you.
Completed – The payment has been completed, and the funds have been added
successfully to your account balance.
Denied – You denied the payment. This happens only if the payment was
previously pending because of possible reasons described for the
PendingReason element.
Expired – the authorization period for this payment has been reached.
Failed – The payment has failed. This happens only if the payment was made
from your buyer’s bank account.
In-Progress – The transaction has not terminated, e.g. an authorization may be
awaiting completion.
Partially-Refunded – The payment has been partially refunded.
Pending – The payment is pending. See the PendingReason field for more
information.
Refunded – You refunded the payment.
Reversed – A payment was reversed due to a chargeback or other type of
reversal. The funds have been removed from your account balance and returned to
the buyer. The reason for the reversal is specified in the ReasonCode element.
Processed – A payment has been accepted.
Voided – An authorization for this transaction has been voided.
Completed-Funds-Held – The payment has been completed, and the funds
have been added successfully to your pending balance.
See the PAYMENTINFO_
n_HOLDDECISION field for more information.
See the HoldDecision field for more information.
PAYMENTSTATUS is deprecated since version 63.0. Use
PAYMENTINFO_0_PAYMENTSTATUS instead.
Field Description