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
Name-Value Pair API Developer Guide August 2012 115
ExpressCheckout API Operations
DoExpressCheckoutPayment API Operation
6
Payment Error Type Fields
UserSelectedOptions Fields
Field Description
PAYMENTREQUEST_
n_SH
ORTMESSAGE
xs:string
Payment error short message. You can specify up to 10 payments, where
n is a digit
between 0 and 9, inclusive.
PAYMENTREQUEST_
n_LO
NGMESSAGE
xs:string
Payment error long message. You can specify up to 10 payments, where
n is a digit
between 0 and 9, inclusive.
PAYMENTREQUEST_
n_ER
RORCODE
xs:string
Payment error code. You can specify up to 10 payments, where
n is a digit between 0
and 9, inclusive.
PAYMENTREQUEST_
n_SE
VERITYCODE
xs:string
Payment error severity code. You can specify up to 10 payments, where
n is a digit
between 0 and 9, inclusive.
PAYMENTREQUEST_
n_AC
K
xs:string
Application-specific error values indicating more about the error condition. You can
specify up to 10 payments, where
n is a digit between 0 and 9, inclusive.
Field Description
SHIPPINGCALCULATIONM
ODE
Describes how the options that were presented to the buyer were determined. It is
one of the following values:
API - Callback
API - Flatrate
INSURANCEOPTIONSELEC
TED
The option that the buyer chose for insurance. It is one of the following values:
Yes – The buyer opted for insurance.
No – The buyer did not opt for insurance.
SHIPPINGOPTIONISDEFA
ULT
Indicates whether the buyer chose the default shipping option. It is one of the
following values:
true – The buyer chose the default shipping option.
false – The buyer did not choose the default shipping option.
Character length and limitations: true or false
SHIPPINGOPTIONAMOUNT The shipping amount that the buyer chose.
Character length and limitations: Value is a positive number which cannot exceed
$10,000 USD in any currency. It includes no currency symbol. It must have 2
decimal places, the decimal separator must be a period (.), and the optional
thousands separator must be a comma (,).
SHIPPINGOPTIONNAME The name of the shipping option, such as air or ground.