DoReferenceTransaction API Operation (NVP)

(Required) Must be DoReferenceTransaction.

(Required) A valid transaction ID from a previous purchase, such as a credit card charge using the DoDirectPayment API, or a valid billing agreement ID. Billing agreements are valid until the agreement is canceled by the buyer; whereas, transaction IDs are valid for 730 days from the transaction date.

(Required) How you want to obtain payment. It is one of the following values:

• Authorization. This payment is a basic authorization subject to settlement with PayPal Authorization and Capture.
• Sale. This is a final sale for which you are requesting payment.
• Order. This payment is an Order authorization subject to settlement with PayPal Authorization and Capture.

(Optional) Specifies type of PayPal payment you require for the billing agreement. It is one of the following values.

• Any
• InstantOnly

(Optional) IP address of the buyer's browser. Supports IPv4, IPv6, and IPv4-mapped IPv6. IPv6 and IPv4-mapped IPv6 can be zero compressed.

Character length and limitations: 45 single—byte characters, including periods or colons.

• IPv4 example, 255.255.255.255
• IPv6 example, FDEC:0:0:0:0:BBFF:0:FFFF or zero-compressed, FDEC::BBFF:0:FFFF
• IPv4-mapped IPv6 example, 0000:0000:0000:0000:0000:FFFF:255.255.255.255 or zero compressed, : :FFFF:255.255.255.255

RISKSESSIONCORRELATIONID

(Optional) The ID of the risk session for correlation purposes.

MERCHANTSESSIONID

(Optional) Your buyer session identification token.

Character length and limitations: 64 single-byte numeric characters.

(Optional) Flag to indicate whether you want the results returned by Fraud Management Filters. By default, you do not receive this information. Value is:

• 0. Do not receive FMF details (default).
• 1. Receive FMF details.

• Alphanumeric characters
• - (dash)
• * (asterisk)
• . (period)
• (space)

• The PayPal prefix toggle is set to PAYPAL * in PayPal's administration tools.
• The merchant descriptor set in the Payment Receiving Preferences is EBAY.
• The soft descriptor is passed in as JanesFlowerGifts LLC.

• None. Transaction is not identified as a particular type.

(Optional) A message ID used for idempotence to uniquely identify a message. This ID can later be used to request the latest results for a previous request without generating a new request. Examples of this include requests due to timeouts or errors during the original request.

Character length and limitations: string of up to 38 single-byte characters.

This field is available since version 92.0.

Person's name associated with this shipping address. It is required if using a shipping address.

Character length and limitations: 32 double-byte characters.

First street address. It is required if using a shipping address.

Character length and limitations: 100 single-byte characters.

(Optional) Second street address.

Character length and limitations: 100 single-byte characters.

Name of city. It is required if using a shipping address.

Character length and limitations: 40 single-byte characters.

State or province.

Required for transactions only if the address is in one of the following countries: Argentina, Brazil, Canada, China, Indonesia, India, Japan, Mexico, Thailand or USA. See the list of PayPal state codes.

Character length and limitations: 40 single-byte characters.

U.S. ZIP code or other country-specific postal code. It is required if using a U.S. shipping address.

Character length and limitations: 20 single-byte characters.

Country code. It is required if using a shipping address.

Character length and limitations: 2 single-byte characters.

(Optional) Phone number.

Character length and limitations: 20 single-byte characters.

(Required) The total cost of the transaction to the buyer. If shipping cost and tax charges are known, include them in this value. If not, this value should be the current subtotal of the order. If the transaction includes one or more one-time purchases, this field must be equal to the sum of the purchases. Set this field to 0 if the transaction does not include a one-time purchase such as when you set up a billing agreement for a recurring payment that is not immediately charged. When the field is set to0, purchase-specific fields are ignored.

Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

(Optional) Sum of cost of all items in this order.

Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

(Optional) Total shipping costs for this order.

Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

(Optional) Total shipping insurance costs for this order. The value must be non-negative currency amount or null if insurance options are offered.

Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

(Optional) Shipping discount for this order, specified as a negative number.

Character length and limitations: Value is a negative number. It includes no currency symbol. Most currencies require 2 decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. See the currency codes page for details.

(Optional) Total handling costs for this order.

Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

(Optional) Sum of tax for all items in this order.

Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

(Optional) Description of items the buyer is purchasing.

Character length and limitations: 127 single-byte alphanumeric characters.

(Optional) A free-form field for your own use.

Character length and limitations: 256 single-byte alphanumeric characters.

(Optional) Your own invoice or tracking number.

INVNUM is equivalent to the SOAP fieldInvoiceID. In reports, INVNUM values are displayed in the InvoiceID column.

Character length and limitations: 256 single-byte alphanumeric characters.

(Optional) An identification code for use by third-party applications to identify transactions.

