Express Checkout API

The Express Checkout API is the Website Payments Pro alternative to standard PayPal shopping cart processing.

IMPORTANT:

For a full understanding of the complete details about how to use Express Checkout, consult the PayPal Express Checkout Integration Guide.

The Express Checkout API consists of three distinct SOAP requests that you make at the three integration points during a customer checkout. The customer is also redirected to PayPal. Here is the sequence of steps:

1.	SetExpressCheckout

2.	Redirect the customer’s browser to the PayPal Login page

3.	GetExpressCheckoutDetails

4.	DoExpressCheckoutPayment

IMPORTANT:

All currency amount fields in the three Express Checkout APIs require that the currencyID attribute be set to one of the supported currency codes. For any one particular buyer’s checkout session, do not mix currencies either in any single SOAP request or across SOAP requests. For example, do not set currencyID to USD in one request and then to GBP in a later request for the same buyer.

Express Checkout for eBay Auctions

You can use also use Express Checkout to check out for eBay auctions. You can mix eBay and non-eBay transactions in the same transaction.

If the buyer’s checkout includes eBay auctions, there are additional fields that you must set to control the behavior of Express Checkout.

In the SetExpressCheckout request:

l	PaymentAction must be Sale

l	ChannelType must be eBayItem

For eBay auctions, you cannot set PaymentAction to Authorization or Order. You must set PaymentAction to Sale.

In the DoExpressCheckoutPayment request, you must set PaymentAction to Sale. You must also provide line item details for each eBay auction so that the payment is properly reflected in My eBay and qualifies for PayPal Buyer Protection.

For each ebayItemPaymentDetailsItem line item, you must provide the following:

ItemNumber and AuctionTransactionID

or

OrderID

To properly reflect discounts, you can also supply negative line items. Note that the value that you supply for Amount must equal the total of the line item amounts that you supply.

SetExpressCheckout

SetExpressCheckout indicates to PayPal that you are using Express Checkout to obtain payment from your customer.

IMPORTANT:

To use SetExpressCheckout for recurring payments, you must set the version parameter to 50.0 in your API calls.

Diagram of Set ExpressCheckout Types

The following diagram represents the composition of the SetExpressCheckoutRequestType and SetExpressCheckoutResponseType elements. Elements required in the request are indicated with an asterisk.

Figure 5.1

SetExpressCheckout Types

SetExpressCheckoutRequest

Request to use PayPal Express Checkout to obtain payment.

IMPORTANT:

Any fields in the WSDL or XSD files that are not described here are ignored. For example, do not set CountryName.

IMPORTANT:

To use SetExpressCheckout for recurring payments, you must set the version parameter to 50.0 in your API calls.

 

Table 5.1

SetExpressCheckoutRequest Fields

