Payment Token Request

Payment Token Request where the source defines the type of instrument to be stored.

Schema Information

Type:object

Properties

customer

Type: object

This object defines a customer in your system. Use it to manage customer profiles, save payment methods and contact details.

id

Type: string

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

Min length: 1

Max length: 22

The unique ID for a customer in merchant's or partner's system of records.

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.

payment_sourcerequired

Type: object

The payment method to vault with the instrument details.

card

Type: object

A Resource representing a request to vault a Card.

name

Type: string

Pattern: ^.{1,300}$

Min length: 1

Max length: 300

The card holder's name as it appears on the card.

number

Type: string

Pattern: ^[0-9]{13,19}$

Min length: 13

Max length: 19

The primary account number (PAN) for the payment card.

expiry

Type: string

Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])$

Min length: 7

Max length: 7

The card expiration year and month, in Internet date format For example: 2028-04

security_code

Type: string

Pattern: ^[0-9]{3,4}$

Min length: 3

Max length: 4

The three- or four-digit security code of the card. Also known as the CVV, CVC, CVN, CVE, or CID. This parameter cannot be present in the request when payment_initiator=MERCHANT.

brand

Type: string

Enum:

"VISA", "MASTERCARD", "DISCOVER", "AMEX", "SOLO", "JCB", "STAR", "DELTA", "SWITCH", "MAESTRO", "CB_NATIONALE", "CONFIGOGA", "CONFIDIS", "ELECTRON", "CETELEM", "CHINA_UNION_PAY", "DINERS", "ELO", "HIPER", "HIPERCARD", "RUPAY", "GE", "SYNCHRONY", "EFTPOS", "CARTE_BANCAIRE", "STAR_ACCESS", "PULSE", "NYCE", "ACCEL", "UNKNOWN"

Pattern: ^[A-Z_]+$

Min length: 1

Max length: 255

The card brand or network. Typically used in the response.

billing_address

Type: object

The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.

address_line_1

Type: string

Max length: 300

The first line of the address, such as number and street, for example, 173 Drury Lane. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.

address_line_2

Type: string

Max length: 300

The second line of the address, for example, a suite or apartment number.

admin_area_2

Type: string

Max length: 120

A city, town, or village. Smaller than admin_area_level_1.

admin_area_1

Type: string

Max length: 300

The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, CA and not California. Value, by country, is:

UK. A county.
US. A state.
Canada. A province.
Japan. A prefecture.
Switzerland. A kanton.

postal_code

Type: string

Max length: 60

The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

country_coderequired

Type: string

Format: ppaas_common_country_code_v2

Pattern: ^([A-Z]{2}|C2)$

Min length: 2

Max length: 2

The 2-character ISO 3166-1 code that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

network_transaction_reference

token

Type: object

The Tokenized Payment Source representing a Request to Vault a Token.

idrequired

Type: string

Pattern: ^[0-9A-Za-z_-]+$

Min length: 1

Max length: 255

The PayPal-generated ID for the token.

typerequired

Type: string

Enum: "SETUP_TOKEN"

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

Min length: 1

Max length: 255

The tokenization method that generated the ID.

Properties

customer

Type: object

This object defines a customer in your system. Use it to manage customer profiles, save payment methods and contact details.

id

Type: string

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

Min length: 1

Max length: 22

The unique ID for a customer in merchant's or partner's system of records.

merchant_customer_id

Type: string

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

Min length: 1

Max length: 64

payment_sourcerequired

Type: object

The payment method to vault with the instrument details.

card

Type: object

A Resource representing a request to vault a Card.

name

Type: string

Pattern: ^.{1,300}$

Min length: 1

Max length: 300

The card holder's name as it appears on the card.

number

Type: string

Pattern: ^[0-9]{13,19}$

Min length: 13

Max length: 19

The primary account number (PAN) for the payment card.

expiry

Type: string

Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])$

Min length: 7

Max length: 7

The card expiration year and month, in Internet date format For example: 2028-04

security_code

Type: string

Pattern: ^[0-9]{3,4}$

Min length: 3

Max length: 4

The three- or four-digit security code of the card. Also known as the CVV, CVC, CVN, CVE, or CID. This parameter cannot be present in the request when payment_initiator=MERCHANT.

brand

Type: string

Enum:

"VISA", "MASTERCARD", "DISCOVER", "AMEX", "SOLO", "JCB", "STAR", "DELTA", "SWITCH", "MAESTRO", "CB_NATIONALE", "CONFIGOGA", "CONFIDIS", "ELECTRON", "CETELEM", "CHINA_UNION_PAY", "DINERS", "ELO", "HIPER", "HIPERCARD", "RUPAY", "GE", "SYNCHRONY", "EFTPOS", "CARTE_BANCAIRE", "STAR_ACCESS", "PULSE", "NYCE", "ACCEL", "UNKNOWN"

Pattern: ^[A-Z_]+$

Min length: 1

Max length: 255

The card brand or network. Typically used in the response.

billing_address

Type: object

The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.

address_line_1

Type: string

Max length: 300

The first line of the address, such as number and street, for example, 173 Drury Lane. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.

address_line_2

Type: string

Max length: 300

The second line of the address, for example, a suite or apartment number.

admin_area_2

Type: string

Max length: 120

A city, town, or village. Smaller than admin_area_level_1.

admin_area_1

Type: string

Max length: 300

UK. A county.
US. A state.
Canada. A province.
Japan. A prefecture.
Switzerland. A kanton.

postal_code

Type: string

Max length: 60

The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

country_coderequired

Type: string

Format: ppaas_common_country_code_v2

Pattern: ^([A-Z]{2}|C2)$

Min length: 2

Max length: 2

The 2-character ISO 3166-1 code that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

network_transaction_reference

token

Type: object

The Tokenized Payment Source representing a Request to Vault a Token.

idrequired

Type: string

Pattern: ^[0-9A-Za-z_-]+$

Min length: 1

Max length: 255

The PayPal-generated ID for the token.

typerequired

Type: string

Enum: "SETUP_TOKEN"

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

Min length: 1

Max length: 255

The tokenization method that generated the ID.

Payment Token Request

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

Payment Token Request

Schema Information

Properties