On this page
No Headings
The details for the customer who funds the payment. The API gathers this information from execution of the approval URL.
objectpayment_methodrequiredstring"bank", "paypal"The payment method.
funding_instrumentsarrayAn array of funding instruments.
itemsobjectThe customer's funding instrument that can be used to fund a payment.
credit_cardobjectThe credit card that can be used to fund a payment.
A credit card that can be used to fund a payment.
idstringThe PayPal-generated ID for the resource.
numberrequiredstringThe card number.
typerequiredstringThe card type. For example, Visa, MasterCard, and so on.
expire_monthrequiredintegerThe two-digit card expiry month, in MM format. Value is from 01 to 12.
expire_yearrequiredintegerThe four-digit card expiry year, in YYYY format.
cvv2integerThe card validation code. Supported only when making a payment but not when saving a credit card for future use.
first_namestringThe first name of the card holder.
last_namestringThe last name of the card holder.
external_customer_idstringThe facilitator-provided ID of the customer who owns this bank account. Required when storing a funding instrument or using a stored funding instrument in the PayPal vault.
statestring"expired", "ok"The state of the funding instrument.
valid_untilstringThe date and time when the credit card becomes unusable from the vault, in Internet date and time format. The valid_until parameter is not the same as the expiration month and year. The expiration month and year might be later than the valid_until date. For example, the card expires in November 2019 but the valid_until date is October 17th, 2019.
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.
billing_addressobjectA simple postal address with coarse-grained fields. Do not use for an international address. Use for backward compatibility only. Does not contain phone.
The billing address associated with this card.
line1requiredstringThe first line of the address. For example, number or street.
line2stringThe second line of the address. For example, suite or apartment number.
cityrequiredstringThe city name.
statestringcountry_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.
funding_option_idstringThe ID of the customer-selected funding option for the payment. Value is funding_instruments or funding_option_id.
payer_infoobjectThe payer information.
emailstringemailThe payer's email address.
first_namestringThe payer's first name.
last_namestringThe payer's last name.
payer_idstringThe PayPal-assigned ID for the payer.
shipping_addressobjectThe shipping address for a payment. Must be provided if it differs from the default address.
billing_addressobjectA simple postal address with coarse-grained fields. Do not use for an international address. Use for backward compatibility only. Does not contain phone.
The payer's billing address.
line1requiredstringThe first line of the address. For example, number or street.
line2stringThe second line of the address. For example, suite or apartment number.
cityrequiredstringThe city name.
statestringcountry_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.