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
Express Checkout API Operations
SetExpressCheckout API
46 08 April 2009 Name-Value Pair API Developer Guide
HDRBACKCOLOR (Optional) Sets the background color for the header of the payment page. By default,
the color is white.
Character length and limitation: Six character HTML hexadecimal color code in
ASCII.
PAYFLOWCOLOR (Optional) Sets the background color for the payment page. By default, the color is
white.
Character length and limitation: Six character HTML hexadecimal color code in
ASCII.
PAYMENTACTION (Optional) How you want to obtain payment:
z Sale indicates that this is a final sale for which you are requesting payment.
(Default)
z Authorization indicates that this payment is a basic authorization subject to
settlement with PayPal Authorization & Capture.
z Order indicates that this payment is an order authorization subject to settlement
with PayPal Authorization & Capture.
If the transaction does not include a one-time purchase, this field is ignored.
NOTE: You cannot set this value to Sale in SetExpressCheckout request and then
change this value to Authorization or Order on the final API
DoExpressCheckoutPayment request. If the value is set to
Authorization or Order in SetExpressCheckout, the value may be set
to Sale or the same value (either Authorization or Order) in
DoExpressCheckoutPayment.
Character length and limit: Up to 13 single-byte alphabetic characters
Default value: Sale
EMAIL (Optional) Email address of the buyer as entered during checkout. PayPal uses this
value to pre-fill the PayPal membership sign-up portion of the PayPal login page.
Character length and limit: 127 single-byte alphanumeric characters
SOLUTIONTYPE (Optional) Type of checkout flow:
z Sole: Express Checkout for auctions
z Mark: Normal Express Checkout
LANDINGPAGE (Optional) Type of PayPal page to display:
z Billing: non-PayPal account
z Login: PayPal account login
CHANNELTYPE (Optional) Type of channel:
z Merchant: non-auction seller
z eBayItem: eBay auction
GIROPAYSUCCESSURL (Optional) The URL on the merchant site to redirect to after a successful giropay
payment.
Use this field only if you are using giropay or bank transfer payment methods in
Germany.
Field Description