Field	Data Type/Description	Required
Token	ebl:ExpressCheckoutTokenType A timestamped token, the value of which was returned by SetExpressCheckout response. Character length and limitations: 20 single-byte characters	No
OrderTotal	cc:BasicAmountType The total cost of the transaction to the customer. If shipping cost and tax charges are known, include them in this value; if not, this value should be the current sub-total of the order. If the transaction includes one or more one-time purchases, this field must be equal to the sum of the purchases. If the transaction does not include a one-time purchase, this field can be set to 0. Limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Must have two decimal places, decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Note: You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.	Yes
MaxAmount	cc:BasicAmountType The expected maximum total amount of the complete order, including shipping cost and tax charges. If the transaction does not include a one-time purchase, this field is ignored. Limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Must have two decimal places, decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Note: You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.	No
OrderDescription	xs:string Description of items the customer is purchasing. Character length and limitations: 127 single-byte alphanumeric characters	No
Custom	xs:string A free-form field for your own use, such as a tracking number or other value you want PayPal to return on GetExpressCheckoutDetails response and response. Character length and limitations: 256 single-byte alphanumeric characters	No
InvoiceID	xs:string Your own unique invoice or tracking number. PayPal returns this value to you on response. If the transaction does not include a one-time purchase, this field is ignored. Character length and limitations: 127 single-byte alphanumeric characters	No
ReturnURL	xs:string URL to which the customer’s browser is returned after choosing to pay with PayPal. Note: PayPal recommends that the value be the final review page on which the customer confirms the order and payment or billing agreement. Character length and limitations: no limit.	Yes
CancelURL	xs:string URL to which the customer is returned if he does not approve the use of PayPal to pay you. Note: PayPal recommends that the value be the original page on which the customer chose to pay with PayPal or establish a billing agreement. Character length and limitations: no limit	Yes
Address	ebl:AddressType Customer’s shipping address. See Table 5.2, “Address (Shipping Address): AddressType Elements”. If you include a shipping address and set the AddressOverride element on the request, PayPal returns this same address in GetExpressCheckoutDetailsResponse.	No
ReqConfirmShipping	xs:string The value 1 indicates that you require that the customer’s shipping address on file with PayPal be a confirmed address. Note: Setting this field overrides the setting you have specified in your Merchant Account Profile. Character length and limitations: One single-byte numeric character. Allowable values: 0, 1	No
NoShipping	xs:string The value 1 indicates that on the PayPal pages, no shipping address fields should be displayed whatsoever. Character length and limitations: One single-byte numeric character. Allowable values: 0, 1	No
AddressOverride	xs:string The value 1 indicates that the PayPal pages should display the shipping address set by you in this SetExpressCheckout request, not the shipping address on file with PayPal for this customer. Displaying the PayPal street address on file does not allow the customer to edit that address. Character length and limitations: One single-byte numeric character. Allowable values: 0, 1	No
LocaleCode	xs:string Locale of pages displayed by PayPal during Express Checkout. Character length and limitations: Any two-character country code. The following two-character country codes are supported by PayPal: l AT l AU l BE l CA l CH l CN l DE l ES l FR l GB l IT l NL l PL l US Any other value will default to US. For the list of country codes, see Appendix F, “Country Codes.”	No
PageStyle	xs:string Sets the Custom Payment Page Style for payment pages associated with this button/link. This value corresponds to the HTML variable page_style for customizing payment pages. The value is the same as the Page Style Name you chose when adding or editing the page style from the Profile subtab of the My Account tab of your PayPal account. Character length and limitations: 30 single-byte alphabetic characters.	No
cpp-header-image	xs:string URL for the image you want to appear at the top left of the payment page. The image has a maximum size of 750 pixels wide by 90 pixels high. PayPal recommends that you provide an image that is stored on a secure (https) server. If you do not specify an image, the business name is displayed. Character length and limit: 127 single-byte alphanumeric characters	No
cpp-header-border-color	xs:string Sets the border color around the header of the payment page. The border is a 2-pixel perimeter around the header space, which is 750 pixels wide by 90 pixels high. By default, the color is black. Character length and limitations: Six character HTML hexadecimal color code in ASCII	No
cpp-header-back-color	xs:string 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	No
cpp-payflow-color	xs:string 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	No
PaymentAction	ebl:PaymentActionCodeType How you want to obtain payment: l Sale indicates that this is a final sale for which you are requesting payment. l Authorization indicates that this payment is a basic authorization subject to settlement with PayPal Authorization & Capture. l 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	No
BuyerEmail	ebl:EmailAddressType 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	No
SolutionType	eBL:SolutionTypeType Type of checkout flow: l Sole: Express Checkout for auctions l Mark: normal Express Checkout	No
LandingPage	eBL:LandingPageType Type of PayPal page to display: l Billing: non-PayPal account l Login: PayPal account login	No
ChannelType	eBL:ChannelType Type of channel: l Merchant: non-auction seller l eBayItem: eBay auction	No
giropaySuccessURL	xs:string 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.	No
giropayCancelURL	xs:string The URL on the merchant site to redirect to after a giropay or bank transfer payment is canceled or fails. Use this field only if you are using giropay or bank transfer payment methods in Germany.	No
BanktxnPendingURL	xs:string The URL on the merchant site to transfer to after a bank transfer payment. Use this field only if you are using giropay or bank transfer payment methods in Germany.	No
BillingAgreementDetails	ns:BillingAgreementDetailsType Billing agreement details for recurring payments. You can include up to 10 billing agreements per SetExpressCheckout request.	See description

Note:

The AddressType elements are required only if you include the Address element in the SOAP request.

IMPORTANT:

