Card Attributes

Additional attributes associated with the use of this card.

Schema Information

Type:object

Properties

customer

Type: object

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

id

Type: string

Pattern: ^[0-9a-zA-Z_-]+$

Min length: 1

Max length: 22

The unique ID for a customer generated by PayPal.

email_address

Type: string

Format: merchant_common_email_address_v2

Pattern:

(?:[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])+)\])

Min length: 3

Max length: 254

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.

phone

Type: object

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_type

Type: string

Enum: "FAX", "HOME", "MOBILE", "OTHER", "PAGER"

The phone type.

phone_numberrequired

Type: object

The phone number, in its canonical international E.164 numbering plan format.

national_numberrequired

Type: string

Pattern: ^[0-9]{1,14}?$

Min length: 1

Max length: 14

The national number, in its canonical international E.164 numbering plan format. 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).

merchant_customer_id

Type: string

Pattern: ^[0-9a-zA-Z-_.^*$@#]+$

Min length: 1

Max length: 64

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.

vault

Type: object

Instruction to vault the card based on the specified strategy.

store_in_vault

Type: string

Enum: "ON_SUCCESS"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

Defines how and when the payment source gets vaulted.

verification

Type: object

Instruction to optionally verify the card based on the specified strategy.

method

Type: string

Enum: "SCA_ALWAYS", "SCA_WHEN_REQUIRED", "3D_SECURE", "AVS_CVV"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

Default: "SCA_WHEN_REQUIRED"

The method used for card verification.

Properties

customer

Type: object

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

id

Type: string

Pattern: ^[0-9a-zA-Z_-]+$

Min length: 1

Max length: 22

The unique ID for a customer generated by PayPal.

email_address

Type: string

Format: merchant_common_email_address_v2

Pattern:

(?:[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])+)\])

Min length: 3

Max length: 254

phone

Type: object

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_type

Type: string

Enum: "FAX", "HOME", "MOBILE", "OTHER", "PAGER"

The phone type.

phone_numberrequired

Type: object

The phone number, in its canonical international E.164 numbering plan format.

national_numberrequired

Type: string

Pattern: ^[0-9]{1,14}?$

Min length: 1

Max length: 14

merchant_customer_id

Type: string

Pattern: ^[0-9a-zA-Z-_.^*$@#]+$

Min length: 1

Max length: 64

vault

Type: object

Instruction to vault the card based on the specified strategy.

store_in_vault

Type: string

Enum: "ON_SUCCESS"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

Defines how and when the payment source gets vaulted.

verification

Type: object

Instruction to optionally verify the card based on the specified strategy.

method

Type: string

Enum: "SCA_ALWAYS", "SCA_WHEN_REQUIRED", "3D_SECURE", "AVS_CVV"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

Default: "SCA_WHEN_REQUIRED"

The method used for card verification.

Card Attributes

Schema Information

Properties

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

Schema Information

Properties