Execute approved PayPal payment

Deprecation notice: The /v1/payments endpoint is deprecated. Use the /v2/payments endpoint instead. For details, see PayPal Checkout Basic Integration.

Executes a PayPal payment that the customer has approved. You can optionally update one or more transactions when you execute the payment.

Important: This call works only after a customer has approved the payment. For more information, learn about PayPal payments.

Authorization

AuthorizationBearer <token>

Oauth 2.0 authentication

In: header

Scope: https://api.paypal.com/v1/payments/.*

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

payer_idstringOptional

The ID of the payer that PayPal passes in the `return_url`.

transactionsobject<cart_base>[]Optional

An array of transaction details. Includes the amount and item details. For update and execute payment calls, the `transactions` object accepts only the `amount` object.

cart_base properties

12 properties

reference_idstringOptional

The merchant-provided ID for the purchase unit.

Length0 <= length <= 256

amountobject<amount>Required

The amount to collect.

amount properties

3 properties

currencystringRequired

The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/). PayPal does not support all currencies.

totalstringRequired

The total amount charged to the payee by the payer. For refunds, represents the amount that the payee refunds to the original payer. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.
For currencies like `JPY` do not support decimals.

detailsobject<Payment Amount Details>Optional

The additional details about the payment amount.

Note: For an order authorization or capture, you cannot include the amount details object.

Payment Amount Details properties

7 properties

subtotalstringOptional

The subtotal amount for the items. If the request includes line items, this property is **required**. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Note: For an order authorization or capture, you cannot include the subtotal parameter.

shippingstringOptional

The shipping fee. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Note: For an order authorization or capture, you cannot include the shipping parameter.

taxstringOptional

The tax. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Note: For an order authorization or capture, you cannot include the tax parameter.

handling_feestringOptional

The handling fee. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Supported for the PayPal payment method only.

Note: For an order authorization or capture, you cannot include the handling_fee parameter.

shipping_discountstringOptional

The shipping fee discount. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Supported for the PayPal payment method only.

Note: For an order authorization or capture, you cannot include the shipping_discount parameter.

insurancestringOptional

The insurance fee. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Supported only for the PayPal payment method.

Note: For an order authorization or capture, you cannot include the insurance parameter.

gift_wrapstringOptional

The gift wrap fee. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Note: For an order authorization or capture, you cannot include the gift_wrap parameter.

payeeobject<payee>Optional

The payee who receives the funds and fulfills the order.

descriptionstringOptional

The purchase description.

Length0 <= length <= 127

note_to_payeestringOptional

The note to the recipient of the funds in this transaction.

Length0 <= length <= 255

customstringOptional

The free-form field for the client's use.

Length0 <= length <= 127

invoice_numberstringOptional

The invoice number to track this payment.

Length0 <= length <= 127

soft_descriptorstringOptional

The payment descriptor on account transactions on the customer's credit card statement, that PayPal sends to processors. The maximum length of the soft descriptor information that you can pass in the API field is 22 characters, in the following format:

22 - len(PAYPAL * (8)) - len(Descriptor in Payment Receiving Preferences of Merchant account + 1)

The PAYPAL prefix uses 8 characters.

The soft descriptor supports the following ASCII characters:

Alphanumeric characters
Dashes
Asterisks
Periods (.)
Spaces

For Wallet payments marketplace integrations:

The merchant descriptor in the Payment Receiving Preferences must be the marketplace name.
You can't use the remaining space to show the customer service number.
The remaining spaces can be a combination of seller name and country.

For unbranded payments (Direct Card) marketplace integrations, use a combination of the seller name and phone number.

Length0 <= length <= 22

payment_optionsobject<Payment Options>Optional

The payment options for this transaction.

item_listobject<Item List>Optional

An array of items that are being purchased.

Item List properties

3 properties

itemsobject<item>[]Optional

An array of items that are being purchased.

shipping_addressobject<shipping_address>Optional

The shipping address details.

shipping_address properties

9 properties

line1stringRequired