Any fields in the WSDL or XSD files that are not described here are ignored. For example, do not set CountryName.

Table 5.2

Address (Shipping Address): AddressType Elements

Field	Data Type/Descriptions	Required?
Name	xs:string Person’s name associated with this shipping address. Character length and limitations: 32 single-byte characters	Yes
Street1	xs:string First street address. Character length and limitations: 100 single-byte characters	Yes
Street2	xs:string Second street address. Character length and limitations: 100 single-byte characters	No
CityName	xs:string Name of city. Character length and limitations: 40 single-byte characters	Yes
StateOr Province	xs:string State or province. Character length and limitations: 40 single-byte characters See Appendix E, “State and Province Abbreviations.” Required for US addresses only.	No
PostalCode	xs:string U.S. Zip code or other country-specific postal code. Character length and limitations: 20 single-byte characters	Yes
Country	ebl:CountryCodeType Country code. Character limit: Two single-byte characters. See Appendix F, “Country Codes.”	Yes
Phone	xs:string Phone number. Character length and limit: 20 single-byte characters	No

SetExpressCheckoutResponse

Response to SetExpressCheckoutRequest.

Fields

 

Table 5.3

SetExpressCheckoutResponse Fields

Field	Description
Token	xs:string A timestamped token by which you identify to PayPal that you are processing this payment with Express Checkout. Note: The token expires after three hours. If you set the token in the SetExpressCheckout request, the value of the token in the response is identical to the value in the request. Character length and limitations: 20 single-byte characters

 

GetExpressCheckoutDetails

GetExpressCheckoutDetails returns information about the customer, including name and address on file with PayPal.

Diagram of GetExpressCheckoutDetails Types

The following diagram represents the composition of the GetExpressCheckoutDetailsRequestType and GetExpressCheckoutDetailsResponseType elements.

Elements required in the request are indicated with an asterisk.

Figure 5.2

GetExpressCheckout Types

 

GetExpressCheckoutDetailsRequest

Obtain details about a payment to be processed by PayPal Express Checkout.

Fields

 

Table 5.4

GetExpressCheckoutDetailsRequest Fields

Field	Description	Required?
Token	xs:string A timestamped token, the value of which was returned by SetExpressCheckout response. Character length and limitations: 20 single-byte characters	Yes

GetExpressCheckoutDetailsResponse

Response to GetExpressCheckoutDetailsRequest.

Fields

 

Table 5.5

GetExpressCheckoutDetailsResponse Fields

Field	Description
Token	xs:string The timestamped token value that was returned by SetExpressCheckout response and passed on GetExpressCheckoutDetails request. Character length and limitations: 20 single-byte characters
PayerInfo	ebl:PayerInfoType Information about the payer. See Table 5.6.
Custom	xs:string A free-form field for your own use, as set by you in the Custom element of SetExpressCheckout request. Character length and limitations: 256 single-byte alphanumeric characters
InvoiceID	xs:string Your own invoice or tracking number, as set by you in the element of the same name in SetExpressCheckout request . Character length and limitations: 127 single-byte alphanumeric characters
ContactPhone	xs:string Payer’s contact telephone number. Note: PayPal returns a contact telephone number only if your Merchant account profile settings require that the buyer enter one. Character length and limitations: Field mask is XXX-XXX-XXXX (for US numbers) or +XXX XXXXXXXX (for international numbers)
RedirectRequired	xs:boolean Flag to indicate whether you need to redirect the customer to back to PayPal after completing the transaction. Note: Use this field only if you are using giropay or bank transfer payment methods in Germany
BillingAgreementAcceptedStatus	Whether or not the customer accepted the billing agreement. This value always returns Yes.

Note:

Empty elements are returned if there is no representative data for the customer. For example, if the customer does not represent a business (and therefore has no business name on file with PayPal), the returned element has no value, like this: <PayerBusiness/>.

Table 5.6

Response: PayerInfoType Elements