Character length and limitations: 32 single-byte alphanumeric characters.

(Optional) Your URL for receiving Instant Payment Notification (IPN) about this transaction. 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.

(Optional) Flag to indicate a recurring transaction. It is one of the following values:

• Any value other than Y. This is not a recurring transaction (default).
• Y. This is a recurring transaction.

(Optional) The category of a payment. Value is:

• 1. International shipping.
• 2. Local delivery.

Indicates whether the item is digital or physical. For digital goods, this field is required and you must set it to Digital to get the best rates. These parameters must be ordered sequentially beginning with 0 (for example L_ITEMCATEGORY0,L_ITEMCATEGORY1). Value is:

• Digital
• Physical

This field is introduced in version 69.0.

Item name. This field is required when you pass a value forL_PAYMENTREQUEST_n_ITEMCATEGORYm. These parameters must be ordered sequentially beginning with 0 (for example L_NAME0, L_NAME1).

Character length and limitations: 127 single-byte characters.

(Optional) Item description.

This field is available since version 53.0.

Character length and limitations: 127 single-byte characters.

Cost of item. This field is required when you pass a value forL_PAYMENTREQUEST_n_ITEMCATEGORYm. These parameters must be ordered sequentially beginning with 0 (for example L_AMT0, L_AMT1).

Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

(Optional) Item number. These parameters must be ordered sequentially beginning with 0 (for example L_NUMBER0,L_NUMBER1).

Character length and limitations: 127 single-byte characters.

Item quantity. This field is required when you pass a value forL_PAYMENTREQUEST_n_ITEMCATEGORYm. These parameters must be ordered sequentially beginning with 0 (for example L_QTY0, L_QTY1).

Character length and limitations: Any positive integer.

(Optional) Item sales tax. These parameters must be ordered sequentially beginning with 0 (for example L_TAXAMT0, L_TAXAMT1).

Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

• CUSTOMER (default) - Customer initiates the payment. Also referred to as a Customer Initiated Transaction (CIT).
• MERCHANT - Merchant initiates the transaction and the merchant has established consent to charge the buyer. Also referred to as a Merchant Initiated Transaction (MIT).

• UNSCHEDULED - Payments that the merchant initiates and are not on a specified schedule. For example, this includes preauthorized transactions where the merchant can charge the buyer once a balance falls within a specified range. These transactions are also referred to as top-up.
• RECURRING - Merchant initiates a payment as part of a series of recurring payments. The payment amounts can be variable and are on a fixed time interval.
• ONE_TIME - Single, one-time payment.

• FIRST - Save card information or payment token to use in subsequent transactions. Collect consent from the buyer that you intend to save their payment information.
• SUBSEQUENT - Card information or payment token was previously saved and is used in the transaction.

• PREVIOUSNETWORKTRANSACTIONID - Transaction ID from a non-PayPal payment processor that you have previously used to process the payment.
• Network - TransactionID from a non-PayPal payment processor that you have previously used to process the payment.

(Optional) Auction item number. These parameters must be ordered sequentially beginning with 0 (for exampleL_EBAYITEMNUMBER0, L_EBAYITEMNUMBER1).

Character length: 765 single-byte characters.

(Optional) Auction transaction identification number. These parameters must be ordered sequentially beginning with 0 (for exampleL_EBAYITEMAUCTIONTXNID0,L_EBAYITEMAUCTIONTXNID1).

Character length: 255 single-byte characters.

(Optional) Auction order identification number. These parameters must be ordered sequentially beginning with 0 (for exampleL_EBAYITEMORDERID0, L_EBAYITEMORDERID1).

Character length: 64 single-byte characters.

(Optional) Type of credit card. Is one of the following values:

• Visa
• Mastercard
• Discover
• Amex
• JCB
• Maestro. See note.

For UK, only Maestro, Mastercard,Discover, and Visa are allowable. For Canada, only Mastercard and Visa are allowable. Interac debit cards are not supported.

Character length and limitations: Up to 10 single-byte alphabetic characters.

(Optional) Credit card number.

Character length and limitations: Numeric characters only with no spaces or punctuation. The string must conform with modulo and length required by each credit card type.

Credit card expiration date. This field is required if you are using recurring payments with direct payments.

Character length and limitations: Six single-byte alphanumeric characters, including leading zero, in the format MMYYYY.

(Optional) Card Verification Value, version 2. To comply with credit card processing regulations, you must not store this value after a transaction has been completed.

Character length and limitations: For Visa, Mastercard, and Discover, the value is exactly three digits. For American Express, the value is exactly four digits.

(Optional) Month and year that Maestro card was issued.

Character length and limitations: Must be six digits, including leading zero, in the format MMYYYY.

(Optional) Issue number of Maestro card.

Character length and limitations: 2 numeric digits maximum.

(Optional) Email address of buyer.

