Business Platforms and marketplacesPlatforms Enterprise

Business Platforms and marketplaces Enterprise

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

Payment Token Request

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

customerobject<Customer Request>Optional

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

Customer Request properties

2 properties

idstring<merchant_partner_customer_id>Optional

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

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

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

payment_sourceobject<definitions-payment_source>Required

The payment method to vault with the instrument details.

definitions-payment_source properties

2 properties

cardobject<Card Request>Optional

A Resource representing a request to vault a Card.

Card Request properties

7 properties

namestringOptional

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

Match^.{1,300}$Length1 <= length <= 300

numberstringOptional

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

Match^[0-9]{13,19}$Length13 <= length <= 19

expirystring<date_year_month>Optional

The card expiration year and month, in [Internet date format](https://tools.ietf.org/html/rfc3339#section-5.6) For example: 2028-04

Match^[0-9]{4}-(0[1-9]|1[0-2])$Length7 <= length <= 7

security_codestringOptional

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`.

Match^[0-9]{3,4}$Length3 <= length <= 4

brandenum<card_brand>Optional

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

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

Allowed values

"VISA"
"MASTERCARD"
"DISCOVER"
"AMEX"
"SOLO"
"JCB"
"STAR"
"DELTA"
"SWITCH"
"MAESTRO"
"CB_NATIONALE"
"CONFIGOGA"

billing_addressobject<Portable Postal Address (Medium-Grained)>Optional

The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).

Portable Postal Address (Medium-Grained) properties

6 properties

address_line_1stringOptional

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.

Length0 <= length <= 300

address_line_2stringOptional

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

Length0 <= length <= 300

admin_area_2stringOptional

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

Length0 <= length <= 120

admin_area_1stringOptional

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*.

Length0 <= length <= 300

postal_codestringOptional

The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).

Length0 <= length <= 60

country_codestring<country_code>Required

The [2-character ISO 3166-1 code](/api/rest/reference/country-codes/) 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.

Match^([A-Z]{2}|C2)$Formatppaas_common_country_code_v2Length2 <= length <= 2

network_transaction_referencenetwork_transaction_reference_requestOptional

tokenobject<token_id_request>Optional

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

token_id_request properties

2 properties

idstringRequired

The PayPal-generated ID for the token.

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

typeenumRequired

The tokenization method that generated the ID.

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

Allowed values

"SETUP_TOKEN"

Back to top

Payment Token Request

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

customerobject<Customer Request>Optional

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

Customer Request properties

2 properties

idstring<merchant_partner_customer_id>Optional

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

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

merchant_customer_idstringOptional

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

payment_sourceobject<definitions-payment_source>Required

The payment method to vault with the instrument details.

definitions-payment_source properties

2 properties

cardobject<Card Request>Optional

A Resource representing a request to vault a Card.

Card Request properties

7 properties

namestringOptional

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

Match^.{1,300}$Length1 <= length <= 300

numberstringOptional

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

Match^[0-9]{13,19}$Length13 <= length <= 19

expirystring<date_year_month>Optional

The card expiration year and month, in [Internet date format](https://tools.ietf.org/html/rfc3339#section-5.6) For example: 2028-04

Match^[0-9]{4}-(0[1-9]|1[0-2])$Length7 <= length <= 7

security_codestringOptional

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`.

Match^[0-9]{3,4}$Length3 <= length <= 4

brandenum<card_brand>Optional

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

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

Allowed values

"VISA"
"MASTERCARD"
"DISCOVER"
"AMEX"
"SOLO"
"JCB"
"STAR"
"DELTA"
"SWITCH"
"MAESTRO"
"CB_NATIONALE"
"CONFIGOGA"

billing_addressobject<Portable Postal Address (Medium-Grained)>Optional

Portable Postal Address (Medium-Grained) properties

6 properties

address_line_1stringOptional

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.

Length0 <= length <= 300

address_line_2stringOptional

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

Length0 <= length <= 300

admin_area_2stringOptional

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

Length0 <= length <= 120

admin_area_1stringOptional

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

Length0 <= length <= 300

postal_codestringOptional

The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).

Length0 <= length <= 60

country_codestring<country_code>Required

The [2-character ISO 3166-1 code](/api/rest/reference/country-codes/) 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.

Match^([A-Z]{2}|C2)$Formatppaas_common_country_code_v2Length2 <= length <= 2

network_transaction_referencenetwork_transaction_reference_requestOptional

tokenobject<token_id_request>Optional

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

token_id_request properties

2 properties

idstringRequired

The PayPal-generated ID for the token.

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

typeenumRequired

The tokenization method that generated the ID.

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

Allowed values

"SETUP_TOKEN"

Payment Token Request

Customer Request properties

definitions-payment_source properties

Card Request properties

Portable Postal Address (Medium-Grained) properties

token_id_request properties

Back to top

On this page

On this page

Payment Token Request

Customer Request properties

definitions-payment_source properties

Card Request properties

Portable Postal Address (Medium-Grained) properties

token_id_request properties

Back to top

On this page

Payment Token Request

Customer Request properties

definitions-payment_source properties

Card Request properties

Portable Postal Address (Medium-Grained) properties

token_id_request properties

Back to top

On this page

On this page

We currently use cookies to improve and customize your experience on our site. If you accept, we’ll also use marketing cookies to show you personalized ads. Manage your cookies and learn more.

Payment Token Request

Customer Request properties

definitions-payment_source properties

Card Request properties

Portable Postal Address (Medium-Grained) properties

token_id_request properties

Back to top

On this page