Field	Description
Payer	ebl:EmailAddressType Email address of payer. Character length and limitations: 127 single-byte characters
PayerID	ebl:UserIDType Unique PayPal customer account identification number. Character length and limitations:13 single-byte alphanumeric characters.
PayerStatus	ebl:PayPalUser StatusCodeType Status of payer. Valid values are: l verified l unverified Character length and limitations: 10 single-byte alphabetic characters.
PayerName	ebl:PersonNameType First and last name of payer See Table 5.7.
PayerCountry	ebl:CountryCode Type Payer’s country of residence in the form of ISO standard 3166 two-character country codes. Character length and limitations: Two single-byte characters See Appendix F, “Country Codes.”
PayerBusiness	xs:string Payer’s business name. Character length and limitations: 127 single-byte characters
Address	xs:string Payer's shipping address information. See Table 5.8.

Table 5.7

Response: PayerName Elements

Field	Description
Salutation	xs:string Payer’s salutation. Character length and limitations: 20 single-byte characters
FirstName	ebl:PersonNameType Payer’s first name. Character length and limitations: 25 single-byte characters
MiddleName	ebl:NameType Payer’s middle name. Character length and limitations: 25 single-byte characters
LastName	ebl:NameType Payer’s last name. Character length and limitations: 25 single-byte characters
Suffix	ebl:SuffixType Payer’s suffix. Character length and limitations: 12 single-byte characters

Table 5.8

Response: AddressType Fields

Field	Descriptions
AddressStatus	ebl:AddressStatusTypeCode Status of street address on file with PayPal Valid values are: l none l Confirmed l Unconfirmed
Name	xs:string Person’s name associated with this address. Character length and limitations: 32 single-byte characters
Street1	xs:string First street address. Character length and limitations: 100 single-byte characters
Street2	xs:string Second street address. Character length and limitations: 100 single-byte characters
CityName	xs:string Name of city. Character length and limitations: 40 single-byte characters
StateOrProvince	xs:string State or province Character length and limitations: 40 single-byte characters See Appendix E, “State and Province Abbreviations.”
PostalCode	xs:string U.S. Zip code or other country-specific postal code. Character length and limitations: 20 single-byte characters
Country	ebl:CountryCodeType Country code. Character limit: Two single-byte characters. See Appendix F, “Country Codes.”

DoExpressCheckoutPayment

With DoExpressCheckoutPayment, you either obtain payment through Express Checkout for a final sale or request authorization for later capture of payment.

Diagram of DoExpressCheckoutPayment Types

The following diagram represents the composition of the DoExpressCheckoutPaymentRequestType and DoExpressCheckoutPaymentResponseType elements. Elements required in the request are indicated with an asterisk.

Figure 5.3

DoExpressCheckoutPayment Types

 

DoExpressCheckoutPaymentRequest

Request to obtain payment with PayPal Express Checkout.

IMPORTANT:

PayPal requires that a merchant using Express Checkout display to the customer the same exact amount that the merchant sends to PayPal in the OrderTotal element with the DoExpressCheckoutPaymentRequest API.

Fields

 

Table 5.9

DoExpressCheckoutPaymentRequest Fields

Field	Description	Required?
Token	xs:string The timestamped token value that was returned by SetExpressCheckout response and passed on GetExpressCheckoutDetails request. Character length and limitations: 20 single-byte characters	Yes
PaymentAction	ebl:PaymentActionCodeType How you want to obtain payment: l Order indicates that this payment is is an order authorization subject to settlement with PayPal . l . Character length and limit: Up to 13 single-byte alphabetic characters	Yes
PayerID	ebl:UserIDType Unique PayPal customer account identification number as returned by GetExpressCheckoutDetails response. Character length and limitations: 13 single-byte alphanumeric characters.	Yes
PaymentDetails	ebl:PaymentDetails Type Information about the payment See Table 5.10.	Yes
ReturnFMFDetails	xs:boolean Flag to indicate whether you want the results returned by Fraud Management Filters. By default, you do not receive this information.	No

 

Table 5.10

Request: PaymentDetailsType Fields

