Sections

Business Platforms and marketplaces Enterprise

Help

FAQs Account help Technical support API Status

APIs & SDKs

JavaScript SDK React SDK REST API Server SDKs Codes Webhook events iOS Android

Card Attributes Response

Additional attributes associated with the use of this card.

vaultobject<card_vault_response>Optional

The details about a saved Card payment source.

card_vault_response properties

4 properties

idstringOptional

The PayPal-generated ID for the saved payment source.

Length1 <= length <= 255

statusenumOptionalDeprecated

The vault status.

Match^[0-9A-Z_]+$Length1 <= length <= 255

Allowed values

"VAULTED"
"CREATED"
"APPROVED"

linksobject<link_description>[]Optional

An array of request-related HATEOAS links.

Items1 <= length <= 10

link_description properties

3 properties

hrefstringRequired

The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call.

relstringRequired

The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml).

methodenumOptional

The HTTP method required to make the related call.

customerobject<card_customer>Optional

The details about a customer in PayPal's system of record.

card_customer properties

4 properties

idstring<merchant_partner_customer_id>Optional

The unique ID for a customer generated by PayPal.

Match^[0-9a-zA-Z_-]+$Length1 <= length <= 22

email_addressstring<email>Optional

Email address of the buyer as provided to the merchant or on file with the merchant. Email Address is required if you are processing the transaction using PayPal Guest Processing which is offered to select partners and merchants. For all other use cases we do not expect partners/merchant to send email_address of their customer.

Match(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?|\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9])|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])Formatmerchant_common_email_address_v2Length3 <= length <= 254

phoneobject<phone_with_type>Optional

The phone number of the buyer as provided to the merchant or on file with the merchant. The `phone.phone_number` supports only `national_number`.

phone_with_type properties

2 properties

phone_typeenum<phone_type>Optional

The phone type.

Value in"FAX" | "HOME" | "MOBILE" | "OTHER" | "PAGER"

phone_numberobject<Phone>Required

The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).

Phone properties

1 property

national_numberstringRequired

The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).

Match^[0-9]{1,14}?$Length1 <= length <= 14

merchant_customer_idstringOptional

Merchants and partners may already have a data-store where their customer information is persisted. Use merchant_customer_id to associate the PayPal-generated customer.id to your representation of a customer.

Match^[0-9a-zA-Z-_.^*$@#]+$Length1 <= length <= 64

Back to top

Card Attributes Response

Additional attributes associated with the use of this card.

vaultobject<card_vault_response>Optional

The details about a saved Card payment source.

card_vault_response properties

4 properties

idstringOptional

The PayPal-generated ID for the saved payment source.

Length1 <= length <= 255

statusenumOptionalDeprecated

The vault status.

Match^[0-9A-Z_]+$Length1 <= length <= 255

Allowed values

"VAULTED"
"CREATED"
"APPROVED"

linksobject<link_description>[]Optional

An array of request-related HATEOAS links.

Items1 <= length <= 10

link_description properties

3 properties

hrefstringRequired

The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call.

relstringRequired

The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml).

methodenumOptional

The HTTP method required to make the related call.

customerobject<card_customer>Optional

The details about a customer in PayPal's system of record.

card_customer properties

4 properties

idstring<merchant_partner_customer_id>Optional

The unique ID for a customer generated by PayPal.

Match^[0-9a-zA-Z_-]+$Length1 <= length <= 22

email_addressstring<email>Optional

Email address of the buyer as provided to the merchant or on file with the merchant. Email Address is required if you are processing the transaction using PayPal Guest Processing which is offered to select partners and merchants. For all other use cases we do not expect partners/merchant to send email_address of their customer.

Match(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?|\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9])|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])Formatmerchant_common_email_address_v2Length3 <= length <= 254

phoneobject<phone_with_type>Optional

The phone number of the buyer as provided to the merchant or on file with the merchant. The `phone.phone_number` supports only `national_number`.

phone_with_type properties

2 properties

phone_typeenum<phone_type>Optional

The phone type.

Value in"FAX" | "HOME" | "MOBILE" | "OTHER" | "PAGER"

phone_numberobject<Phone>Required

The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).

Phone properties

1 property

national_numberstringRequired

The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).

Match^[0-9]{1,14}?$Length1 <= length <= 14

merchant_customer_idstringOptional

Merchants and partners may already have a data-store where their customer information is persisted. Use merchant_customer_id to associate the PayPal-generated customer.id to your representation of a customer.

Match^[0-9a-zA-Z-_.^*$@#]+$Length1 <= length <= 64

Card Attributes Response

card_vault_response properties

link_description properties

card_customer properties

phone_with_type properties

Phone properties

Back to top

On this page

On this page

Card Attributes Response

card_vault_response properties

link_description properties

card_customer properties

phone_with_type properties

Phone properties

Back to top

On this page

Card Attributes Response

card_vault_response properties

link_description properties

card_customer properties

phone_with_type properties

Phone properties

Back to top

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

Card Attributes Response

card_vault_response properties

link_description properties

card_customer properties

phone_with_type properties

Phone properties

Back to top

On this page