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 21
Authorization and Capture API Operation Reference
DoCapture API
DoCapture Response
z DoCapture Response Fields
z Payer Information Fields
z Ship To Address Fields
z Payer Name Fields
SOFTDESCRIPTOR (Optional) The soft descriptor is a per transaction description of the payment that is
passed to the consumer’s credit card statement.
If a value for the soft descriptor field is provided, the full descriptor displayed on the
customer’s statement has the following format:
<PP * | PAYPAL *><Merchant descriptor as set in the Payment
Receiving Preferences><1 space><soft descriptor>
The soft descriptor can contain only the following characters:
z Alphanumeric characters
z - (dash)
z * (asterisk)
z . (period)
z {space}
If you use any other characters (such as “,”), an error code is returned.
The soft descriptor does not include the phone number, which can be toggled between
the merchant’s customer service number and PayPal’s customer service number.
The maximum length of the total soft descriptor is 22 characters. Of this, either 4 or 8
characters are used by the PayPal prefix shown in the data format. Thus, the
maximum length of the soft descriptor passed in the API request is:
22 - len(<PP * | PAYPAL *>) - len(<Descriptor set in Payment
Receiving Preferences> + 1)
For example, assume the following conditions:
z The PayPal prefix toggle is set to PAYPAL * in PayPal’s admin tools.
z The merchant descriptor set in the Payment Receiving Preferences is set to EBAY.
z The soft descriptor is passed in as JanesFlowerGifts LLC.
The resulting descriptor string on the credit card would be:
PAYPAL *EBAY JanesFlow
Field Description