# DoReferenceTransaction API Operation (SOAP) (/api/nvp-soap/do-reference-transaction-soap)



> **Note:** **Important:** NVP/SOAP is a legacy integration method. We accept new integrations and support existing integrations, but there are newer solutions. If you're starting an integration, [we recommend our latest solutions](/).

Processes a payment from a buyer's account, which is identified by a previous
transaction.

## DoReferenceTransaction Request Message [#doreferencetransaction-request-message]

### DoReferenceTransaction Request Fields [#doreferencetransaction-request-fields]

| Field<br />                      | Description<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ReferenceID`<br />              | `xs:string`<br /&#x3E; &#x2A;(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.<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `PaymentAction`<br />            | `xs:string`<br /&#x3E; &#x2A;(Required)* How you want to obtain payment. It is one of the following values:<br /> `Authorization` — This payment is a basic authorization subject to settlement with PayPal Authorization and Capture.<br />`Sale` — This is a final sale for which you are requesting payment.<br />`Order` — This payment is an Order authorization subject to settlement with PayPal Authorization and Capture.<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `PaymentDetails`<br />           | [`ebl:PaymentDetailsType`](#paymentdetailstype-fields)<br /&#x3E; &#x2A;(Required)* Information about the payment.<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `IPAddress`<br />                | `xs:string`<br /&#x3E; &#x2A;(Optional)* IP address of the buyer's browser. Supports IPv4, IPv6, and IPv4-mapped IPv6. IPv6 and IPv4-mapped IPv6 can be zero compressed.<br /> > **Note:** &#x2A;*Important:** PayPal highly recommends passing the buyer's IP address to detect possible fraud. Character length and limitations: 45 single—byte characters, including periods or colons.<br /> IPv4 example, 255.255.255.255<br />IPv6 example, FDEC:0:0:0:0:BBFF:0:FFFF<br /> or zero-compressed, FDEC::BBFF:0:FFFF<br />IPv4-mapped IPv6 example, 0000:0000:0000:0000:0000:FFFF:255.255.255.255<br /> or zero compressed, : :FFFF:255.255.255.255<br />                                                                                                                                                                                                                                                                                                                  |
| `RiskSessionCorrelationID`<br /> | `xs:string`<br /&#x3E; &#x2A;(Optional)* The ID of the risk session for correlation purposes.<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `MerchantSessionId`<br />        | `xs:string`<br /&#x3E; &#x2A;(Optional)* Your buyer session identification token.<br /> > **Note:** &#x2A;*Note:** PayPal records this optional session identification token as an additional means to detect possible fraud. Character length and limitations: 64 single-byte numeric characters<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `ReturnFMFDetails`<br />         | `xs:int`<br /&#x3E; &#x2A;(Optional)* Flag to indicate whether you want the results returned by Fraud Management Filters. By default, you do not receive this information. Value is:<br /> `0` — Do not receive FMF details (default)<br />`1` — Receive FMF details<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `SoftDescriptor`                 | *(Optional)* Information that is usually displayed in the account holder's statement, for example, `<Your-Not-For-Profit> <State>`, `<Your-Not-For-Profit> <Branch-Name>`, `<Your-Website> dues` or `<Your-Website> list fee`.<br /> <br />Character length and limitations: 23 alphanumeric characters, can include the special characters dash (`-`) and dot (`.`) only. Asterisks (`*`) are NOT permitted. If it includes a space character (` `), enclose the `"<Soft-Descriptor>"` value in double quotes. > **Note:** &#x2A;*Note:** For US Website Payments Pro AMEX cards only and only for merchants passing dynamic soft descriptors, the dynamic soft descriptors for AMEX cards are only guaranteed once the transaction settles. This means that during the authorization time the card issuing bank might show their customer the registered business or legal name for the merchant versus the dynamic soft descriptor passed on a per API transaction.<br /> |
| `SoftDescriptorCity`<br />       | `xs:string`<br /&#x3E; &#x2A;(Optional)* A unique phone number, email address or URL, which is displayed on the account holder's statement. PayPal recommends passing a toll-free phone number because, typically, this is the easiest way for a buyer to contact the seller in the case of an inquiry.<br /><br />Character length and limitations: 13 characters including special characters, such as, space, `!`, `"`, `#`, `$`, `%`, `&`, `'`, `(`, `)`, `+`, `-`,`*`, `/`, `:`, `;`, `<`, `=`, `>`, `?`, `@`, comma and period.<br /><br />If it includes the space character (` `), enclose the `"<Soft-Descriptor-City>"` value in double quotes.<br /><br /> > **Note:** &#x2A;*Note:** Underscore (`_`) is an illegal character for this field. If it is passed, then it will be removed leaving the remaining characters in the same order. For example, `New_York` changes to `NewYork`.<br />                                                                   |
| `PaymentReason`<br />            | `ns:PaymentReasonType`<br /> Indicates the type of transaction. Value is:<br /> `None` — Transaction is not identified as a particular type.<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |

### AddressType (Shipping) Fields [#addresstype-shipping-fields]

| Field                   | Description                                                                                                                                                                                                                                                                                                                                                                    |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Name`<br />            | `xs:string`<br /> Person's name associated with this shipping address. It is required if using a shipping address.<br /> Character length and limitations: 32 double-byte characters<br />                                                                                                                                                                                     |
| `Street1`<br />         | `xs:string`<br /> First street address. It is required if using a shipping address.<br /> Character length and limitations: 100 single-byte characters<br />                                                                                                                                                                                                                   |
| `Street2`<br />         | `xs:string`<br /&#x3E; &#x2A;(Optional)* Second street address.<br /> Character length and limitations: 100 single-byte characters<br />                                                                                                                                                                                                                                       |
| `CityName`<br />        | `xs:string`<br /> Name of city. It is required if using a shipping address.<br /> Character length and limitations: 40 single-byte characters<br />                                                                                                                                                                                                                            |
| `StateOrProvince`<br /> | `xs:string`<br /> State or province.<br /><br /> It is 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](/docs/nvp-soap-api/state-codes/).<br /> Character length and limitations: 40 single-byte characters<br /> |
| `PostalCode`<br />      | `xs:string`<br /> U.S. ZIP code or other country-specific postal code. It is required if using a U.S. shipping address.<br /> Character length and limitations: 20 single-byte characters<br />                                                                                                                                                                                |
| `Country`<br />         | `ebl:CountryCodeType`<br /> Country code. It is required if using a shipping address.<br /> Character length and limitations: 2 single-byte characters<br />                                                                                                                                                                                                                   |
| `Phone`<br />           | `xs:string`<br /&#x3E; &#x2A;(Optional)* Phone number.<br /> Character length and limitations: 20 single-byte characters<br />                                                                                                                                                                                                                                                 |

### PaymentDetailsType Fields [#paymentdetailstype-fields]

| Field                      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `OrderTotal`<br />         | `ebl:BasicAmountType`<br /&#x3E; &#x2A;(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 to `0`, purchase-specific fields are ignored.<br /> > **Note:** &#x2A;*Note:** You must set the `currencyID` attribute to one of the 3-character [currency codes](/api/nvp-soap/currency-codes/) for any of the supported PayPal currencies. Character length and limitations:<br /> 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](/api/nvp-soap/currency-codes/). 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](/api/nvp-soap/currency-codes/).<br /> \` |
| `ItemTotal`<br />          | `ebl:BasicAmountType`<br /&#x3E; &#x2A;(Optional)* Sum of cost of all items in this order.<br /> > **Note:** &#x2A;*Note:** You must set the `currencyID`attribute to one of the three-character [currency codes](/api/nvp-soap/currency-codes/) for any of the supported PayPal currencies. Character length and limitations:<br /> 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](/api/nvp-soap/currency-codes/). 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](/api/nvp-soap/currency-codes/).<br /> \`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `ShippingTotal`<br />      | `ebl:BasicAmountType`<br /&#x3E; &#x2A;(Optional)* Total shipping costs for this order.<br /> > **Note:** &#x2A;*Note:** You must set the `currencyID`attribute to one of the 3-character [currency codes](/api/nvp-soap/currency-codes/) for any of the supported PayPal currencies. Character length and limitations:<br /> 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](/api/nvp-soap/currency-codes/). 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](/api/nvp-soap/currency-codes/).<br /> \`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `InsuranceTotal`<br />     | `ebl:BasicAmountType`<br /&#x3E; &#x2A;(Optional)* Total shipping insurance costs for this order. The value must be non-negative currency amount or `null` if you offer insurance options.<br /> > **Note:** &#x2A;*Note:** You must set the `currencyID` attribute to one of the 3-character currency codes for any of the supported PayPal currencies. Character length and limitations.<br /> 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](/api/nvp-soap/currency-codes/). 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](/api/nvp-soap/currency-codes/).<br /> \`                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| `ShippingDiscount`<br />   | `ebl:BasicAmountType`<br /&#x3E; &#x2A;(Optional)* Shipping discount for this order, specified as a negative number.<br /> > **Note:** &#x2A;*Note:** You must set the `currencyID` attribute to one of the 3-character [currency codes](/api/nvp-soap/currency-codes/) for any of the supported PayPal currencies. 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](/api/nvp-soap/currency-codes/) for details.<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `HandlingTotal`<br />      | `ebl:BasicAmountType`<br /&#x3E; &#x2A;(Optional)* Total handling costs for this order.<br /> > **Note:** &#x2A;*Note:** You must set the `currencyID` attribute to one of the 3-character [Character length and limitations:<br />](/api/nvp-soap/currency-codes/)[Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the](/api/nvp-soap/currency-codes/)[per transaction limit for the currency](/api/nvp-soap/currency-codes/). 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](/api/nvp-soap/currency-codes/).<br /> \`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `TaxTotal`<br />           | `ebl:BasicAmountType`<br /&#x3E; &#x2A;(Optional)* Sum of tax for all items in this order.<br /> > **Note:** &#x2A;*Note:** You must set the `currencyID` attribute to one of the 3-character [currency codes](/api/nvp-soap/currency-codes/) for any of the supported PayPal currencies. Character length and limitations:<br /> 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](/api/nvp-soap/currency-codes/). 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](/api/nvp-soap/currency-codes/).<br /> \`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `OrderDescription`<br />   | `xs:string`<br /&#x3E; &#x2A;(Optional)* Description of items the buyer is purchasing.<br /> > **Note:** &#x2A;*Note:** The value you specify is available only if the transaction includes a purchase. This field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged. Character length and limitations: 127 single-byte alphanumeric characters<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `Custom`<br />             | `xs:string`<br /&#x3E; &#x2A;(Optional)* A free-form field for your own use.<br /> > **Note:** &#x2A;*Note:** The value you specify is available only if the transaction includes a purchase. This field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged. Character length and limitations: 256 single-byte alphanumeric characters<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `InvoiceID`<br />          | `xs:string`<br /&#x3E; &#x2A;(Optional)* Your own invoice or tracking number.<br /> > **Note:** &#x2A;*Note:** PayPal recommends using the `InvoiceID` field to associate transactions with your internal tracking IDs or invoice numbers; populating the invoice ID field will help you pull transaction information at a later date using only your internal ID. > **Note:** &#x2A;*Important:** The value you specify is available only if the transaction includes a purchase. This field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged. Character length and limitations: 256 single-byte alphanumeric characters<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `ButtonSource`<br />       | `xs:string`<br /&#x3E; &#x2A;(Optional)* An identification code for use by third-party applications to identify transactions.<br /> Character length and limitations: 32 single-byte alphanumeric characters<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `NotifyURL`<br />          | `xs:string`<br /&#x3E; &#x2A;(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.<br /> Character length and limitations: 2,048 single-byte alphanumeric characters<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `ShipToAddress`<br />      | `ns:AddressType`<br /&#x3E; &#x2A;(Optional)* Address the order is shipped to.<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `PaymentDetailsItem`<br /> | `ebl:PaymentDetailsItemType`<br /&#x3E; &#x2A;(Optional)* Details about each individual item included in the order.<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `Recurring`<br />          | `ns:RecurringFlagType`<br /&#x3E; &#x2A;(Optional)* Flag to indicate a recurring transaction. Value is:<br /> Any value other than `Y` — This is not a recurring transaction (default).<br />`Y` — This is a recurring transaction.<br /> > **Note:** &#x2A;*Note:** To pass `Y` in this field, you must have established a billing agreement with the buyer specifying the amount, frequency, and duration of the recurring payment. This field is introduced in version 80.0 of the API.<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `PaymentCategoryType`      | `ebl:PaymentCategoryType`<br /&#x3E; &#x2A;(Optional)* Category of a payment. Value is:<br /> `InternationalShipping`<br /> `LocalDelivery`<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |

### PaymentDetailsItemType Fields [#paymentdetailsitemtype-fields]

| Field                                 | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `ItemCategory`<br />                  | `ns:ItemCategoryType`<br /> 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. Value is:<br /> `Digital`<br />`Physical`<br />This field is introduced in version 69.0.<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `Name`<br />                          | `xs:string`<br /> Item name. This field is required when you pass a value for `ItemCategory`.<br /> Character length and limitations: 127 single-byte characters<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `Description`<br />                   | `xs:string`<br /&#x3E; &#x2A;(Optional)* Item description.<br /> This field is available since version 53.0.<br /> Character length and limitations: 127 single-byte characters<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `Amount`<br />                        | `ebl:BasicAmountType`<br /> Cost of item. This field is required when you pass a value for `ItemCategory`.<br /> > **Note:** &#x2A;*Note:** You must set the `currencyID` attribute to one of the 3-character [currency codes](/api/nvp-soap/currency-codes/) for any of the supported PayPal currencies. Character length and limitations:<br /> 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](/api/nvp-soap/currency-codes/). 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](/api/nvp-soap/currency-codes/).<br /> \` |
| `Number`<br />                        | `xs:string`<br /&#x3E; &#x2A;(Optional)* Item number.<br /> Character length and limitations: 127 single-byte characters<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| `Quantity`<br />                      | `xs:integer`<br /> Item quantity. This field is required when you pass a value for`ItemCategory`.<br /> Character length and limitations: Any positive integer<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `Tax`<br />                           | `ebl:BasicAmountType`<br /&#x3E; &#x2A;(Optional)* Item sales tax.<br /> > **Note:** &#x2A;*Note:** You must set the `currencyID` attribute to one of the 3-character [currency codes](/api/nvp-soap/currency-codes/) for any of the supported PayPal currencies. Character length and limitations:<br /> 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](/api/nvp-soap/currency-codes/). 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](/api/nvp-soap/currency-codes/).<br /> \`                                         |
| `PAYMENTINITIATOR`                    | `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).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `PAYMENTCATEGORY`                     | `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.                                                                                                                                                                                                                                                                                                                                                                             |
| `CARDONFILE`                          | `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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `PREVIOUSTRANSACTIONREFERENCE`        | PayPal transaction ID previously used to charge the buyer. Shows payment processors that you have established a contract with the buyer.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `PREVIOUSNETWORKTRANSACTIONREFERENCE` | `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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |

### EbayItemPaymentDetailsItemType Fields [#ebayitempaymentdetailsitemtype-fields]

| Field                         | Description                                                                                                                                  |
| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `ItemNumber`<br />            | `xs:string`<br /&#x3E; &#x2A;(Optional)* Auction item number.<br /> Character length: 765 single-byte characters<br />                       |
| `AuctionTransaction Id`<br /> | `xs:string`<br /&#x3E; &#x2A;(Optional)* Auction transaction identification number.<br /> Character length: 255 single-byte characters<br /> |
| `OrderID`<br />               | `xs:string`<br /&#x3E; &#x2A;(Optional)* Auction order identification number.<br /> Character length: 64 single-byte characters<br />        |

### ReferenceCreditCardDetailsType Fields [#referencecreditcarddetailstype-fields]

| Field                    | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `CreditCardType`<br />   | `ebl:CreditCardType`<br /&#x3E; &#x2A;(Optional)* Type of credit card. Is one of the following values:<br /> `Visa``Mastercard``Discover``JCB``Amex``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.<br /> > **Note:** &#x2A;*Note:** If the credit card type is `Maestro`, you must set the `currencyId` to `GBP`. In addition, you must specify either `StartMonth` and `StartYear` or `IssueNumber`. Character length and limitations: Up to 10 single-byte alphabetic characters<br /> |
| `CreditCardNumber`<br /> | `xs:string`<br /&#x3E; &#x2A;(Optional)* Credit card number.<br /> 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.<br />                                                                                                                                                                                                                                                                                                                                                                                      |
| `ExpMonth`<br />         | `xs:int`<br /&#x3E; &#x2A;(Optional)* Credit card expiration month.<br /> Character length and limitations: 2 single-byte numeric characters, including leading zero<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `ExpYear`<br />          | `xs:int`<br /&#x3E; &#x2A;(Optional)* Credit card expiration year.<br /> Character length and limitations: 4 single-byte numeric characters<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `CVV2`<br />             | `xs:string`<br /&#x3E; &#x2A;(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.<br /> Character length and limitations: For Visa, Mastercard, and Discover, the value is exactly 3 digits. For American Express, the value is exactly 4 digits.<br />                                                                                                                                                                                                                                                              |
| `CardOwner`<br />        | `ns:PayerInfoType`<br /&#x3E; &#x2A;(Optional)* Details about the owner of the credit card.<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `StartMonth`<br />       | `xs:int`<br /&#x3E; &#x2A;(Optional)* Month that Maestro card was issued.<br /> Character length and limitations: 2-digit, zero-filled if necessary<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `StartYear`<br />        | `xs:int`<br /&#x3E; &#x2A;(Optional)* Year that Maestro card was issued.<br /> Character length and limitations: 4 digits<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `IssueNumber`<br />      | `xs:string`<br /&#x3E; &#x2A;(Optional)* Issue number of Maestro card.<br /> Character length and limitations: 2 numeric digits maximum.<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |

