On this page
No Headings
Executes a PayPal account-based payment with the payer_id obtained from the web approval URL.
objectpayer_idstringThe ID of the payer that PayPal passes in the return_url.
transactionsarrayAn array of transaction details. Includes the amount and item details. For update and execute payment calls, the transactions object accepts only the amount object.
itemsobjectThe cart.
reference_idstringThe merchant-provided ID for the purchase unit.
amountrequiredobjectThe amount to collect.
currencyrequiredstringThe three-character ISO-4217 currency code. PayPal does not support all currencies.
totalrequiredstringThe 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:
JPY do not support decimals.detailsobjectThe additional details about the payment amount.
Note: For an order authorization or capture, you cannot include the amount details object.subtotalstringThe subtotal amount for the items. If the request includes line items, this property is required. Maximum length is 10 characters, which includes:
Note: For an order authorization or capture, you cannot include the subtotal parameter.shippingstringThe shipping fee. Maximum length is 10 characters, which includes:
Note: For an order authorization or capture, you cannot include the shipping parameter.taxstringThe tax. Maximum length is 10 characters, which includes:
Note: For an order authorization or capture, you cannot include the tax parameter.handling_feestringThe handling fee. Maximum length is 10 characters, which includes:
Note: For an order authorization or capture, you cannot include the handling_fee parameter.shipping_discountstringThe shipping fee discount. Maximum length is 10 characters, which includes:
Note: For an order authorization or capture, you cannot include the shipping_discount parameter.insurancestringThe insurance fee. Maximum length is 10 characters, which includes:
Note: For an order authorization or capture, you cannot include the insurance parameter.gift_wrapstringThe gift wrap fee. Maximum length is 10 characters, which includes:
Note: For an order authorization or capture, you cannot include the gift_wrap parameter.payeeobjectThe payee who receives the funds and fulfills the order.
emailstringemailThe email address associated with the payee's PayPal account. For an intent of authorize or order, the email address must be associated with a confirmed PayPal business account. For an intent of sale, the email can either:
merchant_idstringThe PayPal account ID for the payee.
descriptionstringThe purchase description.
note_to_payeestringThe note to the recipient of the funds in this transaction.
customstringThe free-form field for the client's use.
invoice_numberstringThe invoice number to track this payment.
soft_descriptorstringThe 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.
payment_optionsobjectThe payment options for this transaction.
allowed_payment_methodstring"UNRESTRICTED", "INSTANT_FUNDING_SOURCE", "IMMEDIATE_PAY""UNRESTRICTED"The payment method for this transaction. This field does not apply to the credit card payment method.
item_listobjectAn array of items that are being purchased.
itemsarrayAn array of items that are being purchased.
itemsobjectThe item details.
skustringThe stock keeping unit (SKU) for the item.
namestringThe item name. If this value is greater than the maximum allowed length, the API truncates the string.
descriptionstringThe item description. Supported for only the PayPal payment method.
quantityrequiredstring^[0-9]{0,10}$The item quantity. Must be a whole number.
pricerequiredstring^[0-9]{0,10}(\.[0-9]{0,2})?$The item cost. Supports two decimal places.
currencyrequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
taxstringThe item tax. Supported only for the PayPal payment method.
shipping_addressobjectThe shipping address details.
line1requiredstringThe first line of the address. For example, number, street, and so on.
line2stringThe second line of the address. For example, suite or apartment number.
citystringThe city name.
country_coderequiredstringppaas_common_country_code_v2^([A-Z]{2}|C2)$The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use theC2country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
postal_codestringThe postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
statestringnormalization_statusstring"UNKNOWN", "UNNORMALIZED_USER_PREFERRED", "NORMALIZED", "UNNORMALIZED"The address normalization status. Returned only for payers from Brazil.
typestringThe type of address. For example, HOME_OR_WORK, GIFT, and so on.
recipient_namestringThe name of the recipient at this address.
shipping_phone_numberstringThe shipping phone number, in its canonical international format as defined by the 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.
notify_urlstringuriThe send payment notifications URL.
order_urlstringuriThe payment-related URL on the merchant site.