Field	Description	Required?
OrderTotal	ebl:BasicAmountType Total of order, including shipping, handling, and tax. Note: Limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Must have two decimal places, decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Note: You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.	Yes
ItemTotal	ebl:BasicAmountType Sum of cost of all items in this order. Limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Must have two decimal places, decimal separator must be a period (.), and the optional thousands separator must be a comma (,).	No
ShippingTotal	ebl:BasicAmountType Total shipping costs for this order. Note: Character length and limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Equivalent to nine characters maximum for USD. Note: You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.	No
HandlingTotal	ebl:BasicAmountType Total handling costs for this order. Note: Character length and limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Equivalent to nine characters maximum for USD. Note: You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.	No
TaxTotal	ebl:BasicAmountType Sum of tax for all items in this order. Note: Character length and limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Equivalent to nine characters maximum for USD. Note: You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies. Currency code must be set the same as for OrderTotal.	No
OrderDescription	xs:string Description of items the customer is purchasing. Character length and limitations: 127 single-byte alphanumeric characters	No
Custom	xs:string A free-form field for your own use. Character length and limitations: 256 single-byte alphanumeric characters	No
InvoiceID	xs:string Your own invoice or tracking number. Character length and limitations: 127 single-byte alphanumeric characters	No
ButtonSource	xs:string An identification code for use by third-party applications to identify transactions. Character length and limitations: 32 single-byte alphanumeric characters	No
NotifyURL	xs:string Your URL for receiving Instant Payment Notification (IPN) about this transaction. IMPORTANT: If you do not specify this value in the request, the notification URL from your Merchant Profile is used, if one exists. Character length and limitations: 2,048 single-byte alphanumeric characters	No
ShipToAddress	ebl:AddressType Address the order will be shipped to. See Table 5.11.	No
PaymentDetailsItem	ebl:PaymentDetailsItemType Details about each individual item included in the order See Table 5.12.	No

Note:

The AddressType elements are required only if you include the Address element in the SOAP request.

IMPORTANT:

In the following table, any fields in the WSDL or XSD files that are not described here are ignored. For example, do not set CountryName.

Table 5.11

Request: ShipToAddress: AddressType Fields

Field	Descriptions	Required?
Name	xs:string Person’s name associated with this address. Character length and limitations: 32 single-byte characters	Yes
Street1	xs:string First street address. Character length and limitations: 100 single-byte characters	Yes
Street2	xs:string Second street address. Character length and limitations: 100 single-byte characters	No
CityName	xs:string Name of city. Character length and limitations: 40 single-byte characters	Yes
StateOrProvince	xs:string State or province. Character length and limitations: 40 single-byte characters Required for US addresses only. See Appendix E, “State and Province Abbreviations.”	No
PostalCode	xs:string U.S. ZIP code or other country-specific postal code. Character length and limitations: 20 single-byte characters	Yes
Country	ebl:CountryCodeType Country code. Character limit: Two single-byte characters See Appendix F, “Country Codes.”	Yes
Phone	xs:string Phone number. Character length and limit: 20 single-byte characters	No

Table 5.12

Request: PaymentDetailsItemType Fields

Field	Description	Required?
Name	xs:string Item name. Character length and limitations: 127 single-byte characters	No
Amount	ebl:BasicAmountType Cost of item Note: Character length and limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Equivalent to nine characters maximum for USD. Note: You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.	No
Number	xs:string Item number. Character length and limitations: 127 single-byte characters	No
Quantity	xs:string Item quantity. Character length and limitations: Any positive integer	No
Tax	ebl:BasicAmountType Item sales tax. Note: Character length and limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Equivalent to nine characters maximum for USD. Note: You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.	No
EbayItemPaymentDetailsItem	eBl:ebayItemPaymentDetailsItemType Information relating to an auction sale on eBay SeeTable 5.13	No

If you pass the EbayItemPaymentDetailsItem file, you must set ChannelType to eBayItem and PaymentAction to Sale.

Table 5.13

Request: EbayItemPaymentDetailsItemType Fields

Field	Description	Required?
ItemNumber	xs:string Auction item number Character length: 765 single-byte characters	No
AuctionTransactionID	xs:string Auction transaction identification number Character length: 255 single-byte characters	No
OrderID	xs:string Auction order identification number Character length: 64 single-byte characters	No

DoExpressCheckoutPaymentResponse

Response to DoExpressCheckoutPaymentRequest.

Fields

 

Table 5.14

DoExpressCheckoutPaymentResponse Fields

