DoDirectPayment API Operation (NVP)

• Sale – This is a final sale for which you are requesting payment (default).
• Authorization – Authorization can be a basic authorization subject to settlement with the DoCapture API operation or a manual capture. Authorization can also be a zero amount authorization used for card verifications.

Note:

Order is not allowed for Direct Payment.

Note:

PayPal records this IP addresses as a means to detect possible fraud.

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

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.

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.

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

Note:

If the credit card type is Maestro, you must set CURRENCYCODE to GBP. In addition, you must specify either STARTDATE or ISSUENUMBER.

(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. This field must be set to a value greater than 0.

Character length and limitations: Value is a positive number (or 0 in the case of Card Verifications or Zero amount Auths). The amount cannot exceed nine (9) digits in the SOAP request and response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places; the decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. See the currency codes page for details.

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

Note: ITEMAMT is required if you specify L_AMTn.

Character length and limitations: Value is a positive number (or 0 in the case of Card Verifications or Zero amount Auths). The amount cannot exceed nine (9) digits in the SOAP request and response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places; the decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. See the currency codes page for details.

(Optional) Total shipping costs for this order.

Note: If you specify a value for SHIPPINGAMT, you must also specify a value for ITEMAMT.

Character length and limitations: Value is a positive number (or 0 in the case of Card Verifications or Zero amount Auths). The amount cannot exceed nine (9) digits in the SOAP request and response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places; the decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. See the currency codes page for details.

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

Character length and limitations: Value is a positive number (or 0 in the case of Card Verifications or Zero amount Auths). The amount cannot exceed nine (9) digits in the SOAP request and response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places; the decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. See the currency codes page for details.

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

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

(Optional) Total handling costs for this order.

Note:

If you specify a value for HANDLINGAMT, you must also specify a value for ITEMAMT.

Character length and limitations: Value is a positive number (or 0 in the case of Card Verifications or Zero amount Auths). The amount cannot exceed nine (9) digits in the SOAP request and response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places; the decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. See the currency codes page for details.

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

Note: TAXAMT is required if you specify L_TAXAMTn

Character length and limitations: Value is a positive number (or 0 in the case of Card Verifications or Zero amount Auths). The amount cannot exceed nine (9) digits in the SOAP request and response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places; the decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. See the currency codes page for details.

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.

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.

Note: PayPal recommends using the INVNUM 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.

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.

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

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.

• 1 - International shipping
• 2 - Local delivery

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

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

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

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

Note: If the PaymentAction of the request was Authorization, the value of TransactionID is your AuthorizationID for use with the DoAuthorization and DoCapture API operations.

PENDING_REASON

xs:string

Transaction is pending the Interchange Plus (IC+) processing. For merchants who opt in to IC+, PayPal waits to receive funding and the fee amount from the bank before settling the transaction to the merchant's PayPal account. While the transaction is awaiting funding, the value returned in this field is: delayed-disbursement.

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

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

Note: If a recurring transaction is declined with a returned PAYMENTADVICECODE value of 03 or 21, PayPal will cancel the recurring transaction and send a cancellation email notification to the merchant. 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.

Developers or partners who use reference transactions to provide recurring payment or subscription support for Website Payments Pro merchants (outside of PayPal Recurring Payments) are responsible for stopping the subscription and should not try again with the same card if the Payment Advice 03 and 21 codes are returned.

• Good result – 2 or D
• Bad result – 1

Attempted authentication:

• Good result – 3, 6, 8, A, or C
• Bad result – 4, 7, or 9

No liability shift: Blank, 0, or B

• 01 – Merchant Liability
• 02 – Issuer Liability

Visa:

• 05 – Issuer Liability
• 06 – Issuer Liability
• 07 – Merchant Liability