The first line of the address. For example, number, street, and so on.

Length0 <= length <= 300

line2stringOptional

The second line of the address. For example, suite or apartment number.

Length0 <= length <= 300

citystringOptional

The city name.

Length0 <= length <= 64

country_codestring<country_code>Required

The [two-character ISO 3166-1 code](/docs/api/reference/country-codes/) that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

Match^([A-Z]{2}|C2)$Formatppaas_common_country_code_v2Length2 <= length <= 2

postal_codestringOptional

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).

statestringOptional

The [code](/docs/integration/direct/rest/state-codes/) for a US state or the equivalent for other countries. Required for transactions if the address is in one of these countries: [Argentina](/docs/integration/direct/rest/state-codes/#argentina), [Brazil](/docs/integration/direct/rest/state-codes/#brazil), [Canada](/docs/integration/direct/rest/state-codes/#canada), [China](/docs/integration/direct/rest/state-codes/#china), [India](/docs/integration/direct/rest/state-codes/#india), [Italy](/docs/integration/direct/rest/state-codes/#italy), [Japan](/docs/integration/direct/rest/state-codes/#japan), [Mexico](/docs/integration/direct/rest/state-codes/#mexico), [Thailand](/docs/integration/direct/rest/state-codes/#thailand), or [United States](/docs/integration/direct/rest/state-codes/#usa).

Length0 <= length <= 300

phonestringOptional

The phone number, in [E.123 format](https://www.itu.int/rec/T-REC-E.123-200102-I/en). Maximum length is 50 characters.

Formatphone

typestringOptional

The type of address. For example, `HOME_OR_WORK`, `GIFT`, and so on.

recipient_namestringOptional

The name of the recipient at this address.

Length0 <= length <= 127

shipping_phone_numberstringOptional

The shipping phone number, in its canonical international format as defined by the [E.164](https://en.wikipedia.org/wiki/E.164) numbering plan. Enables merchants to share payer’s contact number with PayPal for the current payment. The final contact number for the payer who is associated with the transaction might be the same as or different from the `shipping_phone_number` based on the payer’s action on PayPal.

Length1 <= length <= 50

notify_urlstringOptional

The send payment notifications URL.

FormaturiLength0 <= length <= 2048

order_urlstringOptional

The payment-related URL on the merchant site.

FormaturiLength0 <= length <= 2048

Response Body

`application/json`

curl -X POST "https://example.com/v1/payments/payment/string/execute" \  -H "Content-Type: application/json" \  -d '{    "payer_id": "CR87QHB7JTRSC"  }'

{  "id": "string",  "intent": "sale",  "payer": {    "payment_method": "credit_card",    "status": "VERIFIED",    "funding_instruments": [      {        "credit_card_token": {          "credit_card_id": "string",          "payer_id": "string",          "external_customer_id": "string",          "last4": "stri",          "type": "string",          "expire_month": 1,          "expire_year": "stri"        }      }    ],    "payer_info": {      "email": "[email protected]",      "salutation": "string",      "first_name": "string",      "middle_name": "string",      "last_name": "string",      "suffix": "string",      "payer_id": "string",      "birth_date": "2019-08-24T14:15:22Z",      "tax_id": "string",      "tax_id_type": "BR_CPF",      "billing_address": {        "line1": "string",        "line2": "string",        "city": "string",        "country_code": "st",        "postal_code": "string",        "state": "string",        "phone": "string",        "normalization_status": "UNKNOWN",        "type": "string"      },      "shipping_address": {        "line1": "string",        "line2": "string",        "city": "string",        "country_code": "st",        "postal_code": "string",        "state": "string",        "phone": "string",        "normalization_status": "UNKNOWN",        "type": "string",        "recipient_name": "string"      }    }  },  "application_context": {    "brand_name": "string",    "locale": "string",    "landing_page": "string",    "shipping_preference": "NO_SHIPPING",    "user_action": "string",    "preferred_payment_source": {      "token": {        "id": "string",        "type": "BILLING_AGREEMENT"      }    },    "payment_pattern": "CUSTOMER_PRESENT_ONETIME_PURCHASE"  },  "transactions": [    {      "amount": {        "currency": "string",        "total": "string",        "details": {          "subtotal": "string",          "shipping": "string",          "tax": "string",          "handling_fee": "string",          "shipping_discount": "string",          "insurance": "string",          "gift_wrap": "string"        }      },      "payee": {        "email": "[email protected]",        "merchant_id": "string"      },      "description": "string",      "note_to_payee": "string",      "custom": "string",      "invoice_number": "string",      "soft_descriptor": "string",      "payment_options": {        "allowed_payment_method": "UNRESTRICTED"      },      "item_list": {        "items": [          {            "sku": "string",            "name": "string",            "description": "string",            "quantity": "string",            "price": "string",            "currency": "str",            "tax": "string"          }        ],        "shipping_address": {          "line1": "string",          "line2": "string",          "city": "string",          "country_code": "st",          "postal_code": "string",          "state": "string",          "phone": "string",          "normalization_status": "UNKNOWN",          "type": "string",          "recipient_name": "string"        },        "shipping_method": "string",        "shipping_phone_number": "string"      },      "notify_url": "http://example.com",      "related_resources": [        {          "sale": {            "id": "string",            "amount": {              "currency": "string",              "total": "string",              "details": {                "subtotal": "string",                "shipping": "string",                "tax": "string",                "handling_fee": "string",                "shipping_discount": "string",                "insurance": "string",                "gift_wrap": "string"              }            },            "payment_mode": "INSTANT_TRANSFER",            "state": "completed",            "reason_code": "CHARGEBACK",            "protection_eligibility": "ELIGIBLE",            "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE",            "clearing_time": "2019-08-24T14:15:22Z",            "payment_hold_status": "HELD",            "payment_hold_reasons": [              {                "payment_hold_reason": "PAYMENT_HOLD"              }            ],            "transaction_fee": {              "currency": "string",              "value": "string"            },            "receivable_amount": {              "currency": "string",              "value": "string"            },            "transaction_fee_in_receivable_currency": {              "currency": "string",              "value": "string"            },            "exchange_rate": "string",            "fmf_details": {              "filter_type": "ACCEPT",              "filter_id": "AVS_NO_MATCH",              "name": "string",              "description": "string"            },            "receipt_id": "string",            "parent_payment": "string",            "processor_response": {              "response_code": "stri",              "avs_code": "s",              "cvv_code": "s",              "advice_code": "01_NEW_ACCOUNT_INFORMATION",              "eci_submitted": "string",              "vpas": "string"            },            "billing_agreement_id": "string",            "create_time": "2019-08-24T14:15:22Z",            "update_time": "2019-08-24T14:15:22Z",            "links": [              {                "href": "string",                "rel": "string",                "method": "GET"              }            ]          },          "authorization": {            "id": "string",            "amount": {              "currency": "string",              "total": "string",              "details": {                "subtotal": "string",                "shipping": "string",                "tax": "string",                "handling_fee": "string",                "shipping_discount": "string",                "insurance": "string",                "gift_wrap": "string"              }            },            "payment_mode": "INSTANT_TRANSFER",            "state": "pending",            "reason_code": "AUTHORIZATION",            "pending_reason": "AUTHORIZATION",            "protection_eligibility": "ELIGIBLE",            "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE",            "fmf_details": {              "filter_type": "ACCEPT",              "filter_id": "AVS_NO_MATCH",              "name": "string",              "description": "string"            },            "parent_payment": "string",            "processor_response": {              "response_code": "stri",              "avs_code": "s",              "cvv_code": "s",              "advice_code": "01_NEW_ACCOUNT_INFORMATION",              "eci_submitted": "string",              "vpas": "string"            },            "valid_until": "2019-08-24T14:15:22Z",            "create_time": "2019-08-24T14:15:22Z",            "update_time": "2019-08-24T14:15:22Z",            "receipt_id": "string",            "links": [              {                "href": "string",                "rel": "string",                "method": "GET"              }            ]          },          "order": {            "id": "string",            "amount": {              "currency": "string",              "total": "string",              "details": {                "subtotal": "string",                "shipping": "string",                "tax": "string",                "handling_fee": "string",                "shipping_discount": "string",                "insurance": "string",                "gift_wrap": "string"              }            },            "payment_mode": "INSTANT_TRANSFER",            "state": "PENDING",            "reason_code": "PAYER_SHIPPING_UNCONFIRMED",            "pending_reason": "payer_shipping_unconfirmed",            "protection_eligibility": "ELIGIBLE",            "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE",            "parent_payment": "string",            "fmf_details": {              "filter_type": "ACCEPT",              "filter_id": "AVS_NO_MATCH",              "name": "string",              "description": "string"            },            "create_time": "2019-08-24T14:15:22Z",            "update_time": "2019-08-24T14:15:22Z",            "links": [              {                "href": "string",                "rel": "string",                "method": "GET"              }            ]          },          "capture": {            "id": "string",            "amount": {              "currency": "string",              "total": "string",              "details": {                "subtotal": "string",                "shipping": "string",                "tax": "string",                "handling_fee": "string",                "shipping_discount": "string",                "insurance": "string",                "gift_wrap": "string"              }            },            "is_final_capture": false,            "state": "pending",            "reason_code": "CHARGEBACK",            "parent_payment": "string",            "invoice_number": "string",            "transaction_fee": {              "currency": "string",              "value": "string"            },            "transaction_fee_in_receivable_currency": {              "currency": "string",              "value": "string"            },            "receivable_amount": {              "currency": "string",              "value": "string"            },            "exchange_rate": "string",            "note_to_payer": "string",            "create_time": "2019-08-24T14:15:22Z",            "update_time": "2019-08-24T14:15:22Z",            "links": [              {                "href": "string",                "rel": "string",                "method": "GET"              }            ]          },          "refund": {            "id": "string",            "amount": {              "currency": "string",              "total": "string",              "details": {                "subtotal": "string",                "shipping": "string",                "tax": "string",                "handling_fee": "string",                "shipping_discount": "string",                "insurance": "string",                "gift_wrap": "string"              }            },            "state": "pending",            "reason": "string",            "invoice_number": "string",            "sale_id": "string",            "capture_id": "string",            "parent_payment": "string",            "description": "string",            "create_time": "2019-08-24T14:15:22Z",            "update_time": "2019-08-24T14:15:22Z",            "links": [              {                "href": "string",                "rel": "string",                "method": "GET"              }            ]          }        }      ]    }  ],  "state": "created",  "experience_profile_id": "string",  "note_to_payer": "string",  "redirect_urls": {    "return_url": "http://example.com",    "cancel_url": "http://example.com"  },  "failure_reason": "UNABLE_TO_COMPLETE_TRANSACTION",  "create_time": "2019-08-24T14:15:22Z",  "update_time": "2019-08-24T14:15:22Z",  "links": [    {      "href": "string",      "rel": "string",      "method": "GET"    }  ]}

Header Parameters

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

payer_idstringOptional

The ID of the payer that PayPal passes in the `return_url`.

transactionsobject<cart_base>[]Optional

An array of transaction details. Includes the amount and item details. For update and execute payment calls, the `transactions` object accepts only the `amount` object.

cart_base properties

12 properties

reference_idstringOptional

The merchant-provided ID for the purchase unit.

Length0 <= length <= 256

amountobject<amount>Required

The amount to collect.

amount properties

3 properties

currencystringRequired

The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/). PayPal does not support all currencies.

totalstringRequired

The total amount charged to the payee by the payer. For refunds, represents the amount that the payee refunds to the original payer. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.
For currencies like `JPY` do not support decimals.

detailsobject<Payment Amount Details>Optional

The additional details about the payment amount.

Note: For an order authorization or capture, you cannot include the amount details object.

Payment Amount Details properties

7 properties

subtotalstringOptional

The subtotal amount for the items. If the request includes line items, this property is **required**. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Note: For an order authorization or capture, you cannot include the subtotal parameter.

shippingstringOptional

The shipping fee. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Note: For an order authorization or capture, you cannot include the shipping parameter.

taxstringOptional

The tax. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Note: For an order authorization or capture, you cannot include the tax parameter.

handling_feestringOptional

The handling fee. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Supported for the PayPal payment method only.

Note: For an order authorization or capture, you cannot include the handling_fee parameter.

shipping_discountstringOptional

The shipping fee discount. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Supported for the PayPal payment method only.

Note: For an order authorization or capture, you cannot include the shipping_discount parameter.

insurancestringOptional

The insurance fee. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Supported only for the PayPal payment method.

Note: For an order authorization or capture, you cannot include the insurance parameter.

gift_wrapstringOptional

The gift wrap fee. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Note: For an order authorization or capture, you cannot include the gift_wrap parameter.

payeeobject<payee>Optional

The payee who receives the funds and fulfills the order.

descriptionstringOptional

The purchase description.

Length0 <= length <= 127

note_to_payeestringOptional

The note to the recipient of the funds in this transaction.

Length0 <= length <= 255

customstringOptional

The free-form field for the client's use.

Length0 <= length <= 127

invoice_numberstringOptional

The invoice number to track this payment.

Length0 <= length <= 127

soft_descriptorstringOptional

22 - len(PAYPAL * (8)) - len(Descriptor in Payment Receiving Preferences of Merchant account + 1)

The PAYPAL prefix uses 8 characters.

The soft descriptor supports the following ASCII characters:

Alphanumeric characters
Dashes
Asterisks
Periods (.)
Spaces

For Wallet payments marketplace integrations:

The merchant descriptor in the Payment Receiving Preferences must be the marketplace name.
You can't use the remaining space to show the customer service number.
The remaining spaces can be a combination of seller name and country.

For unbranded payments (Direct Card) marketplace integrations, use a combination of the seller name and phone number.

Length0 <= length <= 22

payment_optionsobject<Payment Options>Optional

The payment options for this transaction.

item_listobject<Item List>Optional

An array of items that are being purchased.

Item List properties

3 properties

itemsobject<item>[]Optional

An array of items that are being purchased.

shipping_addressobject<shipping_address>Optional

The shipping address details.

shipping_address properties

9 properties

line1stringRequired

The first line of the address. For example, number, street, and so on.

Length0 <= length <= 300

line2stringOptional

The second line of the address. For example, suite or apartment number.

Length0 <= length <= 300

citystringOptional

The city name.

Length0 <= length <= 64

country_codestring<country_code>Required

The [two-character ISO 3166-1 code](/docs/api/reference/country-codes/) that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

Match^([A-Z]{2}|C2)$Formatppaas_common_country_code_v2Length2 <= length <= 2

postal_codestringOptional

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).

statestringOptional

Length0 <= length <= 300

phonestringOptional

The phone number, in [E.123 format](https://www.itu.int/rec/T-REC-E.123-200102-I/en). Maximum length is 50 characters.

Formatphone

typestringOptional

The type of address. For example, `HOME_OR_WORK`, `GIFT`, and so on.

recipient_namestringOptional

The name of the recipient at this address.

Length0 <= length <= 127

shipping_phone_numberstringOptional

Length1 <= length <= 50

notify_urlstringOptional

The send payment notifications URL.

FormaturiLength0 <= length <= 2048

order_urlstringOptional

The payment-related URL on the merchant site.

FormaturiLength0 <= length <= 2048

{ "id": "string", "intent": "sale", "payer": { "payment_method": "credit_card", "status": "VERIFIED", "funding_instruments": [ { "credit_card_token": { "credit_card_id": "string", "payer_id": "string", "external_customer_id": "string", "last4": "stri", "type": "string", "expire_month": 1, "expire_year": "stri" } } ], "payer_info": { "email": "[email protected]", "salutation": "string", "first_name": "string", "middle_name": "string", "last_name": "string", "suffix": "string", "payer_id": "string", "birth_date": "2019-08-24T14:15:22Z", "tax_id": "string", "tax_id_type": "BR_CPF", "billing_address": { "line1": "string", "line2": "string", "city": "string", "country_code": "st", "postal_code": "string", "state": "string", "phone": "string", "normalization_status": "UNKNOWN", "type": "string" }, "shipping_address": { "line1": "string", "line2": "string", "city": "string", "country_code": "st", "postal_code": "string", "state": "string", "phone": "string", "normalization_status": "UNKNOWN", "type": "string", "recipient_name": "string" } } }, "application_context": { "brand_name": "string", "locale": "string", "landing_page": "string", "shipping_preference": "NO_SHIPPING", "user_action": "string", "preferred_payment_source": { "token": { "id": "string", "type": "BILLING_AGREEMENT" } }, "payment_pattern": "CUSTOMER_PRESENT_ONETIME_PURCHASE" }, "transactions": [ { "amount": { "currency": "string", "total": "string", "details": { "subtotal": "string", "shipping": "string", "tax": "string", "handling_fee": "string", "shipping_discount": "string", "insurance": "string", "gift_wrap": "string" } }, "payee": { "email": "[email protected]", "merchant_id": "string" }, "description": "string", "note_to_payee": "string", "custom": "string", "invoice_number": "string", "soft_descriptor": "string", "payment_options": { "allowed_payment_method": "UNRESTRICTED" }, "item_list": { "items": [ { "sku": "string", "name": "string", "description": "string", "quantity": "string", "price": "string", "currency": "str", "tax": "string" } ], "shipping_address": { "line1": "string", "line2": "string", "city": "string", "country_code": "st", "postal_code": "string", "state": "string", "phone": "string", "normalization_status": "UNKNOWN", "type": "string", "recipient_name": "string" }, "shipping_method": "string", "shipping_phone_number": "string" }, "notify_url": "http://example.com", "related_resources": [ { "sale": { "id": "string", "amount": { "currency": "string", "total": "string", "details": { "subtotal": "string", "shipping": "string", "tax": "string", "handling_fee": "string", "shipping_discount": "string", "insurance": "string", "gift_wrap": "string" } }, "payment_mode": "INSTANT_TRANSFER", "state": "completed", "reason_code": "CHARGEBACK", "protection_eligibility": "ELIGIBLE", "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE", "clearing_time": "2019-08-24T14:15:22Z", "payment_hold_status": "HELD", "payment_hold_reasons": [ { "payment_hold_reason": "PAYMENT_HOLD" } ], "transaction_fee": { "currency": "string", "value": "string" }, "receivable_amount": { "currency": "string", "value": "string" }, "transaction_fee_in_receivable_currency": { "currency": "string", "value": "string" }, "exchange_rate": "string", "fmf_details": { "filter_type": "ACCEPT", "filter_id": "AVS_NO_MATCH", "name": "string", "description": "string" }, "receipt_id": "string", "parent_payment": "string", "processor_response": { "response_code": "stri", "avs_code": "s", "cvv_code": "s", "advice_code": "01_NEW_ACCOUNT_INFORMATION", "eci_submitted": "string", "vpas": "string" }, "billing_agreement_id": "string", "create_time": "2019-08-24T14:15:22Z", "update_time": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "method": "GET" } ] }, "authorization": { "id": "string", "amount": { "currency": "string", "total": "string", "details": { "subtotal": "string", "shipping": "string", "tax": "string", "handling_fee": "string", "shipping_discount": "string", "insurance": "string", "gift_wrap": "string" } }, "payment_mode": "INSTANT_TRANSFER", "state": "pending", "reason_code": "AUTHORIZATION", "pending_reason": "AUTHORIZATION", "protection_eligibility": "ELIGIBLE", "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE", "fmf_details": { "filter_type": "ACCEPT", "filter_id": "AVS_NO_MATCH", "name": "string", "description": "string" }, "parent_payment": "string", "processor_response": { "response_code": "stri", "avs_code": "s", "cvv_code": "s", "advice_code": "01_NEW_ACCOUNT_INFORMATION", "eci_submitted": "string", "vpas": "string" }, "valid_until": "2019-08-24T14:15:22Z", "create_time": "2019-08-24T14:15:22Z", "update_time": "2019-08-24T14:15:22Z", "receipt_id": "string", "links": [ { "href": "string", "rel": "string", "method": "GET" } ] }, "order": { "id": "string", "amount": { "currency": "string", "total": "string", "details": { "subtotal": "string", "shipping": "string", "tax": "string", "handling_fee": "string", "shipping_discount": "string", "insurance": "string", "gift_wrap": "string" } }, "payment_mode": "INSTANT_TRANSFER", "state": "PENDING", "reason_code": "PAYER_SHIPPING_UNCONFIRMED", "pending_reason": "payer_shipping_unconfirmed", "protection_eligibility": "ELIGIBLE", "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE", "parent_payment": "string", "fmf_details": { "filter_type": "ACCEPT", "filter_id": "AVS_NO_MATCH", "name": "string", "description": "string" }, "create_time": "2019-08-24T14:15:22Z", "update_time": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "method": "GET" } ] }, "capture": { "id": "string", "amount": { "currency": "string", "total": "string", "details": { "subtotal": "string", "shipping": "string", "tax": "string", "handling_fee": "string", "shipping_discount": "string", "insurance": "string", "gift_wrap": "string" } }, "is_final_capture": false, "state": "pending", "reason_code": "CHARGEBACK", "parent_payment": "string", "invoice_number": "string", "transaction_fee": { "currency": "string", "value": "string" }, "transaction_fee_in_receivable_currency": { "currency": "string", "value": "string" }, "receivable_amount": { "currency": "string", "value": "string" }, "exchange_rate": "string", "note_to_payer": "string", "create_time": "2019-08-24T14:15:22Z", "update_time": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "method": "GET" } ] }, "refund": { "id": "string", "amount": { "currency": "string", "total": "string", "details": { "subtotal": "string", "shipping": "string", "tax": "string", "handling_fee": "string", "shipping_discount": "string", "insurance": "string", "gift_wrap": "string" } }, "state": "pending", "reason": "string", "invoice_number": "string", "sale_id": "string", "capture_id": "string", "parent_payment": "string", "description": "string", "create_time": "2019-08-24T14:15:22Z", "update_time": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "method": "GET" } ] } } ] } ], "state": "created", "experience_profile_id": "string", "note_to_payer": "string", "redirect_urls": { "return_url": "http://example.com", "cancel_url": "http://example.com" }, "failure_reason": "UNABLE_TO_COMPLETE_TRANSACTION", "create_time": "2019-08-24T14:15:22Z", "update_time": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "method": "GET" } ]}

Authorization

Path Parameters

Header Parameters

Request Body

cart_base properties

amount properties

Payment Amount Details properties

payee properties

Payment Options properties

Item List properties

item properties

shipping_address properties

Response Body

`application/json`

`application/json`

On this page

On this page

On this page

Execute approved PayPal payment

Authorization

Path Parameters

Header Parameters

Request Body

cart_base properties

amount properties

Payment Amount Details properties

payee properties

Payment Options properties

Item List properties

item properties

shipping_address properties

Response Body

`application/json`

`application/json`

On this page

On this page

Execute approved PayPal payment

cart_base properties

amount properties

Payment Amount Details properties

payee properties

Payment Options properties

Item List properties

item properties

shipping_address properties

200application/json

defaultapplication/json

On this page

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Execute approved PayPal payment

cart_base properties

amount properties

Payment Amount Details properties

payee properties

Payment Options properties

Item List properties

item properties

shipping_address properties

200application/json

defaultapplication/json

On this page

On this page

`application/json`

`application/json`

`application/json`

`application/json`