Field	Description
Token	xs:string The timestamped token value that was returned by SetExpressCheckout response and passed on GetExpressCheckoutDetails request. Character length and limitations:20 single-byte characters See the description of Table 5.3, “SetExpressCheckoutResponse Fields.”
PaymentInfo	ebl:PaymentInfoType Information about the payment. See Table 5.15.
RedirectRequired	xs:boolean Flag to indicate whether you need to redirect the customer to back to PayPal after completing the transaction. Note: Use this field only if you are using giropay or bank transfer payment methods in Germany

Table 5.15

Response: PaymentInfoType Elements

Element	Description
TransactionID	xs:string Unique transaction ID of the payment. Note: If the PaymentAction of the request was Authorization or Order, this value is your AuthorizationID for use with the Authorization & Capture APIs. Character length and limitations:19 single-byte characters
TransactionType	ns:PaymentTransactionCodeType The type of transaction Character length and limitations:15 single-byte characters Valid values: l cart l express-checkout
PaymentType	ebl:PaymentCodeType Indicates whether the payment is instant or delayed. Character length and limitations: Seven single-byte characters Valid values: l none l echeck l instant
PaymentDate	xs:dateTime Time/date stamp of payment
GrossAmount	ebl:BasicAmountType 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.
FeeAmount	ebl:BasicAmountType PayPal fee amount charged for 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.
SettleAmount	ebl:BasicAmountType Amount deposited in your PayPal account after a currency conversion.
TaxAmount	ebl:BasicAmountType 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	xs:string 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	ebl:PaymentStatusCodeType 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.
PendingReason	ebl:PendingStatusCodeType The reason the payment is pending: l none: No pending reason l address: The payment is pending because your customer did not include a confirmed shipping address and your Payment Receiving Preferences is set such that you want to manually accept or deny each of these payments. To change your preference, go to the Preferences section of your Profile. l echeck: The payment is pending because it was made by an eCheck that has not yet cleared. l intl: The payment is pending because you hold a non-U.S. account and do not have a withdrawal mechanism. You must manually accept or deny this payment from your Account Overview. l multi-currency: You do not have a balance in the currency sent, and you do not have your Payment Receiving Preferences set to automatically convert and accept this payment. You must manually accept or deny this payment. l verify: The payment is pending because you are not yet verified. You must verify your account before you can accept this payment. l other: The payment is pending for a reason other than those listed above. For more information, contact PayPal customer service.
ReasonCode	ebl:ReasonCodeType The reason for a reversal if TransactionType is reversal: l none: No reason code l chargeback: A reversal has occurred on this transaction due to a chargeback by your customer. l guarantee: A reversal has occurred on this transaction due to your customer triggering a money-back guarantee. l buyer-complaint: A reversal has occurred on this transaction due to a complaint about the transaction from your customer. l refund: A reversal has occurred on this transaction because you have given the customer a refund. l other: A reversal has occurred on this transaction due to a reason not listed above.

If you specified ReturnFMFDetails in your request, additional information is provided in the FMFDetails element:

Table 5.16

FMFDetailsType Fields

Field	Descriptions
AcceptFilters	ns:RiskFilterListType List of filters that recommend acceptance the payment
DenyFilters	ns:RiskFilterListType List of filters that recommend denial of the payment
PendingFilters	ns:RiskFilterListType List of filters that caused the payment to become pending
ReportFilters	ns:RiskFilterListType List of filters that caused the payment to become flagged

The FMFDetailsType element’s fields contain lists of filters, each with the following information:

Table 5.17

RiskFilterDetailsType Fields

Field	Descriptions
Id	xs:int Filter ID, which is one of the following values: l 1 = AVS No Match l 2 = AVS Partial Match l 3 = AVS Unavailable/Unsupported l 4 = Card Security Code (CSC) Mismatch l 5 = Maximum Transaction Amount l 6 = Unconfirmed Address l 7 = Country Monitor l 8 = Large Order Number l 9 = Billing/Shipping Address Mismatch l 10 = Risky ZIP Code l 11 = Suspected Freight Forwarder Check l 12 = Total Purchase Price Minimum l 13 = IP Address Velocity l 14 = Risky Email Address Domain Check l 15 = Risky Bank Identification Number (BIN) Check l 16 = Risky IP Address Range l 17 = PayPal Fraud Model
Name	xs:string Filter name
Description	xs:string Filter description