### PayerNameType Fields [#payernametype-fields]

| Field              | Description                                                                                                                                   |
| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `Salutation`<br /> | `xs:string`<br /&#x3E; &#x2A;(Optional)* Buyer's salutation.<br /> Character length and limitations: 20 single-byte characters<br />          |
| `FirstName`<br />  | `ebl:PersonNameType`<br /&#x3E; &#x2A;(Optional)* Buyer's first name.<br /> Character length and limitations: 64 double-byte characters<br /> |
| `MiddleName`<br /> | `ebl:NameUser`<br /&#x3E; &#x2A;(Optional)* Buyer's middle name.<br /> Character length and limitations: 64 double-byte characters<br />      |
| `LastName`<br />   | `ebl:NameType`<br /&#x3E; &#x2A;(Optional)* Buyer's last name.<br /> Character length and limitations: 64 double-byte characters<br />        |
| `Suffix`<br />     | `ebl:SuffixType`<br /&#x3E; &#x2A;(Optional)* Buyer's suffix.<br /> Character length and limitations: 12 single-byte characters<br />         |

## DoReferenceTransaction Response Message [#doreferencetransaction-response-message]

### DoReferenceTransaction Response Fields for Express Checkout [#doreferencetransaction-response-fields-for-express-checkout]

| Field                      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `PaymentInfo`<br />        | `ns:PaymentInfoType`<br /> Information about the payment such as the transaction ID, whether the payment is instant or delayed, and the settlement amount.<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `AVSCode`<br />            | `xs:string`<br /> Returned only for Direct Credit Card transactions. Address Verification System response code.<br /> Character limit: 1 single-byte alphanumeric character<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `CVV2Code`<br />           | `xs:string`<br /> Returned only for Direct Credit Card transactions. Result of the CVV2 check by PayPal.<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `BillingAgreementID`<br /> | `xs:string`<br />  Identification number of the billing agreement. When the buyer approves the billing agreement, it becomes valid and remains valid until it is canceled by the buyer.<br />  > **Note:** &#x2A;*Note:** For  [reference transactions](/docs/archive/express-checkout/integration-guide/ECReferenceTxns/), you can pass a billing agreement ID in the `ReferenceID` request field; also, a billing agreement ID is returned in the transaction response when the transaction referenced is a billing agreement. Character length and limitations: 19 single-byte alphanumeric characters<br />                                                                                                                                                                                                                                                                                                                                                                                       |
| `FMFDetails`<br />         | `ebl:FMFDetailsType`<br /> Fraud filter details.<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `PaymentAdviceCode`<br />  | `xs:string`<br /> 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 in order to avoid chargebacks. For details on the meanings of these codes, see [AVS, CVV2, and payment advice response codes](/api/nvp-soap/AVSResponseCodes/#payment-advice-codes-for-declined-payments).<br />  > **Note:** &#x2A;*Note:** If a recurring transaction is declined with a returned `PaymentAdviceCode` value of `03` or`21`, it is the merchant's responsibility to stop this recurring payment. These payment advice codes indicate that either the account was closed, fraud was involved, or the card holder has asked their bank to stop this payment for another reason. Even if a reattempted transaction is successful, it will likely result in a chargeback. |

### PaymentInfoType Fields [#paymentinfotype-fields]

| Field                             | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `TransactionID`<br />             | `xs:string`<br /> Unique transaction ID of the payment.<br />  Character length and limitations: 17 characters. [Orders](/api/nvp-soap/paypal-payments-standard/admin/auth-capture/#types) transactions have 19 characters.<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `ParentTransactionID`<br />       | `xs:string`<br /> Parent or related transaction identification number. This value in this field is for the following transaction types:<br /> Reversal — Capture of an authorized transaction.<br />Reversal — Reauthorization of a transaction.<br />Capture of an order — The value of `ParentTransactionID` is the original `OrderID`.<br />Authorization of an order — The value of `ParentTransactionID` is the original `OrderID`.<br />Capture of an order authorization.<br />Void of an order — The value of `ParentTransactionID` is the original `OrderID`.<br /> Character length and limitations: 17 characters. [Orders](/api/nvp-soap/paypal-payments-standard/admin/auth-capture/#types) transactions have 19 characters.<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `ReceiptID`<br />                 | `xs:string`<br /> Receipt identification number<br /> Character length and limitations: 16 digits in xxxx-xxxx-xxxx-xxxx format<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `TransactionType`<br />           | `ns:PaymentTransactionCodeType`<br /> The type of transaction. Value is:<br /> `cart`<br />`express-checkout`<br />Character length and limitations: 15 single-byte characters<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `PaymentType`<br />               | `ebl:PaymentCodeType`<br /> Indicates whether the payment is instant or delayed. It only applies to Express Checkout reference transactions and is not applicable to direct credit card reference transactions. Value is:<br /> `none`<br />`echeck`<br />`instant`<br />Character length and limitations: 7 single-byte characters<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `PaymentDate`<br />               | `xs:dateTime`<br /> Date and time stamp of the payment.<br /> Character length and limitations:<br /> Date and time are in UTC/GMT format. For example, `2013-08-24T05:38:48Z`.<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `GrossAmount`<br />               | `ebl:BasicAmountType`<br /> The final amount charged, including any shipping and taxes from your Merchant Profile.<br /> Character length and limitations:<br /> 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](/api/nvp-soap/currency-codes/). 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](/api/nvp-soap/currency-codes/).<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `FeeAmount`<br />                 | `ebl:BasicAmountType`<br /> PayPal fee amount charged for the transaction.<br /> Character length and limitations:<br /> 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](/api/nvp-soap/currency-codes/). 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](/api/nvp-soap/currency-codes/).<br /> \`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `SettleAmount`<br />              | `ebl:BasicAmountType`<br /> Amount deposited in your PayPal account after a currency conversion.<br /> Character length and limitations:<br /> 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](/api/nvp-soap/currency-codes/). 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](/api/nvp-soap/currency-codes/).<br /> \`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `TaxAmount`<br />                 | `ebl:BasicAmountType`<br /> Tax charged on the transaction.<br /> Character length and limitations:<br /> 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](/api/nvp-soap/currency-codes/). 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](/api/nvp-soap/currency-codes/).<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| `ExchangeRate`<br />              | `xs:string`<br /> 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.<br /> Character length and limitations: Decimal value that does not exceed 17 characters, including decimal point<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `PaymentStatus`<br />             | `ebl:PaymentStatusCodeType`<br /> Status of the payment. Value is:<br /> `None` — No status<br />`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.<br />`Completed` — The payment has been completed, and the funds have been added successfully to your account balance.<br />`Denied` — You denied the payment. This happens only if the payment was previously pending because of possible reasons described for the `PendingReason` element.<br />`Expired` — The authorization period for this payment has been reached.<br />`Failed` — The payment has failed. This happens only if the payment was made from your buyer's bank account.<br />`In-Progress` — The transaction has not terminated, for example, an authorization may be awaiting completion.<br />`Partially-Refunded` — The payment has been partially refunded.<br />`Pending` — The payment is pending. See the `PendingReason` field for more information.<br />`Refunded` — You refunded the payment.<br />`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.<br />`Processed` — A payment has been accepted.<br />`Voided` — An authorization for this transaction has been voided.<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `PendingReason`<br />             | `ebl:PendingStatusCodeType`<br /> The reason the payment is pending. Value is:<br /> `none` — No pending reason.<br />`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`.<br />`authorization` — The payment is pending because it has been authorized but not settled. You must capture the funds first.<br />`echeck` — The payment is pending because it was made by an eCheck that has not yet cleared.<br />`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`.<br />`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.<br />`order` — The payment is pending because it is part of an order that has been authorized but not settled.<br />`paymentreview` — The payment is pending while it is being reviewed by PayPal for risk.<br />`regulatoryreview` - The payment is pending while we make sure it meets regulatory requirements. You will be contacted again in 24-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.<br />`verify` —The payment is pending because you are not yet verified. You must verify your account before you can accept this payment.<br />`other` — The payment is pending for a reason other than those listed above. For more information, contact PayPal Customer Service.<br /> > **Note:** &#x2A;*Note:** `PendingReason` is returned in the response only if `PaymentStatus` is `Pending`. |
| `ReasonCode`<br />                | `ebl:ReasonCodeType`<br /> The reason for a reversal if the transaction type is reversal. Value is:<br /> `none` — No reason code.<br />`chargeback` — A reversal has occurred on this transaction due to a chargeback by your buyer.<br />`guarantee` — A reversal has occurred on this transaction due to your buyer triggering a money-back guarantee.<br />`buyer-complaint` — A reversal has occurred on this transaction due to a complaint about the transaction from your buyer.<br />`refund` — A reversal has occurred on this transaction because you have given the buyer a refund.<br />`other` — A reversal has occurred on this transaction due to a reason not listed above.<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `ProtectionEligibility`<br />     | `xs:string`<br /> Prior to version 64.4, the kind of seller protection in force for the transaction. Value is:<br /> `Eligible` — Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received.<br />`PartiallyEligible` — Merchant is protected by PayPal's Seller Protection Policy for Item Not Received.<br />`Ineligible` — Merchant is not protected under the Seller Protection Policy.<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `ProtectionEligibilityType`<br /> | `xs:string`<br /> Since version 64.4, the kind of seller protection in force for the transaction.It is one or more of the following values:<br /> `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. > **Note:** &#x2A;*Note:** If more than one of these values is returned in this field, they will be returned in a comma-delimited string; for example, `ItemNotReceivedEligible,UnauthorizedPaymentEligible`.<br /> This field is available since version 64.4.<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `StoreId`<br />                   | `xs:string`<br /> StoreId as entered in the transaction<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| `TerminalId`<br />                | `xs:string`<br /> TerminalId as entered in the transaction<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `InstrumentDetails`<br />         | [`ns:InstrumentDetailsType`](#instrumentdetailstype-fields)<br /> Type of the payment instrument.<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |

### InstrumentDetailsType Fields [#instrumentdetailstype-fields]

| Field                      | Description                                                                                                                                                                    |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `InstrumentCategory`<br /> | `xs:string`<br /> Returns the category of the instrument only when it is promotional. Value is:<br /> `1` represents PayPal Credit<br />                                       |
| `InstrumentID`<br />       | `xs:string`<br /> &#x2A;Reserved for future use.*<br /> Returns an instrument ID (issued by the external party) corresponding to the funding source used in the payment.<br /> |

### FMFDetailsType Fields [#fmfdetailstype-fields]

| Field                  | Description                                                                                    |
| ---------------------- | ---------------------------------------------------------------------------------------------- |
| `AcceptFilters`<br />  | `xs:RiskFilterListType`<br /> List of filters that recommend acceptance of the payment.<br />  |
| `DenyFilters`<br />    | `xs:RiskFilterListType`<br /> List of filters that recommend denial of the payment.<br />      |
| `PendingFilters`<br /> | `xs:RiskFilterListType`<br /> List of filters that caused the payment to become pending.<br /> |
| `ReportsFilters`<br /> | `xs:RiskFilterListType`<br /> List of filters that caused the payment to become flagged.<br /> |

### RiskFilterListType Fields [#riskfilterlisttype-fields]

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

## Deprecated Fields [#deprecated-fields]

The following fields are deprecated. Replacement fields are noted when
available.

| Deprecated field     | Replacement field                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Since version/date |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
| `REQCONFIRMSHIPPING` | No replacement. 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. > **Note:** &#x2A;*Note:** Setting this field overrides the setting you have specified in your Merchant Account Profile. Character length and limitations: One single-byte numeric character.<br /> | September 2016     |

## Additional information [#additional-information]

* [API error codes](/api/nvp-soap/errors/)