On this page
No Headings
Last updated: June 18, 2026
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 credit card payment.
Only available to: Website Payments Pro
Important: PayPal isn't accepting new users for this feature, and we require existing users to upgrade to our Advanced Debit and Credit solution that supports EMV 3DS (3DS 2.0) for PSD2. Our Advanced Debit and Credit solution enables highly customizable custom-card fields and reduced PCI Compliance requirements. For more information, see Set up advanced credit and debit card payments.
| Field | Description |
|---|---|
PaymentAction | ebl:PaymentActionCodeType(Optional) How you want to obtain payment. Value is:
Note: Order is not allowed for Direct Payment. |
CreditCard | ebl:CreditCardDetailsType(Required) Information about the credit card to be charged. |
PaymentDetails | ebl:PaymentDetailsType(Required) Information about the credit card to be charged. |
IPAddress | xs:string(Required) IP address of the buyer's browser. Note: PayPal records this IP addresses as a means to detect possible fraud. |
MerchantSessionId | xs:string(Optional) Your customer session identification token. Note: PayPal records this optional session identification token as an additional means to detect possible fraud. |
ReturnFMFDetails | xs:int(Optional) Flag to indicate whether you want the results returned by Fraud Management Filters. By default, you do not receive this information. Value is:
|
SoftDescriptor | xs:string(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.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: 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. |
SoftDescriptorCity | xs:string(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. Character length and limitations: 13 characters including special characters, such as, space, !, ", #, $, %, &, ', (, ), +, -,*, /, :, ;, <, =, >, ?, @, comma and period.If it includes the space character ( ), enclose the "<Soft-Descriptor-City>" value in double quotes. 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. |
| Field | Description |
|---|---|
CreditCardType | ebl:CreditCardType(Optional) Type of credit card. For UK, only Maestro, Mastercard, and Visa are allowable. For Canada, only Mastercard and Visa are allowable, and Interac debit cards are not supported. Value is:
Note: If the credit card type is Maestro, you must set currencyId to GBP. In addition, you must specify either StartMonth and StartYear or IssueNumber. |
CreditCardNumber | xs:string(Required) Credit card number. Character length and limitations: Numeric characters only with no spaces or punctuation. The string must conform with modulo and length required by each credit card type. |
ExpMonth | xs:int(Required) Credit card expiration month. Character length and limitations: 2 single-byte numeric characters, including leading zero |
ExpYear | xs:int(Required) Credit card expiration year. Character length and limitations: 4 single-byte numeric characters |
CVV2 | xs:stringCard Verification Value, version 2. Your Merchant Account settings determine whether this field is required. To comply with credit card processing regulations, you must not store this value after a transaction has been completed. Character length and limitations: For Visa, Mastercard, and Discover, the value is exactly 3 digits. For American Express, the value is exactly 4 digits. |
CardOwner | ns:PayerInfoType(Required) Details about the owner of the credit card. |
StartMonth | xs:int(Optional) Month that Maestro card was issued. Character length and limitations: 2-digit, zero-filled if necessary |
StartYear | xs:int(Optional) Year that Maestro card was issued. Character length and limitations: 4 digits |
IssueNumber | xs:string(Optional) Issue number of Maestro card. Character length and limitations: 2 numeric digits maximum |
| Field | Description |
|---|---|
Payer | ebl:EmailAddressType(Required) Email address of buyer. Character length and limitations: 127 single-byte characters |
PayerID | ebl:UserIDType(Optional) Unique PayPal Customer Account identification number. Character length and limitations: 13 single-byte alphanumeric characters |
PayerStatus | ebl:PayPalUser StatusCodeType(Optional) Status of buyer. Value is:
|
PayerName | ebl:PersonNameType(Optional) First and last name of buyer. |
PayerCountry | ebl:CountryCodeType(Optional) Buyer's country of residence in the form of ISO standard 3166 two-character country codes. Character length and limitations: 2 single-byte characters |
PayerBusiness | xs:string(Optional) Buyer's business name. Character length and limitations: 127 single-byte characters |
Address | xs:string(Optional) Buyer's shipping address information. |
| Field | Description |
|---|---|
Salutation | xs:string(Optional) Buyer's salutation. Character length and limitations: 20 single-byte characters |
FirstName | ebl:PersonNameType(Optional) Buyer's first name. (Required) when certain FMF settings are enabled. Character length and limitations: 64 double-byte characters |
MiddleName | ebl:NameUser(Optional) Buyer's middle name. Character length and limitations: 64 double-byte characters |
LastName | ebl:NameType(Optional) Buyer's last name. (Required) when certain FMF settings are enabled. Character length and limitations: 64 double-byte characters |
Suffix | ebl:SuffixType(Optional) Buyer's suffix. Character length and limitations: 12 single-byte characters |
| Field | Description |
|---|---|
Street1 | xs:string(Required) First street address. Character length and limitations: 100 single-byte characters |
Street2 | xs:string(Optional) Second street address. Character length and limitations: 100 single-byte characters |
CityName | xs:string(Required) Name of city. Character length and limitations: 40 single-byte characters |
StateOrProvince | xs:stringState or province. Required for transactions only if the address is in one of the following countries: Argentina, Brazil, Canada, China, Indonesia, India, Japan, Mexico, Thailand or USA. See the list of PayPal state codes. Character length and limitations: 40 single-byte characters |
Country | ebl:CountryCodeType(Required) Country code. Character length and limitations: 2 single-byte characters |
PostalCode | xs:string(Required) U.S. ZIP code or other country-specific postal code. Character length and limitations: 20 single-byte characters |
| Field | Description |
|---|---|
OrderTotal | ebl:BasicAmountType(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. Note: You must set the currencyID attribute to one of the 3-character currency codes for any of the supported PayPal currencies. 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. |
ItemTotal | ebl:BasicAmountType(Optional) Sum of cost of all items in this order. Note: You must set the currencyID attribute to one of the 3-character currency codes for any of the supported PayPal currencies. 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. |
ShippingTotal | ebl:BasicAmountType(Optional) Total shipping costs for this order. Note: You must set the currencyID attribute to one of the 3-character currency codes for any of the supported PayPal currencies. 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. |
InsuranceTotal | ebl:BasicAmountType(Optional) Total shipping insurance costs for this order. The value must be a non-negative currency amount or null if you offer insurance options. Note: You must set the currencyID attribute to one of the 3-character currency codes for any of the supported PayPal currencies. 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.InsuranceTotal is available since version 53.0. |
ShippingDiscount | ebl:BasicAmountType(Optional) Shipping discount for this order, specified as a negative number. Note: You must set the currencyID attribute to one of the 3-character currency codes for any of the supported PayPal currencies. .), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. See the currency codes page for details.ShippingDiscount is available since version 53.0. |
HandlingTotal | ebl:BasicAmountType(Optional) Total handling costs for this order. Note: You must set the currencyID attribute to one of the 3-character currency codes for any of the supported PayPal currencies. 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. |
TaxTotal | ebl:BasicAmountType(Optional) Sum of tax for all items in this order. Note: You must set the currencyID attribute to one of the 3-character currency codes for any of the supported PayPal currencies. 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. |
OrderDescription | xs:string(Optional) Description of items the buyer is purchasing. 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. |
Custom | xs:string(Optional) A free-form field for your own use. 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. |
InvoiceID | xs:string(Optional) Your own invoice or tracking number. 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. 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. |
ButtonSource | xs:string(Optional) An identification code for use by third-party applications to identify transactions. Character length and limitations: 32 single-byte alphanumeric characters |
NotifyURL | xs:string(Optional) Your URL for receiving Instant Payment Notification (IPN) about this transaction. If you do not specify this value in the request, the notification URL from your Merchant Profile is used, if one exists. Character length and limitations: 2,048 single-byte alphanumeric characters |
ShipToAddress | ns:AddressType(Optional) Address to which the order is shipped. |
PaymentDetailsItem | ebl:PaymentDetailsItemType(Optional) Details about each individual item included in the order. |
Recurring | ns:RecurringFlagType(Optional) Flag to indicate a recurring transaction. Value is:
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. |
PaymentCategoryType | ebl:PaymentCategoryType(Optional) Category of a payment. Value is: InternationalShippingLocalDeliveryPAYMENTINITIATOR
PAYMENTCATEGORY
CARDONFILE
PREVIOUSTRANSACTIONREFERENCEPayPal transaction ID previously used to charge the buyer. Shows payment processors that you have established a contract with the buyer. PREVIOUSNETWORKTRANSACTIONREFERENCE
|
| Field | Description |
|---|---|
Name | xs:string(Optional) Item name. Character length and limitations: 127 single-byte characters |
Description | xs:string(Optional) Item description. Description is available since version 53.0.Character length and limitations: 127 single-byte characters |
Amount | ebl:BasicAmountType(Optional) Cost of item. Note: You must set the currencyID attribute to one of the 3-character currency codes for any of the supported PayPal currencies. 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. |
Number | xs:string(Optional) Item number. Character length and limitations: 127 single-byte characters |
Quantity | xs:integer(Optional) Item quantity. Character length and limitations: Any positive integer |
Tax | ebl:BasicAmountType(Optional) Item sales tax. Note: You must set the currencyID attribute to one of the 3-character currency codes for any of the supported PayPal currencies. 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. |
EbayItemPayment DetailsItem | eBl:ebayItemPaymentDetailsItemType(Optional) Information relating to an auction sale on eBay. |
| Field | Description |
|---|---|
ItemNumber | xs:string(Optional) Auction item number. Character length: 765 single-byte characters |
AuctionTransaction Id | xs:string(Optional) Auction transaction identification number. Character length: 255 single-byte characters |
OrderID | xs:string(Optional) Auction order identification number. Character length: 64 single-byte characters |
| Field | Description |
|---|---|
Name | xs:stringPerson's name associated with this shipping address. It is required if using a shipping address. Character length and limitations: 32 double-byte characters |
Street1 | xs:stringFirst street address. It is required if using a shipping address. Character length and limitations: 100 single-byte characters |
Street2 | xs:string(Optional) Second street address. Character length and limitations: 100 single-byte characters |
CityName | xs:stringName of city. It is required if using a shipping address. Character length and limitations: 40 single-byte characters |
StateOrProvince | xs:stringState or province. Required for transactions only if the address is in one of the following countries: Argentina, Brazil, Canada, China, Indonesia, India, Japan, Mexico, Thailand or USA. See the list of PayPal state codes. Character length and limitations: 40 single-byte characters |
PostalCode | xs:stringU.S. ZIP code or other country-specific postal code. It is required if using a U.S. shipping address; may be required for other countries. Character length and limitations: 20 single-byte characters |
Country | ebl:CountryCodeTypeCountry code. It is required if using a shipping address. Character length and limitations: 2 single-byte characters |
| Field | Description |
|---|---|
TransactionID | xs:string(Optional) Unique transaction ID of 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. |
Amount | ebl:BasicAmountTypeThis value is the payment amount specified in the DoDirectPaymentRequest request. |
AVSCode | xs:stringAddress Verification System response code resulting from the AVS verification. See AVS Response Codes for details. Character length and limitations: 1 single-byte alphanumeric character |
CVV2Code | xs:stringResult of the CVV2 verification. See CVV2 Response Codes for details. |
TransactionPendingReason | xs:stringTransaction 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. |
FMFDetails | ebl:FMFDetailsTypeFraud filter details. |
PaymentAdviceCode | xs:stringA 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. 03 and 21 codes are returned. |
| Field | Description |
|---|---|
AcceptFilters | xs:RiskFilterListTypeList of filters that recommend acceptance of the payment. |
DenyFilters | xs:RiskFilterListTypeList of filters that recommend denial of the payment. |
PendingFilters | xs:RiskFilterListTypeList of filters that caused the payment to become pending. |
ReportsFilters | xs:RiskFilterListTypeList of filters that caused the payment to become flagged. |
| Field | Description |
|---|---|
ID | xs:intFilter ID. Value is:
|
Name | xs:stringFilter name. |
Description | xs:stringFilter description. |
| Field | Description |
|---|---|
VPAS | Visa Payer Authentication Service status. The value indicates whether Verified by Visa confirms that the information received is acceptable. It is returned only for Verified by Visa transactions. Authentication:
|
EciSubmitted3ds | Electronic Commerce Indicator (ECI) that PayPal submitted with the payment authorization request. This might not be the same value received from the merchant. In rare cases, PayPal is required to use a different ECI for authorization based on the full set of 3-D Secure values provided from the cmpi_authenticate request.Mastercard:
|