On this page
No Headings
Last updated: June 12, 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.
Captures an authorized payment. More about authorization and capture.
| Field | Description |
|---|---|
METHOD | (Required) Must be DoCapture. |
AUTHORIZATIONID | (Required) Authorization identification number of the payment you want to capture. This is the transaction ID returned from DoExpressCheckoutPayment, DoDirectPayment, or CheckOut. For point-of-sale transactions, this is the transaction ID returned by the CheckOut call when the payment action is Authorization.Character length and limitations: 19 single-byte characters maximum |
AMT | (Required) Amount to capture. Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period ( .), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page. |
CURRENCYCODE | (Optional) A 3-character currency code (default is USD). |
COMPLETETYPE | (Required) Indicates whether or not this is your last capture. Value is:
Note: If Complete, any remaining amount of the original authorized transaction is automatically voided and all remaining open authorizations are voided. |
INVNUM | (Optional) Your invoice number or other identification number that is displayed to you and to the buyer in their transaction history. The value is recorded only if the authorization you are capturing is an Express Checkout order authorization. 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: This value on DoCapture overwrites a value previously set on DoAuthorization. |
NOTE | (Optional) An informational note about this settlement that is displayed to the buyer in email and in their transaction history. Character length and limitations: 255 single-byte characters |
SOFTDESCRIPTOR | (Optional) If you provide a value in this field, the full descriptor on the buyer's statement has the following format: 'PP*|PAYPAL*''Merchant descriptor in Payment Receiving Preferences''1 space''soft descriptor'Character length and limitations: The soft descriptor can contain only alphanumeric characters, dashes, asterisks, periods, and spaces. If you pass any other characters, such as comma ( ,), PayPal returns an error code.The soft descriptor can also include a phone number, which can be toggled between the merchant's customer service number and PayPal's Customer Service number. The maximum length of the soft descriptor is 22 characters. Of this, the PayPal prefix uses either four or eight characters of the data format. The maximum length of the soft descriptor information that you can pass in this field is: 22 - len('PP * | PAYPAL *') - len('var'Descriptor in Payment Receiving Preferences'/var' + 1)For example, assume the following conditions:
PAYPAL *EBAY JanesFlow |
MSGSUBID | (Optional) A message ID used for idempotence to uniquely identify a message. This ID can later be used to request the latest results for a previous request without generating a new request. Examples of this include requests due to timeouts or errors during the original request. Character length and limitations: string of up to 38 single-byte characters. This field is available since version 92.0. |
| Field | Description |
|---|---|
STOREID | Identifier of the merchant store at which the refund is given. This field is required for point-of-sale transactions. Character length and limitations: 50 single-byte characters This field is available since version 82.0. |
TERMINALID | (Optional) ID of the terminal. Character length and limitations: 50 single-byte characters This field is available since version 82.0. |
Note: If you use version 56.0 or later of the DoCapture API, only the authorization ID, transaction ID, transaction type, payment date, gross amount, and payment status are guaranteed to be returned. If you need the values of other fields and they are not returned, you can obtain their values later by calling GetTransactionDetails or by using the reporting mechanism. Not applicable to point of sale transactions.
| Field | Description |
|---|---|
AUTHORIZATIONID | Authorization identification number you specified in the request. Character length and limits: 19 single-byte characters maximum |
MSGSUBID | (Optional) A message ID used for idempotence to uniquely identify a message. This ID can later be used to request the latest results for a previous request without generating a new request. Examples of this include requests due to timeouts or errors during the original request. Character length and limitations: string of up to 38 single-byte characters. This field is available since version 92.0. |
| Field | Description |
|---|---|
TRANSACTIONID | Unique transaction ID of the payment. Character length and limitations: 17 characters. Orders transactions have 19 characters. |
PARENTTRANSACTIONID | Parent or related transaction identification number. This field is populated for the following transaction types:
Only authorization of an order and capture of an order authorization apply to point-of-sale transactions. |
PAYMENTTYPE | Indicates whether the payment is instant or delayed. Value is:
|
ORDERTIME | Date/time stamp of the payment. Character length and limitations: Must be a valid date, in UTC/GMT format; for example, 2013-08-24T05:38:48Z. No wildcards are allowed. |
AMT | The final amount charged, including any shipping and taxes from your Merchant Profile. Shipping and taxes do not apply to point-of-sale transactions. Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period ( .), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page. |
FEEAMT | PayPal fee amount charged for the transaction. Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period ( .), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page. |
SETTLEAMT | Amount deposited in your PayPal account after a currency conversion. Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period ( .), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page. |
SETTLEAMTCURRENCYCODE | The 3-character currency code of SETTLEAMT. Supported for a maximum ten payments, where n is a digit from 0 to 9, inclusive.This field is available since version 216. |
SETTLEMENTFEEAMOUNT | Transaction fee associated with the payment in the settlement currency. Applicable only for use cases where the PayPal fee is charged in the settlement currency. Example: CNY. Supported for a maximum ten payments, where n is a digit from 0 to 9, inclusive.This field is available since version 216. |
SETTLEMENTFEECURRENCYCODE | The 3-character currency code of SETTLEMENTFEEAMOUNT. Supported for a maximum ten payments, where n is a digit from 0 to 9, inclusive.This field is available since version 216. |
EXCHANGERATE | Exchange rate if a currency conversion occurred. Relevant only if your are billing in their non-primary currency. If the customer chooses to pay with a currency other than the non-primary currency, the conversion occurs in the buyer's account. Character length and limitations: A decimal that does not exceed 17 characters, including decimal point |
PAYMENTSTATUS | Status of the payment. Value is: Note: In a successful DoCapture response for a point-of-sale authorization, the only value value is Completed.
|
PENDINGREASON | Note: PendingReason is returned in the response only if PaymentStatus is Pending. This field does not apply to capturing point-of-sale authorizations, which do not create pending payments.
|
PROTECTIONELIGIBILITY | Prior to version 64.4, the kind of seller protection in force for the transaction. Value is:
|
PROTECTIONELIGIBILITYTYPE | Since version 64.4, the kind of seller protection in force for the transaction. It is one or more of the following values:
ItemNotReceivedEligible,UnauthorizedPaymentEligible.This field is available since version 64.4. |
INSTRUMENTCATEGORY | This field holds the category of the instrument only when it is promotional. Value is:1 represents PayPal Credit2 represents PLCC (Private Label Credit Card) / Co-branded payment cards. |
INSTRUMENTID | This field holds an instrument ID (issued by the external party) corresponding to the funding source used in the payment. |
The following fields are deprecated. Replacement fields are noted when available.
| Deprecated field | Replacement field | Since Version/Date |
|---|---|---|
RECEIPTID | (No replacement.) Receipt identification number. Character length and limitations: 16 digits Empty for point-of-sale transactions. | April 2019 |
TAXAMT | (No replacement.) Tax charged on the transaction. Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period ( .), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page. | April 2019 |
TRANSACTIONTYPE | (No replacement.) The type of transaction. Value is:
| April 2019 |