Character length and limitations: 127 single-byte characters.

(Conditional) Buyer's first name is required except when the reference transaction is run against a billing agreement. In the case of a billing agreement, the first name field should not be used.

Character length and limitations: 64 double-byte characters.

(Conditional) Buyer's last name is required except when the reference transaction is run against a billing agreement. In the case of a billing agreement, the last name field should not be used.

Character length and limitations: 64 double-byte characters.

(Optional) First street address.

Character length and limitations: 100 single-byte characters.

(Optional) Second street address.

Character length and limitations: 100 single-byte characters.

(Optional) Name of city.

Character length and limitations: 40 single-byte characters.

(Optional) State or province.

Character length and limitations: 40 single-byte characters.

(Optional) Country code.

Character limit: 2 single-byte characters.

(Optional) U.S. ZIP code or other country-specific postal code.

Character length and limitations: 20 single-byte characters.

Returned only for Direct Credit Card transactions. Address Verification System response code.

Character limit: One single-byte alphanumeric character.

Filter ID, including the filter type (PENDING,REPORT, or DENY), the filter ID, and the entry number, n, starting from 0. FilterID is one of the following values:

• 1. AVS No Match.
• 2. AVS Partial Match.
• 3. AVS Unavailable/Unsupported.
• 4. Card Security Code (CSC) Mismatch.
• 5. Maximum Transaction Amount.
• 6. Unconfirmed Address.
• 7. Country Monitor.
• 8. Large Order Number.
• 9. Billing/Shipping Address Mismatch.
• 10. Risky ZIP Code.
• 11. Suspected Freight Forwarder Check.
• 12. Total Purchase Price Minimum.
• 13. IP Address Velocity.
• 14. Risky Email Address Domain Check.
• 15. Risky Bank Identification Number (BIN) Check.
• 16. Risky IP Address Range.
• 17. PayPal Fraud Model.

A processor response code typically returned on declined Website Payments Pro recurring transactions. Its purpose is to provide merchants with information and specific instructions on how to handle the decline. It is the merchant's responsibility to follow the instructions provided to avoid chargebacks. For details on the meanings of these codes, see AVS, CVV2, and payment advice response codes.

(Optional) A message ID used for idempotence to uniquely identify a message. This ID can later be used to request the latest results for a previous request without generating a new request. Examples of this include requests due to timeouts or errors during the original request.

Character length and limitations: string of up to 38 single-byte characters.

This field is available since version 92.0.

Unique transaction ID of the payment.

Character length and limitations: 17 characters. Orders transactions have 19 characters.

Parent or related transaction identification number. This value in this field is for the following transaction types:

• Reversal. Capture of an authorized transaction.
• Reversal. Reauthorization of a transaction.
• Capture of an order. The value of ParentTransactionID is the original OrderID.
• Authorization of an order. The value of ParentTransactionID is the original OrderID.
• Capture of an order authorization.
• Void of an order. The value of ParentTransactionIDis the original OrderID.

Receipt identification number.

Character length and limitations: 16 digits in xxxx-xxxx-xxxx-xxxx format.

• cart
• express-checkout

Character length and limitations: 15 single-byte characters.

• none
• echeck
• instant

Character length and limitations: Seven single-byte characters.

Date and time stamp of the payment.

Character length and limitations: Date and time are in UTC/GMT format. For example, 2013-08-24T05:38:48Z.

The final amount charged, including any shipping and taxes from your Merchant Profile.

Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

PayPal fee amount charged for the transaction.

Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

Amount deposited in your PayPal account after a currency conversion.

Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

Tax charged on the transaction.

Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

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.

Character length and limitations: Decimal value that does not exceed 17 characters, including decimal point.

• 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, for example, 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.

• none. No pending reason.
• address. The payment is pending because your buyer 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.
• authorization. The payment is pending because it has been authorized but not settled. You must capture the funds first.
• echeck. The payment is pending because it was made by an eCheck that has not yet cleared.
• 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.
• 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.
• order. The payment is pending because it is part of an order that has been authorized but not settled.
• paymentreview. The payment is pending while it is being reviewed by PayPal for risk.
• regulatoryreview. The payment is pending while we make sure it meets regulatory requirements. You will be contacted again in from 24 to 72 hours with the outcome of the review.
• unilateral. The payment is pending because it was made to an email address that is not yet registered or confirmed.
• verify. The payment is pending because you are not yet verified. You must verify your account before you can accept this payment.
• other. The payment is pending for a reason other than those listed above. For more information, contact PayPal Customer Service.

The reason for a reversal if the transaction type is reversal. Value is:

• none. No reason code.
• chargeback. A reversal has occurred on this transaction due to a chargeback by your buyer.
• guarantee. A reversal has occurred on this transaction due to your buyer triggering a money-back guarantee.
• buyer-complaint. A reversal has occurred on this transaction due to a complaint about the transaction from your buyer.
• refund. A reversal has occurred on this transaction because you have given the buyer a refund.
• other. A reversal has occurred on this transaction due to a reason not listed above.

