On this page
No Headings
An execute order request.
objectdisbursement_moderequiredstring"INSTANT", "DELAYED"Indicates whether to disburse money instantly or later.
payerobjectThe source of the funds for this payment. Either a PayPal account or a credit card.
payment_methodstring"credit_card", "bank", "paypal", "pay_upon_invoice", "carrier", "alternate_payment"The payment method. Value is PayPal Wallet payment, bank direct debit, or direct credit card.
statusstring"VERIFIED", "UNVERIFIED"The status of payer's PayPal account.
funding_instrumentsarrayAn array of a single funding instrument for the current payment. Valid only and required for the credit card payment method. The array must include either a credit_card or credit_card_token object. If the array contains more than one instrument, the payment is declined.
itemsobjectThe funding instrument details. An instance of this schema is valid if and only if it validates against exactly one of these supported properties.
credit_cardobjectDeprecated. The credit card details. You can use this instrument to fund a payment. Use a payment card instead.
numberrequiredstringThe credit card number. Value is numeric characters only with no spaces or punctuation. Must conform to the modulo and length required by each credit card type. Redacted in responses.
typerequiredstringThe credit card type. Value is visa, mastercard, discover, or amex. Do not use these lowercase values for display.
expire_monthrequiredintegerThe expiration month with no leading zero. Value is from 1 to 12.
expire_yearrequiredintegerThe four-digit expiration year.
cvv2stringThe three- to four-digit card validation code.
first_namestringThe card holder's first name.
last_namestringThe card holder's last name.
billing_addressobjectThe billing address for this card.
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.
linksarrayAn array of request-related HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstringThe complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.
relrequiredstringThe link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
methodstring"GET", "POST", "PUT", "DELETE", "HEAD", "CONNECT", "OPTIONS", "PATCH"The HTTP method required to make the related call.
credit_card_tokenobjectThe tokenized credit card details. You can use this instrument to fund a payment.
credit_card_idrequiredstringThe ID of credit card that is stored in the PayPal vault.
payer_idstringA unique ID that you can assign and track when you store a credit card in the vault or use a vaulted credit card. This ID can help to avoid unintentional use or misuse of credit cards and can be any value, such as a UUID, user name, or email address. Required when you use a vaulted credit card and if a payer_id was originally provided when you vaulted the credit card.
last4stringThe last four digits of the stored credit card number.
typestringThe credit card type. Value is visa, mastercard, discover, or amex. Do not use these lowercase values for display.
expire_monthintegerThe expiration month with no leading zero. Value is from 1 to 12.
expire_yearintegerThe four-digit expiration year.
payer_infoobjectThe payer information.
emailstringemailThe payer's email address. Maximum length is 127 characters.
salutationstringThe payer's salutation.
first_namestringThe payer's first name.
middle_namestringThe payer's middle name.
last_namestringThe payer's last name.
suffixstringThe payer's suffix.
payer_idstringThe PayPal-assigned encrypted payer ID.
birth_datestringdate-timeThe birth date of the payer, in Internet date format. For example, 1990-04-12.
tax_idstringThe payer’s tax ID. Supported for the PayPal payment method only.
tax_id_typestring"BR_CPF", "BR_CNPJ"The payer’s tax ID type. Supported for the PayPal payment method only.
billing_addressobjectThe payer's billing address.
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.
shipping_addressobjectDeprecated. The shipping address. Use the shipping address for the purchase unit or at the root level of the checkout session.
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.