Prior to version 64.4, the kind of seller protection in force for the transaction. Value is:

• Eligible. Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received.
• PartiallyEligible. Merchant is protected by PayPal's Seller Protection Policy for Item Not Received.
• Ineligible. Merchant is not protected under the Seller Protection Policy.

Since version 64.4, the type of seller protection in force for the transaction.

It is one or more of the following values:

• ItemNotReceivedEligible – Merchant is protected by PayPal's Seller Protection Policy for Item Not Received.
• UnauthorizedPaymentEligible – Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payment.
• Ineligible – Merchant is not protected under the Seller Protection Policy.

xs:string. StoreId as entered in the transaction.

Returns the category of the instrument only when it is promotional.Value is:

• 1. Represents PayPal Credit.

Reserved for future use. Returns an instrument ID (issued by the external party) corresponding to the funding source used in the payment.

Unique transaction ID of the payment.

Character length and limitations: 17 characters. Orders transactions have 19 characters.

Parent or related transaction identification number. This value in this field is for the following transaction types:

• Reversal. Capture of an authorized transaction.
• Reversal. Reauthorization of a transaction.
• Capture of an order. The value of ParentTransactionID is the original OrderID.
• Authorization of an order. The value of ParentTransactionID is the original OrderID.
• Capture of an order authorization.
• Void of an order. The value of ParentTransactionIDis the original OrderID.

Receipt identification number.

Character length and limitations: 16 digits in xxxx-xxxx-xxxx-xxxx format.

• cart
• express-checkout

Character length and limitations: 15 single-byte characters.

• none
• echeck
• instant

Character length and limitations: Seven single-byte characters.

Date and time stamp of the payment.

Character length and limitations: Date and time are in UTC/GMT format. For example, 2013-08-24T05:38:48Z.

The final amount charged, including any shipping and taxes from your Merchant Profile.

Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

PayPal fee amount charged for the transaction.

Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

Amount deposited in your PayPal account after a currency conversion.

Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

Tax charged on the transaction.

Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

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.

Character length and limitations: Decimal value that does not exceed 17 characters, including decimal point.

• 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, for example, 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.

• none. No pending reason.
• address. The payment is pending because your buyer 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.
• authorization. The payment is pending because it has been authorized but not settled. You must capture the funds first.
• echeck. The payment is pending because it was made by an eCheck that has not yet cleared.
• 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.
• 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.
• order. The payment is pending because it is part of an order that has been authorized but not settled.
• paymentreview. The payment is pending while it is being reviewed by PayPal for risk.
• regulatoryreview. The payment is pending while we make sure it meets regulatory requirements. You will be contacted again in from 24 to 72 hours with the outcome of the review.
• unilateral. The payment is pending because it was made to an email address that is not yet registered or confirmed.
• verify. The payment is pending because you are not yet verified. You must verify your account before you can accept this payment.
• other. The payment is pending for a reason other than those listed above. For more information, contact PayPal Customer Service.

The reason for a reversal if the transaction type is reversal. Value is:

• none. No reason code.
• chargeback. A reversal has occurred on this transaction due to a chargeback by your buyer.
• guarantee. A reversal has occurred on this transaction due to your buyer triggering a money-back guarantee.
• buyer-complaint. A reversal has occurred on this transaction due to a complaint about the transaction from your buyer.
• refund. A reversal has occurred on this transaction because you have given the buyer a refund.
• other. A reversal has occurred on this transaction due to a reason not listed above.

Prior to version 64.4, the kind of seller protection in force for the transaction. Value is:

• Eligible. Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received.
• PartiallyEligible. Merchant is protected by PayPal's Seller Protection Policy for Item Not Received.
• Ineligible. Merchant is not protected under the Seller Protection Policy.

Since version 64.4, the type of seller protection in force for the transaction.

It is one or more of the following values:

• ItemNotReceivedEligible – Merchant is protected by PayPal's Seller Protection Policy for Item Not Received.
• UnauthorizedPaymentEligible – Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payment.
• Ineligible – Merchant is not protected under the Seller Protection Policy.

xs:string. StoreId as entered in the transaction.

Returns the category of the instrument only when it is promotional.Value is:

• 1. Represents PayPal Credit.

Reserved for future use. Returns an instrument ID (issued by the external party) corresponding to the funding source used in the payment.

Whether you require that the buyer's shipping address on file with PayPal be a confirmed address. You must have permission from PayPal to not require a confirmed address. Value is:

• 0. You do not require that the buyer's shipping address be a confirmed address.
• 1. You require that the buyer's shipping address be a confirmed address.

Character length and limitations: One single-byte numeric character.