The Payment Method Tokens API saves payment methods so payers don't have to enter details for future transactions. Payers can check out faster or pay without being present after they agree to save a payment method.
The API associates a payment method with a temporary setup token. Pass the setup token to the API to exchange the setup token for a permanent token.
The permanent token represents a payment method that's saved to the vault. This token can be used repeatedly for checkout or recurring transactions such as subscriptions.
Creates a Payment Token from the given payment source and adds it to the Vault of the associated customer.
Payment Token creation with a financial instrument and an optional customer_id.
required | object (Payment source request) The payment method to vault with the instrument details. |
object (customer) Customer in merchant's or partner's system of records. |
A successful creation of payment token.
{- "payment_source": {
- "token": {
- "id": "5C991763VB2781612",
- "type": "SETUP_TOKEN"
}
}
}
{- "id": "8kk8451t",
- "customer": {
- "id": "customer_4029352050",
- "merchant_customer_id": "customer@merchant.com"
}, - "payment_source": {
- "card": {
- "brand": "VISA",
- "last_digits": "1111",
- "expiry": "2027-02",
- "name": "John Doe",
- "billing_address": {
- "address_line_1": "2211 N First Street",
- "address_line_2": "17.3.160",
- "admin_area_2": "San Jose",
- "admin_area_1": "CA",
- "postal_code": "95131",
- "country_code": "US"
}
}
}, - "links": [
- {
- "rel": "self",
- "method": "GET",
- "encType": "application/json"
}, - {
- "rel": "delete",
- "method": "DELETE",
- "encType": "application/json"
}
]
}
Returns all payment tokens for a customer.
Successful execution.
curl -v -X GET https://api-m.sandbox.paypal.com/v3/vault/payment-tokens?customer_id=customer_4029352050 \ -H 'Authorization: Bearer FULL_scoped_access_token'
{- "customer": {
- "id": "customer_4029352050",
- "merchant_customer_id": "customer@merchant.com"
}, - "payment_tokens": [
- {
- "id": "8kk8451t",
- "customer": {
- "id": "customer_4029352050"
}, - "payment_source": {
- "card": {
- "name": "John Doe",
- "brand": "VISA",
- "last_digits": "1111",
- "expiry": "2027-02",
- "billing_address": {
- "id": "kk",
- "address_line_1": "2211 N First Street",
- "address_line_2": "17.3.160",
- "admin_area_2": "San Jose",
- "admin_area_1": "CA",
- "postal_code": "95131",
- "country_code": "US"
}
}
}, - "links": [
- {
- "rel": "self",
- "method": "GET",
- "encType": "application/json"
}, - {
- "rel": "delete",
- "method": "DELETE",
- "encType": "application/json"
}
]
}, - {
- "id": "fgh6561t",
- "customer": {
- "id": "customer_4029352050"
}, - "payment_source": {
- "paypal": {
- "description": "Description for PayPal to be shown to PayPal payer",
- "email_address": "john.doe@example.com",
- "account_id": "VYYFH3WJ4JPJQ",
- "shipping": {
- "name": {
- "full_name": "John Doe"
}, - "address": {
- "address_line_1": "2211 N First Street",
- "address_line_2": "17.3.160",
- "admin_area_2": "San Jose",
- "admin_area_1": "CA",
- "postal_code": "95131",
- "country_code": "US"
}
}, - "usage_pattern": "IMMEDIATE",
- "usage_type": "MERCHANT",
- "customer_type": "CONSUMER",
- "name": {
- "given_name": "John",
- "surname": "Doe"
}, - "address": {
- "address_line_1": "2211 N First Street",
- "address_line_2": "17.3.160",
- "admin_area_2": "San Jose",
- "admin_area_1": "CA",
- "postal_code": "95131",
- "country_code": "US"
}
}
}, - "links": [
- {
- "rel": "self",
- "method": "GET",
- "encType": "application/json"
}, - {
- "rel": "delete",
- "method": "DELETE",
- "encType": "application/json"
}
]
}, - {
- "id": "hg654s1t",
- "customer": {
- "id": "customer_4029352050"
}, - "payment_source": {
- "venmo": {
- "description": "Description for Venmo to be shown to Venmo payer",
- "shipping": {
- "name": {
- "full_name": "John Doe"
}, - "address": {
- "address_line_1": "2211 N First Street",
- "address_line_2": "17.3.160",
- "admin_area_2": "San Jose",
- "admin_area_1": "CA",
- "postal_code": "95131",
- "country_code": "US"
}
}, - "usage_pattern": "IMMEDIATE",
- "usage_type": "MERCHANT",
- "customer_type": "CONSUMER",
- "email_address": "john.doe@example.com",
- "user_name": "johndoe",
- "name": {
- "given_name": "John",
- "surname": "Doe"
}, - "account_id": "VYYFH3WJ4JPJQ",
- "address": {
- "address_line_1": "PayPal",
- "address_line_2": "2211 North 1st Street",
- "admin_area_1": "CA",
- "admin_area_2": "San Jose",
- "postal_code": "96112",
- "country_code": "US"
}
}
}, - "links": [
- {
- "rel": "self",
- "method": "GET",
- "encType": "application/json"
}, - {
- "rel": "delete",
- "method": "DELETE",
- "encType": "application/json"
}
]
}, - {
- "id": "8kk8457",
- "payment_source": {
- "apple_pay": {
- "card": {
- "name": "John Doe",
- "last_digits": "1111",
- "type": "CREDIT",
- "brand": "VISA",
- "billing_address": {
- "address_line_1": "2211 N First Street",
- "address_line_2": "17.3.160",
- "admin_area_1": "CA",
- "admin_area_2": "San Jose",
- "postal_code": "95131",
- "country_code": "US"
}
}
}
}, - "links": [
- {
- "rel": "delete",
- "method": "DELETE"
}
]
}, - {
- "id": "8kk8458",
- "payment_source": {
- "bank": {
- "ach_debit": {
- "last_digits": "9999",
- "routing_number": "307075259",
- "account_type": "CHECKING",
- "ownership_type": "PERSONAL",
- "account_holder_name": "John Doe",
- "verification_status": "VERIFIED"
}
}
}, - "links": [
- {
- "rel": "self",
- "method": "GET",
- "encType": "application/json"
}, - {
- "rel": "delete",
- "method": "DELETE",
- "encType": "application/json"
}
]
}
], - "links": [
- {
- "rel": "self",
- "method": "GET",
- "encType": "application/json"
}, - {
- "rel": "first",
- "method": "GET",
- "encType": "application/json"
}, - {
- "rel": "last",
- "method": "GET",
- "encType": "application/json"
}
]
}
Returns a readable representation of vaulted payment source associated with the payment token id.
Successful execution.
curl -v -X GET https://api-m.sandbox.paypal.com/v3/vault/payment-tokens/8kk8451t \ -H 'Authorization: Bearer FULL_scoped_access_token'
{- "id": "8kk8451t",
- "customer": {
- "id": "customer_4029352050",
- "merchant_customer_id": "customer@merchant.com"
}, - "payment_source": {
- "card": {
- "last_digits": "1111",
- "expiry": "2027-02",
- "brand": "VISA",
- "name": "John Doe",
- "billing_address": {
- "id": "kk",
- "address_line_1": "2211 N First Street",
- "address_line_2": "17.3.160",
- "admin_area_2": "San Jose",
- "admin_area_1": "CA",
- "postal_code": "95131",
- "country_code": "US"
}
}
}, - "links": [
- {
- "rel": "self",
- "method": "GET",
- "encType": "application/json"
}, - {
- "rel": "delete",
- "method": "DELETE",
- "encType": "application/json"
}
]
}
Delete the payment token associated with the payment token id.
The server has successfully executed the method, but there is no entity body to return.
curl -v -X DELETE https://api-m.sandbox.paypal.com/v3/vault/payment-tokens/8kk8451t \ -H 'Authorization: Bearer FULL_scoped_access_token'
Creates a Setup Token from the given payment source and adds it to the Vault of the associated customer.
Setup Token creation with a instrument type optional financial instrument details and customer_id.
required | object The payment method to vault with the instrument details. |
object (customer) Customer in merchant's or partner's system of records. |
A successful creation of setup token.
{- "payment_source": {
- "card": {
- "number": "4111111111111111",
- "expiry": "2027-02",
- "name": "John Doe",
- "billing_address": {
- "address_line_1": "2211 N First Street",
- "address_line_2": "17.3.160",
- "admin_area_1": "CA",
- "admin_area_2": "San Jose",
- "postal_code": "95131",
- "country_code": "US"
}, - "experience_context": {
- "brand_name": "YourBrandName",
- "locale": "en-US",
}
}
}, - "customer": {
- "id": "customer_4029352050",
- "merchant_customer_id": "customer@merchant.com"
}
}
{- "id": "5C991763VB2781612",
- "customer": {
- "id": "customer_4029352050",
- "merchant_customer_id": "customer@merchant.com"
}, - "status": "APPROVED",
- "payment_source": {
- "card": {
- "last_digits": "1111",
- "expiry": "2027-02",
- "name": "John Doe",
- "billing_address": {
- "address_line_1": "2211 N First Street",
- "address_line_2": "17.3.160",
- "admin_area_1": "CA",
- "admin_area_2": "San Jose",
- "postal_code": "95131",
- "country_code": "US"
}
}
}, - "links": [
- {
- "rel": "self",
- "method": "GET",
- "encType": "application/json"
}, - {
- "rel": "confirm",
- "method": "POST",
- "encType": "application/json"
}
]
}
Returns a readable representation of temporarily vaulted payment source associated with the setup token id.
Found requested setup-token, returned a payment method associated with the token.
curl -v -X GET https://api-m.sandbox.paypal.com/v3/vault/setup-tokens/5C991763VB2781612 \ -H 'Authorization: Bearer LOW_scoped_access_token' \ -H 'Content-Type: application/json' \ -H 'PayPal-Request-ID: b5efbe82-bbad-4bb0-aeeb-bfef5b442e49'
{- "id": "5C991763VB2781612",
- "customer": {
- "id": "customer_4029352050",
- "merchant_customer_id": "customer@merchant.com"
}, - "status": "APPROVED",
- "payment_source": {
- "card": {
- "last_digits": "1111",
- "expiry": "2027-02",
- "name": "John Doe",
- "billing_address": {
- "address_line_1": "2211 N First Street",
- "address_line_2": "17.3.160",
- "admin_area_2": "San Jose",
- "admin_area_1": "CA",
- "postal_code": "95131",
- "country_code": "US"
}
}
}, - "links": [
- {
- "rel": "self",
- "method": "GET",
- "encType": "application/json"
}, - {
- "rel": "confirm",
- "method": "POST",
- "encType": "application/json"
}
]
}
Message:
Expiration year outside of acceptable range.
Description: The requested action could not be performed, semantically incorrect, or failed business validation.
Message:
Credit card number is invalid.
Description: The request is not well-formed, is syntactically incorrect, or violates schema.
Message:
Exactly one payment source is required.
Description: The request is not well-formed, is syntactically incorrect, or violates schema.
Message:
A system or application error occurred. Although the client appears to provide a correct request, something unexpected occurred on the server.
Description: An internal server error occurred.
Message:
Expiry date is invalid. Expiry date should be a date in future and within the threshold for the payment source.
Description: The requested action could not be performed, semantically incorrect, or failed business validation.
Message:
The integer value of a field is too small.
Description: The request is not well-formed, is syntactically incorrect, or violates schema.
Message:
The value of a field does not conform to the expected format.
Description: The request is not well-formed, is syntactically incorrect, or violates schema.
Message:
The security code provided does not conform to the card number provided.
Description: The requested action could not be performed, semantically incorrect, or failed business validation.
Message:
The value of a field is either too short or too long.
Description: The request is not well-formed, is syntactically incorrect, or violates schema.
Message:
The value of a field is too long.
Description: The request is not well-formed, is syntactically incorrect, or violates schema.
Message:
The request JSON is not well formed.
Description: The request is not well-formed, is syntactically incorrect, or violates schema.
Message:
A required field / parameter is missing.
Description: The request is not well-formed, is syntactically incorrect, or violates schema.
Message:
The API caller or the merchant on whose behalf the API call is initiated is not allowed to vault the given source. Please contact PayPal customer support for assistance.
Description: Authorization failed due to insufficient permissions.
Message:
Specified operation not supported on any fields.
Description: The requested action could not be performed, semantically incorrect, or failed business validation.
Message:
Please make sure setup up token is approved. Please complete the approval flow Payer Approval.
Description: The requested action could not be performed, semantically incorrect, or failed business validation.
Message:
The PayPal-Request-ID has already been used for another request.
Description: The requested action could not be performed, semantically incorrect, or failed business validation.
Message:
You do not have permission to access or perform operations on this resource.
Description: Authorization failed due to insufficient permissions.
Message:
The specified resource does not exist.
Description: The requested resource ID was not found
Message:
The setup token has been used previously to generate a payment token.
Description: The requested action could not be performed, semantically incorrect, or failed business validation.
Message:
The specified token id does not exist.
Description: The requested resource ID was not found.
A Resource representing a response of vaulted a ACH Debit Account.
verification_status | string (ach_debit_verification_status) [ 1 .. 255 ] characters Default: "NOT_VERIFIED" ACH Debit Verification Status |
{- "verification_status": "NOT_VERIFIED"
}
The ach debit verification status.
The ach debit verification status.
"NOT_VERIFIED"
The verification method of the bank.
The verification method of the bank.
Value: | Description |
---|---|
INDEPENDENT_CHECK | The merchant will choose this method when he has agreed to use a third party for verification |
"INDEPENDENT_CHECK"
The payment card to be used to fund a payment. Can be a credit or debit card.
name | string [ 1 .. 300 ] characters ^.{1,300}$ The card holder's name as it appears on the card. | ||||||||||||||||||||||||||||||||||
last_digits | string [ 2 .. 4 ] characters ^[0-9]{2,4}$ The last digits of the payment card. | ||||||||||||||||||||||||||||||||||
type | string (card_type) [ 1 .. 255 ] characters ^[A-Z_]+$ The payment card type.
| ||||||||||||||||||||||||||||||||||
brand | string (card_brand) [ 1 .. 255 ] characters ^[A-Z_]+$ The card brand or network. Typically used in the response.
| ||||||||||||||||||||||||||||||||||
object (Portable Postal Address (Medium-Grained)) The billing address for this card. Supports only the |
{- "name": "string",
- "last_digits": "stri",
- "type": "CREDIT",
- "brand": "VISA",
- "billing_address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
}
A resource representing a response for Apple Pay.
object (apple_pay_card) Card data for the card linked to the apple pay token. |
{- "card": {
- "name": "string",
- "last_digits": "stri",
- "type": "CREDIT",
- "brand": "VISA",
- "billing_address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
}
}
Full representation of a Bank Payment Token.
object (ach_debit_response) ACH Debit Response. |
{- "ach_debit": {
- "verification_status": "NOT_VERIFIED"
}
}
The payment card to use to fund a payment. Can be a credit or debit card.
name | string [ 1 .. 300 ] characters ^.{1,300}$ The card holder's name as it appears on the card. | ||||||||||||||||||||||||||||||||||
number | string [ 13 .. 19 ] characters ^[0-9]{13,19}$ The primary account number (PAN) for the payment card. | ||||||||||||||||||||||||||||||||||
last_digits | string [ 2 .. 4 ] characters ^[0-9]{2,4}$ The last digits of the payment card. | ||||||||||||||||||||||||||||||||||
expiry | string (date_year_month) = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$ The card expiration year and month, in Internet date format. | ||||||||||||||||||||||||||||||||||
type | string (card_type) [ 1 .. 255 ] characters ^[A-Z_]+$ The payment card type.
| ||||||||||||||||||||||||||||||||||
brand | string (card_brand) [ 1 .. 255 ] characters ^[A-Z_]+$ The card brand or network. Typically used in the response.
| ||||||||||||||||||||||||||||||||||
object (Portable Postal Address (Medium-Grained)) The billing address for this card. Supports only the |
{- "name": "string",
- "number": "stringstrings",
- "last_digits": "stri",
- "expiry": "string",
- "type": "CREDIT",
- "brand": "VISA",
- "billing_address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
}
The payment card to use to fund a payment. Can be a credit or debit card.
name | string [ 1 .. 300 ] characters ^.{1,300}$ The card holder's name as it appears on the card. | ||||||||||||||||||||||||||||||||||
number required | string [ 13 .. 19 ] characters ^[0-9]{13,19}$ The primary account number (PAN) for the payment card. | ||||||||||||||||||||||||||||||||||
security_code | string [ 3 .. 4 ] characters ^[0-9]{3,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 | ||||||||||||||||||||||||||||||||||
expiry required | string (date_year_month) = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$ The card expiration year and month, in Internet date format. | ||||||||||||||||||||||||||||||||||
type | string (card_type) [ 1 .. 255 ] characters ^[A-Z_]+$ The payment card type.
| ||||||||||||||||||||||||||||||||||
brand | string (card_brand) [ 1 .. 255 ] characters ^[A-Z_]+$ The card brand or network. Typically used in the response.
| ||||||||||||||||||||||||||||||||||
object (Portable Postal Address (Medium-Grained)) The billing address for this card. Supports only the |
{- "name": "string",
- "number": "stringstrings",
- "security_code": "stri",
- "expiry": "string",
- "type": "CREDIT",
- "brand": "VISA",
- "billing_address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
}
The card network or brand. Applies to credit, debit, gift, and payment cards.
The card network or brand. Applies to credit, debit, gift, and payment cards.
Enum: | Description |
---|---|
VISA | Visa card. |
MASTERCARD | Mastecard card. |
DISCOVER | Discover card. |
AMEX | American Express card. |
SOLO | Solo debit card. |
JCB | Japan Credit Bureau card. |
STAR | Military Star card. |
DELTA | Delta Airlines card. |
SWITCH | Switch credit card. |
MAESTRO | Maestro credit card. |
CB_NATIONALE | Carte Bancaire (CB) credit card. |
CONFIGOGA | Configoga credit card. |
CONFIDIS | Confidis credit card. |
ELECTRON | Visa Electron credit card. |
CETELEM | Cetelem credit card. |
CHINA_UNION_PAY | China union pay credit card. |
"VISA"
A Resource representing a request to vault a Card.
name | string [ 1 .. 300 ] characters ^.{1,300}$ The card holder's name as it appears on the card. | ||||||||||||||||||||||||||||||||||
number | string [ 13 .. 19 ] characters ^[0-9]{13,19}$ The primary account number (PAN) for the payment card. | ||||||||||||||||||||||||||||||||||
security_code | string [ 3 .. 4 ] characters ^[0-9]{3,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 | ||||||||||||||||||||||||||||||||||
expiry | string (date_year_month) = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$ The card expiration year and month, in Internet date format. | ||||||||||||||||||||||||||||||||||
type | string (card_type) [ 1 .. 255 ] characters ^[A-Z_]+$ The payment card type.
| ||||||||||||||||||||||||||||||||||
brand | string (card_brand) [ 1 .. 255 ] characters ^[A-Z_]+$ The card brand or network. Typically used in the response.
| ||||||||||||||||||||||||||||||||||
object (Portable Postal Address (Medium-Grained)) The billing address for this card. Supports only the |
{- "name": "string",
- "number": "stringstrings",
- "security_code": "stri",
- "expiry": "string",
- "type": "CREDIT",
- "brand": "VISA",
- "billing_address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
}
A Resource representing a request to vault a Card.
name | string [ 1 .. 300 ] characters ^.{1,300}$ The card holder's name as it appears on the card. | ||||||||||||||||||||||||||||||||||
number required | string [ 13 .. 19 ] characters ^[0-9]{13,19}$ The primary account number (PAN) for the payment card. | ||||||||||||||||||||||||||||||||||
security_code | string [ 3 .. 4 ] characters ^[0-9]{3,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 | ||||||||||||||||||||||||||||||||||
expiry required | string (date_year_month) = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$ The card expiration year and month, in Internet date format. | ||||||||||||||||||||||||||||||||||
type | string (card_type) [ 1 .. 255 ] characters ^[A-Z_]+$ The payment card type.
| ||||||||||||||||||||||||||||||||||
brand | string (card_brand) [ 1 .. 255 ] characters ^[A-Z_]+$ The card brand or network. Typically used in the response.
| ||||||||||||||||||||||||||||||||||
object (Portable Postal Address (Medium-Grained)) The billing address for this card. Supports only the | |||||||||||||||||||||||||||||||||||
object (experience_context) Customizes the Vault creation flow experience for your customers. | |||||||||||||||||||||||||||||||||||
verification_method | string (card_verification_method) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The API caller can opt in to verify the payment token through PayPal offered verification services (e.g. Smart Dollar Auth, 3DS). |
{- "name": "string",
- "number": "stringstrings",
- "security_code": "stri",
- "expiry": "string",
- "type": "CREDIT",
- "brand": "VISA",
- "billing_address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}, - "experience_context": {
- "brand_name": "string",
- "locale": "string",
- "vault_instruction": "ON_CREATE_PAYMENT_TOKENS"
}, - "verification_method": "string"
}
Full representation of a Card Payment Token.
name | string [ 2 .. 300 ] characters ^[A-Za-z ]+$ The card holder's name as it appears on the card. | ||||||||||||||||||||||||||||||||||
last_digits | string [ 2 .. 4 ] characters [0-9]{2,} The last digits of the payment card. | ||||||||||||||||||||||||||||||||||
object (card_verification_details) Card Verification details including the authorization details and 3D SECURE details. | |||||||||||||||||||||||||||||||||||
brand | string (card_brand) [ 1 .. 255 ] characters ^[A-Z_]+$ The card brand or network. Typically used in the response.
| ||||||||||||||||||||||||||||||||||
expiry | string (date_year_month) = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$ The card expiration year and month, in Internet date format. | ||||||||||||||||||||||||||||||||||
verification_status | string (card_verification_status) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Card Verification status. |
{- "name": "string",
- "last_digits": "stri",
- "verification": {
- "network_transaction_id": "string",
- "time": "stringstringstringst",
- "amount": {
- "currency_code": "str",
- "value": "string"
}, - "processor_response": {
- "avs_code": "A",
- "cvv_code": "E"
}, - "three_d_secure": null
}, - "brand": "VISA",
- "expiry": "strings",
- "verification_status": "string"
}
Type of card. i.e Credit, Debit and so on.
Type of card. i.e Credit, Debit and so on.
Enum: | Description |
---|---|
CREDIT | A credit card. |
DEBIT | A debit card. |
PREPAID | A Prepaid card. |
STORE | A store card. |
UNKNOWN | Card type cannot be determined. |
"CREDIT"
Card Verification details including the authorization details and 3D SECURE details.
network_transaction_id | string [ 1 .. 1024 ] characters ^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$ Transaction Identifier as given by the network to indicate a previously executed CIT authorization. Only present when authorization is successful for a verification. |
time | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The date and time when the instrument was verified. |
object (Money) The amount used for card verification. | |
object (processor_response) The processor information. | |
three_d_secure | any (3ds_result) |
{- "network_transaction_id": "string",
- "time": "stringstringstringst",
- "amount": {
- "currency_code": "str",
- "value": "string"
}, - "processor_response": {
- "avs_code": "A",
- "cvv_code": "E"
}, - "three_d_secure": null
}
The verification method of the card.
The verification method of the card.
"string"
Verification status of Card.
Verification status of Card.
"string"
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
"st"
The three-character ISO-4217 currency code that identifies the currency.
The three-character ISO-4217 currency code that identifies the currency.
"str"
Customer in merchant's or partner's system of records.
merchant_customer_id | string [ 1 .. 64 ] characters ^[0-9a-zA-Z-_.^*$@#]+$ 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. |
id | string (merchant_partner_customer_id) [ 1 .. 22 ] characters ^[0-9a-zA-Z_-]+$ The unique ID for a customer in merchant's or partner's system of records. |
{- "merchant_customer_id": "string",
- "id": "string"
}
The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time
type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.
The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time
type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.
"stringstri"
The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.
The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.
"stringstringstringst"
The year and month, in ISO-8601 YYYY-MM
date format. See Internet date and time format.
The year and month, in ISO-8601 YYYY-MM
date format. See Internet date and time format.
"strings"
Resource consolidating common request and response attributes for vaulting a Digital Wallet.
description | string [ 1 .. 128 ] characters ^[a-zA-Z0-9_'\-., :;\!?"]*$ The description displayed to the consumer on the approval flow for a digital wallet, as well as on the merchant view of the payment token management experience. exp: PayPal.com. |
permit_multiple_payment_tokens | boolean Default: false Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the customer has not logged in at merchant/platform. The payment token thus generated, can then also be used to create the customer account at merchant/platform. Use this also when multiple payment tokens are required for the same payer, different customer at merchant/platform. This helps to identify customers distinctly even though they may share the same PayPal account. This only applies to PayPal payment source. |
usage_type | string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The usage type associated with a digital wallet payment token. |
customer_type | string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The customer type associated with a digital wallet payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer. |
object (shipping_detail) The shipping address for the Payer. |
{- "description": "string",
- "permit_multiple_payment_tokens": false,
- "usage_type": "string",
- "customer_type": "string",
- "shipping": {
- "type": "SHIPPING",
- "name": {
- "full_name": "string"
}, - "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
}
}
The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@
sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@
sign exists.
The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@
sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@
sign exists.
"string"
The error details.
name required | string The human-readable, unique name of the error. |
message required | string The message that describes the error. |
debug_id required | string The PayPal internal ID. Used for correlation purposes. |
information_link | string The information link, or URI, that shows detailed information about this error for the developer. |
Array of objects (Error Details) An array of additional details about the error. | |
Array of objects (Link Description) An array of request-related HATEOAS links. |
{- "name": "string",
- "message": "string",
- "debug_id": "string",
- "information_link": "string",
- "details": [
- {
- "field": "string",
- "value": "string",
- "location": "body",
- "issue": "string",
- "description": "string"
}
], - "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
]
}
The error details. Required for client-side 4XX
errors.
field | string The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors. |
value | string The value of the field that caused the error. |
location | string Default: "body" The location of the field that caused the error. Value is |
issue required | string The unique, fine-grained application-level error code. |
description | string The human-readable description for an issue. The description can change over the lifetime of an API, so clients must not depend on this value. |
{- "field": "string",
- "value": "string",
- "location": "body",
- "issue": "string",
- "description": "string"
}
The error details. Required for client-side 4XX
errors.
field | string The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors. |
value | string The value of the field that caused the error. |
location | string Default: "body" The location of the field that caused the error. Value is |
issue required | string The unique, fine-grained application-level error code. |
description | string The human-readable description for an issue. The description can change over the lifetime of an API, so clients must not depend on this value. |
{- "field": "string",
- "value": "string",
- "location": "body",
- "issue": "string",
- "description": "string"
}
Customizes the Vault creation flow experience for your customers.
brand_name | string [ 1 .. 300 ] characters ^.*$ The label that overrides the business name in the PayPal account on the PayPal site. The pattern is defined by an external party and supports Unicode. |
return_url | string <uri> [ 1 .. 4000 ] characters The URL where the customer is redirected after customer approves leaves the flow. It is a required field for contingency flows like PayPal wallet, 3DS. |
cancel_url | string <uri> [ 1 .. 4000 ] characters The URL where the customer is redirected after customer cancels or leaves the flow. It is a required field for contingency flows like PayPal wallet, 3DS. |
locale | string <ppaas_common_language_v3> (language) [ 2 .. 10 ] characters ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[... The BCP 47-formatted locale of pages that the PayPal vaulting experience shows. PayPal supports a five-character code. For example, |
vault_instruction | string (Vault Instruction) [ 1 .. 255 ] characters ^[A-Z_]+$ Default: "ON_CREATE_PAYMENT_TOKENS" Vault Instruction on action to be performed after a successful payer approval. |
{- "brand_name": "string",
- "locale": "string",
- "vault_instruction": "ON_CREATE_PAYMENT_TOKENS"
}
Customizes the Vault creation flow experience for your customers.
brand_name | string [ 1 .. 300 ] characters ^.*$ The label that overrides the business name in the PayPal account on the PayPal site. The pattern is defined by an external party and supports Unicode. |
return_url | string <uri> [ 1 .. 4000 ] characters The URL where the customer is redirected after customer approves leaves the flow. It is a required field for contingency flows like PayPal wallet, 3DS. |
cancel_url | string <uri> [ 1 .. 4000 ] characters The URL where the customer is redirected after customer cancels or leaves the flow. It is a required field for contingency flows like PayPal wallet, 3DS. |
shipping_preference | string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Default: "GET_FROM_FILE" The shipping preference. This only applies to PayPal payment source. |
locale | string <ppaas_common_language_v3> (language) [ 2 .. 10 ] characters ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[... The BCP 47-formatted locale of pages that the PayPal vaulting experience shows. PayPal supports a five-character code. For example, |
vault_instruction | string (Vault Instruction) [ 1 .. 255 ] characters ^[A-Z_]+$ Default: "ON_CREATE_PAYMENT_TOKENS" Vault Instruction on action to be performed after a successful payer approval. |
{- "brand_name": "string",
- "shipping_preference": "GET_FROM_FILE",
- "locale": "string",
- "vault_instruction": "ON_CREATE_PAYMENT_TOKENS"
}
Customizes the Vault creation flow experience for your customers.
brand_name | string [ 1 .. 300 ] characters ^.*$ The label that overrides the business name in the PayPal account on the PayPal site. The pattern is defined by an external party and supports Unicode. |
shipping_preference | string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Default: "GET_FROM_FILE" The shipping preference. This only applies to PayPal payment source. |
vault_instruction | string (Vault Instruction) [ 1 .. 255 ] characters ^[A-Z_]+$ Default: "ON_CREATE_PAYMENT_TOKENS" Vault Instruction on action to be performed after a successful payer approval. |
{- "brand_name": "string",
- "shipping_preference": "GET_FROM_FILE",
- "vault_instruction": "ON_CREATE_PAYMENT_TOKENS"
}
The PayPal-generated ID for the vault token.
The PayPal-generated ID for the vault token.
"string"
The identifier of the instrument.
The identifier of the instrument.
"string"
The language tag for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the ISO 639-2 language code, the optional ISO-15924 script tag, and the ISO-3166 alpha-2 country code or M49 region code.
The language tag for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the ISO 639-2 language code, the optional ISO-15924 script tag, and the ISO-3166 alpha-2 country code or M49 region code.
"string"
The request-related HATEOAS link information.
href required | string The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the |
rel required | string The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations. |
method | string The HTTP method required to make the related call. |
{- "href": "string",
- "rel": "string",
- "method": "GET"
}
The request-related HATEOAS link information.
href required | string The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the |
rel required | string The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations. |
method | string The HTTP method required to make the related call. |
{- "href": "string",
- "rel": "string",
- "method": "GET"
}
The unique ID for a customer generated by PayPal.
The unique ID for a customer generated by PayPal.
"string"
The currency and amount for a financial transaction, such as a balance or payment due.
currency_code required | string <ppaas_common_currency_code_v2> (currency_code) = 3 characters The three-character ISO-4217 currency code that identifies the currency. |
value required | string <= 32 characters ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$ The value, which might be:
|
{- "currency_code": "str",
- "value": "string"
}
The name of the party.
full_name | string <= 300 characters When the party is a person, the party's full name. |
{- "full_name": "string"
}
The name of the party.
given_name | string <= 140 characters When the party is a person, the party's given, or first, name. |
surname | string <= 140 characters When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname. |
{- "given_name": "string",
- "surname": "string"
}
The name of the party.
given_name | string <= 140 characters When the party is a person, the party's given, or first, name. |
surname | string <= 140 characters When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname. |
{- "given_name": "string",
- "surname": "string"
}
The name of the party.
full_name | string <= 300 characters When the party is a person, the party's full name. |
{- "full_name": "string"
}
The JSON patch object to apply partial updates to resources.
op required | string The operation.
| ||||||||||||||||||||||||||
path | string The JSON Pointer to the target document location at which to complete the operation. | ||||||||||||||||||||||||||
value | object (Patch Value) The value to apply. The | ||||||||||||||||||||||||||
from | string The JSON Pointer to the target document location from which to move the value. Required for the |
{- "op": "add",
- "path": "string",
- "value": { },
- "from": "string"
}
The JSON patch object to apply partial updates to resources.
op required | string The operation.
| ||||||||||||||||||||||||||
path | string The JSON Pointer to the target document location at which to complete the operation. | ||||||||||||||||||||||||||
value | object (Patch Value) The value to apply. The | ||||||||||||||||||||||||||
from | string The JSON Pointer to the target document location from which to move the value. Required for the |
{- "op": "add",
- "path": "string",
- "value": { },
- "from": "string"
}
The customer who approves and pays for the order. The customer is also known as the payer.
email_address | string <merchant_common_email_address_v2> (email) [ 3 .. 254 ] characters (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-... The email address of the payer. |
object (Name) The name of the payer. Supports only the | |
object (phone_with_type) The phone number of the customer. Available only when you enable the Contact Telephone Number option in the Profile & Settings for the merchant's PayPal account. The | |
object (Portable Postal Address (Medium-Grained)) The address of the payer. Supports only the |
{- "email_address": "string",
- "name": {
- "given_name": "string",
- "surname": "string"
}, - "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}, - "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
}
The customer who approves and pays for the order. The customer is also known as the payer.
email_address | string <merchant_common_email_address_v2> (email) [ 3 .. 254 ] characters (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-... The email address of the payer. |
payer_id | string <ppaas_payer_id_v3> (PayPal Account Identifier) = 13 characters ^[2-9A-HJ-NP-Z]{13}$ The PayPal-assigned ID for the payer. |
object (Name) The name of the payer. Supports only the | |
object (phone_with_type) The phone number of the customer. Available only when you enable the Contact Telephone Number option in the Profile & Settings for the merchant's PayPal account. The | |
object (Portable Postal Address (Medium-Grained)) The address of the payer. Supports only the |
{- "email_address": "string",
- "payer_id": "string",
- "name": {
- "given_name": "string",
- "surname": "string"
}, - "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}, - "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
}
The customer who approves and pays for the order. The customer is also known as the payer.
email_address | string <merchant_common_email_address_v2> (email) [ 3 .. 254 ] characters (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-... The email address of the payer. |
payer_id | string <ppaas_payer_id_v3> (PayPal Account Identifier) = 13 characters ^[2-9A-HJ-NP-Z]{13}$ The PayPal-assigned ID for the payer. |
{- "email_address": "string",
- "payer_id": "string"
}
Full representation of a saved payment token.
object The vaulted payment method details. | |
Array of objects (Link Description) [ 1 .. 32 ] items An array of related HATEOAS links. | |
id | string (id) [ 1 .. 36 ] characters ^[0-9a-zA-Z_-]+$ The PayPal-generated ID for the vault token. |
object (customer) Customer in merchant's or partner's system of records. |
{- "payment_source": {
- "card": {
- "name": "string",
- "last_digits": "stri",
- "verification": {
- "network_transaction_id": "string",
- "time": "stringstringstringst",
- "amount": {
- "currency_code": "str",
- "value": "string"
}, - "processor_response": {
- "avs_code": "A",
- "cvv_code": "E"
}, - "three_d_secure": null
}, - "brand": "VISA",
- "expiry": "strings",
- "verification_status": "string"
}, - "paypal": {
- "email_address": "string",
- "name": {
- "given_name": "string",
- "surname": "string"
}, - "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}, - "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}, - "account_id": "stringstrings",
- "phone_number": {
- "country_code": "str",
- "national_number": "string",
- "extension_number": "string"
}
}, - "venmo": {
- "email_address": "string",
- "payer_id": "string",
- "name": {
- "given_name": "string",
- "surname": "string"
}, - "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}, - "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}, - "user_name": "string"
}, - "apple_pay": {
- "card": {
- "name": "string",
- "last_digits": "stri",
- "type": "CREDIT",
- "brand": "VISA",
- "billing_address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
}
}, - "bank": {
- "ach_debit": {
- "verification_status": "NOT_VERIFIED"
}
}
}, - "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "id": "string",
- "customer": {
- "merchant_customer_id": "string",
- "id": "string"
}
}
Full representation of a saved payment token.
object The vaulted payment method details. | |
Array of objects (Link Description) [ 1 .. 32 ] items An array of related HATEOAS links. | |
id | string (id) [ 1 .. 36 ] characters ^[0-9a-zA-Z_-]+$ The PayPal-generated ID for the vault token. |
object (customer) Customer in merchant's or partner's system of records. |
{- "payment_source": {
- "card": {
- "name": "string",
- "last_digits": "stri",
- "verification": {
- "network_transaction_id": "string",
- "time": "stringstringstringst",
- "amount": {
- "currency_code": "str",
- "value": "string"
}, - "processor_response": {
- "avs_code": "A",
- "cvv_code": "E"
}, - "three_d_secure": null
}, - "brand": "VISA",
- "expiry": "strings",
- "verification_status": "string"
}, - "paypal": {
- "email_address": "string",
- "name": {
- "given_name": "string",
- "surname": "string"
}, - "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}, - "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}, - "account_id": "stringstrings",
- "phone_number": {
- "country_code": "str",
- "national_number": "string",
- "extension_number": "string"
}
}, - "venmo": {
- "email_address": "string",
- "payer_id": "string",
- "name": {
- "given_name": "string",
- "surname": "string"
}, - "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}, - "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}, - "user_name": "string"
}, - "apple_pay": {
- "card": {
- "name": "string",
- "last_digits": "stri",
- "type": "CREDIT",
- "brand": "VISA",
- "billing_address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
}
}, - "bank": {
- "ach_debit": {
- "verification_status": "NOT_VERIFIED"
}
}
}, - "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "id": "string",
- "customer": {
- "merchant_customer_id": "string",
- "id": "string"
}
}
The status of the payment token.
The status of the payment token.
"CREATED"
The account identifier for a PayPal account.
The account identifier for a PayPal account.
"stringstrings"
A resource representing a request to vault PayPal Wallet.
description | string [ 1 .. 128 ] characters ^[a-zA-Z0-9_'\-., :;\!?"]*$ The description displayed to the consumer on the approval flow for a digital wallet, as well as on the merchant view of the payment token management experience. exp: PayPal.com. |
permit_multiple_payment_tokens | boolean Default: false Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the customer has not logged in at merchant/platform. The payment token thus generated, can then also be used to create the customer account at merchant/platform. Use this also when multiple payment tokens are required for the same payer, different customer at merchant/platform. This helps to identify customers distinctly even though they may share the same PayPal account. This only applies to PayPal payment source. |
usage_type | string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The usage type associated with a digital wallet payment token. |
customer_type | string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The customer type associated with a digital wallet payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer. |
object (shipping_detail) The shipping address for the Payer. | |
object (experience_context) Customizes the Vault creation flow experience for your customers. |
{- "description": "string",
- "permit_multiple_payment_tokens": false,
- "usage_type": "string",
- "customer_type": "string",
- "shipping": {
- "type": "SHIPPING",
- "name": {
- "full_name": "string"
}, - "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
}, - "experience_context": {
- "brand_name": "string",
- "shipping_preference": "GET_FROM_FILE",
- "locale": "string",
- "vault_instruction": "ON_CREATE_PAYMENT_TOKENS"
}
}
Full representation of a PayPal Payment Token.
email_address | string <merchant_common_email_address_v2> (email) [ 3 .. 254 ] characters (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-... The email address of the payer. |
object (Name) The name of the payer. Supports only the | |
object (phone_with_type) The phone number of the customer. Available only when you enable the Contact Telephone Number option in the Profile & Settings for the merchant's PayPal account. The | |
object (Portable Postal Address (Medium-Grained)) The address of the payer. Supports only the | |
account_id | string <ppaas_payer_id_v3> (PayPal Account Identifier) = 13 characters ^[2-9A-HJ-NP-Z]{13}$ The account identifier for a PayPal account. |
object (Phone) The phone number, in its canonical international E.164 numbering plan format. |
{- "email_address": "string",
- "name": {
- "given_name": "string",
- "surname": "string"
}, - "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}, - "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}, - "account_id": "stringstrings",
- "phone_number": {
- "country_code": "str",
- "national_number": "string",
- "extension_number": "string"
}
}
The phone number, in its canonical international E.164 numbering plan format.
country_code required | string [ 1 .. 3 ] characters ^[0-9]{1,3}?$ The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the 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). |
national_number required | string [ 1 .. 14 ] characters ^[0-9]{1,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). |
extension_number | string [ 1 .. 15 ] characters ^[0-9]{1,15}?$ The extension number. |
{- "country_code": "str",
- "national_number": "string",
- "extension_number": "string"
}
The phone number, in its canonical international E.164 numbering plan format.
national_number required | string [ 1 .. 14 ] characters ^[0-9]{1,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). |
{- "national_number": "string"
}
The phone type.
The phone type.
"FAX"
The phone information.
phone_type | string (Phone Type) The phone type. |
required | object (Phone) The phone number, in its canonical international E.164 numbering plan format. Supports only the |
{- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
address_line_1 | string <= 300 characters The first line of the address. For example, number or street. For example, |
address_line_2 | string <= 300 characters The second line of the address. For example, suite or apartment number. |
admin_area_2 | string <= 120 characters A city, town, or village. Smaller than |
admin_area_1 | string <= 300 characters The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example,
|
postal_code | string <= 60 characters 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_code required | string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}|C2)$ The two-character ISO 3166-1 code that identifies the country or region. Note: The country code for Great Britain is |
{- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
address_line_1 | string <= 300 characters The first line of the address. For example, number or street. For example, |
address_line_2 | string <= 300 characters The second line of the address. For example, suite or apartment number. |
admin_area_2 | string <= 120 characters A city, town, or village. Smaller than |
admin_area_1 | string <= 300 characters The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example,
|
postal_code | string <= 60 characters 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_code required | string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}|C2)$ The two-character ISO 3166-1 code that identifies the country or region. Note: The country code for Great Britain is |
{- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
address_line_1 | string <= 300 characters The first line of the address. For example, number or street. For example, |
address_line_2 | string <= 300 characters The second line of the address. For example, suite or apartment number. |
admin_area_2 | string <= 120 characters A city, town, or village. Smaller than |
admin_area_1 | string <= 300 characters The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example,
|
postal_code | string <= 60 characters 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_code required | string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}|C2)$ The two-character ISO 3166-1 code that identifies the country or region. Note: The country code for Great Britain is |
{- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
address_line_1 | string <= 300 characters The first line of the address. For example, number or street. For example, |
address_line_2 | string <= 300 characters The second line of the address. For example, suite or apartment number. |
admin_area_2 | string <= 120 characters A city, town, or village. Smaller than |
admin_area_1 | string <= 300 characters The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example,
|
postal_code | string <= 60 characters 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_code required | string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}|C2)$ The two-character ISO 3166-1 code that identifies the country or region. Note: The country code for Great Britain is |
{- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
address_line_1 | string <= 300 characters The first line of the address. For example, number or street. For example, |
address_line_2 | string <= 300 characters The second line of the address. For example, suite or apartment number. |
admin_area_2 | string <= 120 characters A city, town, or village. Smaller than |
admin_area_1 | string <= 300 characters The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example,
|
postal_code | string <= 60 characters 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_code required | string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}|C2)$ The two-character ISO 3166-1 code that identifies the country or region. Note: The country code for Great Britain is |
{- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
address_line_1 | string <= 300 characters The first line of the address. For example, number or street. For example, |
address_line_2 | string <= 300 characters The second line of the address. For example, suite or apartment number. |
admin_area_2 | string <= 120 characters A city, town, or village. Smaller than |
admin_area_1 | string <= 300 characters The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example,
|
postal_code | string <= 60 characters 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_code required | string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}|C2)$ The two-character ISO 3166-1 code that identifies the country or region. Note: The country code for Great Britain is |
{- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
address_line_1 | string <= 300 characters The first line of the address. For example, number or street. For example, |
address_line_2 | string <= 300 characters The second line of the address. For example, suite or apartment number. |
admin_area_2 | string <= 120 characters A city, town, or village. Smaller than |
admin_area_1 | string <= 300 characters The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example,
|
postal_code | string <= 60 characters 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_code required | string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}|C2)$ The two-character ISO 3166-1 code that identifies the country or region. Note: The country code for Great Britain is |
{- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
The processor information. Might be required for payment requests, such as direct credit card transactions.
avs_code | string The address verification code for Visa, Discover, Mastercard, or American Express transactions.
| ||||||||||||||||||||||||||||||||||||||||||||||||||
cvv_code | string The card verification value code for for Visa, Discover, Mastercard, or American Express.
|
{- "avs_code": "A",
- "cvv_code": "E"
}
Setup Token Request where the source
defines the type of instrument to be stored.
required | object The payment method to vault with the instrument details. |
object (customer) Customer in merchant's or partner's system of records. |
{- "payment_source": {
- "card": {
- "name": "string",
- "number": "stringstrings",
- "security_code": "stri",
- "expiry": "string",
- "type": "CREDIT",
- "brand": "VISA",
- "billing_address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}, - "experience_context": {
- "brand_name": "string",
- "locale": "string",
- "vault_instruction": "ON_CREATE_PAYMENT_TOKENS"
}, - "verification_method": "string"
}, - "paypal": {
- "description": "string",
- "permit_multiple_payment_tokens": false,
- "usage_type": "string",
- "customer_type": "string",
- "shipping": {
- "type": "SHIPPING",
- "name": {
- "full_name": "string"
}, - "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
}, - "experience_context": {
- "brand_name": "string",
- "shipping_preference": "GET_FROM_FILE",
- "locale": "string",
- "vault_instruction": "ON_CREATE_PAYMENT_TOKENS"
}
}, - "venmo": {
- "description": "string",
- "permit_multiple_payment_tokens": false,
- "usage_type": "string",
- "customer_type": "string",
- "shipping": {
- "type": "SHIPPING",
- "name": {
- "full_name": "string"
}, - "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
}, - "experience_context": {
- "brand_name": "string",
- "shipping_preference": "GET_FROM_FILE",
- "vault_instruction": "ON_CREATE_PAYMENT_TOKENS"
}
}, - "token": {
- "id": "string",
- "type": "BILLING_AGREEMENT"
}
}, - "customer": {
- "merchant_customer_id": "string",
- "id": "string"
}
}
Minimal representation of a cached setup token.
object The setup payment method details. | |
Array of objects (Link Description) [ 1 .. 32 ] items An array of related HATEOAS links. | |
id | string (id) [ 1 .. 36 ] characters ^[0-9a-zA-Z_-]+$ The PayPal-generated ID for the vault token. |
ordinal | integer (ordinal) [ 1 .. 99 ] The ordinal number of customers' payment source for sorting. |
object (customer) Customer in merchant's or partner's system of records. | |
status | string (payment_token_status) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Default: "CREATED" The status of the payment token. |
{- "payment_source": {
- "card": {
- "name": "string",
- "last_digits": "stri",
- "verification": {
- "network_transaction_id": "string",
- "time": "stringstringstringst",
- "amount": {
- "currency_code": "str",
- "value": "string"
}, - "processor_response": {
- "avs_code": "A",
- "cvv_code": "E"
}, - "three_d_secure": null
}, - "brand": "VISA",
- "expiry": "strings",
- "verification_status": "string"
}, - "paypal": {
- "email_address": "string",
- "name": {
- "given_name": "string",
- "surname": "string"
}, - "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}, - "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}, - "account_id": "stringstrings",
- "phone_number": {
- "country_code": "str",
- "national_number": "string",
- "extension_number": "string"
}
}, - "venmo": {
- "email_address": "string",
- "payer_id": "string",
- "name": {
- "given_name": "string",
- "surname": "string"
}, - "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}, - "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}, - "user_name": "string"
}
}, - "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "id": "string",
- "ordinal": 1,
- "customer": {
- "merchant_customer_id": "string",
- "id": "string"
}, - "status": "CREATED"
}
Minimal representation of a cached setup token.
object The setup payment method details. | |
Array of objects (Link Description) [ 1 .. 32 ] items An array of related HATEOAS links. | |
id | string (id) [ 1 .. 36 ] characters ^[0-9a-zA-Z_-]+$ The PayPal-generated ID for the vault token. |
ordinal | integer (ordinal) [ 1 .. 99 ] The ordinal number of customers' payment source for sorting. |
object (customer) Customer in merchant's or partner's system of records. | |
status | string (payment_token_status) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Default: "CREATED" The status of the payment token. |
{- "payment_source": {
- "card": {
- "name": "string",
- "last_digits": "stri",
- "verification": {
- "network_transaction_id": "string",
- "time": "stringstringstringst",
- "amount": {
- "currency_code": "str",
- "value": "string"
}, - "processor_response": {
- "avs_code": "A",
- "cvv_code": "E"
}, - "three_d_secure": null
}, - "brand": "VISA",
- "expiry": "strings",
- "verification_status": "string"
}, - "paypal": {
- "email_address": "string",
- "name": {
- "given_name": "string",
- "surname": "string"
}, - "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}, - "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}, - "account_id": "stringstrings",
- "phone_number": {
- "country_code": "str",
- "national_number": "string",
- "extension_number": "string"
}
}, - "venmo": {
- "email_address": "string",
- "payer_id": "string",
- "name": {
- "given_name": "string",
- "surname": "string"
}, - "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}, - "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}, - "user_name": "string"
}
}, - "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "id": "string",
- "ordinal": 1,
- "customer": {
- "merchant_customer_id": "string",
- "id": "string"
}, - "status": "CREATED"
}
The shipping details.
type | string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The method by which the payer wants to get their items from the payee e.g shipping, in-person pickup. Either type or options but not both may be present.
| ||||||
object (Name) The name of the person to whom to ship the items. Supports only the | |||||||
object (Portable Postal Address (Medium-Grained)) The address of the person to whom to ship the items. Supports only the |
{- "type": "SHIPPING",
- "name": {
- "full_name": "string"
}, - "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
}
The tax ID of the customer. The customer is also known as the payer. Both tax_id
and tax_id_type
are required.
tax_id required | string [ 1 .. 14 ] characters ([a-zA-Z0-9]) The customer's tax ID value. | ||||||
tax_id_type required | string [ 1 .. 14 ] characters ^[A-Z0-9_]+$ The customer's tax ID type.
|
{- "tax_id": "string",
- "tax_id_type": "BR_CPF"
}
The Tokenized Payment Source representing a Request to Vault a Token.
id required | string [ 1 .. 255 ] characters ^[0-9A-Z_-]+$ The PayPal-generated ID for the token. | ||||
type required | string [ 1 .. 255 ] characters ^[0-9A-Z_-]+$ The tokenization method that generated the ID.
|
{- "id": "string",
- "type": "BILLING_AGREEMENT"
}
Payment Token Request where the source
defines the type of instrument to be stored.
required | object (Payment source request) The payment method to vault with the instrument details. |
object (customer) Customer in merchant's or partner's system of records. |
{- "payment_source": {
- "card": {
- "name": "string",
- "number": "stringstrings",
- "security_code": "stri",
- "expiry": "string",
- "type": "CREDIT",
- "brand": "VISA",
- "billing_address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
}, - "token": {
- "id": "string",
- "type": "BILLING_AGREEMENT"
}
}, - "customer": {
- "merchant_customer_id": "string",
- "id": "string"
}
}
Vault Instruction on action to be performed after a successful payer approval.
Vault Instruction on action to be performed after a successful payer approval.
"ON_CREATE_PAYMENT_TOKENS"
Collection of payment tokens saved for a given customer.
total_items | integer [ 1 .. 50 ] Total number of items. |
total_pages | integer [ 1 .. 10 ] Total number of pages. |
Array of objects (payment_token_response) [ 0 .. 64 ] items | |
Array of objects (Link Description) [ 1 .. 32 ] items An array of related HATEOAS links. | |
object (customer) Customer in merchant's or partner's system of records. |
{- "total_items": 1,
- "total_pages": 1,
- "payment_tokens": [
- {
- "payment_source": {
- "card": {
- "name": "string",
- "last_digits": "stri",
- "verification": {
- "network_transaction_id": "string",
- "time": "stringstringstringst",
- "amount": {
- "currency_code": "str",
- "value": "string"
}, - "processor_response": {
- "avs_code": "A",
- "cvv_code": "E"
}, - "three_d_secure": null
}, - "brand": "VISA",
- "expiry": "strings",
- "verification_status": "string"
}, - "paypal": {
- "email_address": "string",
- "name": {
- "given_name": "string",
- "surname": "string"
}, - "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}, - "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}, - "account_id": "stringstrings",
- "phone_number": {
- "country_code": "str",
- "national_number": "string",
- "extension_number": "string"
}
}, - "venmo": {
- "email_address": "string",
- "payer_id": "string",
- "name": {
- "given_name": "string",
- "surname": "string"
}, - "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}, - "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}, - "user_name": "string"
}, - "apple_pay": {
- "card": {
- "name": "string",
- "last_digits": "stri",
- "type": "CREDIT",
- "brand": "VISA",
- "billing_address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
}
}, - "bank": {
- "ach_debit": {
- "verification_status": "NOT_VERIFIED"
}
}
}, - "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "id": "string",
- "customer": {
- "merchant_customer_id": "string",
- "id": "string"
}
}
], - "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "customer": {
- "merchant_customer_id": "string",
- "id": "string"
}
}
A resource representing a request to vault Venmo.
description | string [ 1 .. 128 ] characters ^[a-zA-Z0-9_'\-., :;\!?"]*$ The description displayed to the consumer on the approval flow for a digital wallet, as well as on the merchant view of the payment token management experience. exp: PayPal.com. |
permit_multiple_payment_tokens | boolean Default: false Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the customer has not logged in at merchant/platform. The payment token thus generated, can then also be used to create the customer account at merchant/platform. Use this also when multiple payment tokens are required for the same payer, different customer at merchant/platform. This helps to identify customers distinctly even though they may share the same PayPal account. This only applies to PayPal payment source. |
usage_type | string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The usage type associated with a digital wallet payment token. |
customer_type | string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The customer type associated with a digital wallet payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer. |
object (shipping_detail) The shipping address for the Payer. | |
object (experience_context) Customizes the Vault creation flow experience for your customers. |
{- "description": "string",
- "permit_multiple_payment_tokens": false,
- "usage_type": "string",
- "customer_type": "string",
- "shipping": {
- "type": "SHIPPING",
- "name": {
- "full_name": "string"
}, - "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
}, - "experience_context": {
- "brand_name": "string",
- "shipping_preference": "GET_FROM_FILE",
- "vault_instruction": "ON_CREATE_PAYMENT_TOKENS"
}
}
Full representation of a Venmo Payment Token.
email_address | string <merchant_common_email_address_v2> (email) [ 3 .. 254 ] characters (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-... The email address of the payer. |
payer_id | string <ppaas_payer_id_v3> (PayPal Account Identifier) = 13 characters ^[2-9A-HJ-NP-Z]{13}$ The PayPal-assigned ID for the payer. |
object (Name) The name of the payer. Supports only the | |
object (phone_with_type) The phone number of the customer. Available only when you enable the Contact Telephone Number option in the Profile & Settings for the merchant's PayPal account. The | |
object (Portable Postal Address (Medium-Grained)) The address of the payer. Supports only the | |
user_name | string [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]*$ The Venmo username, as chosen by the user. |
{- "email_address": "string",
- "payer_id": "string",
- "name": {
- "given_name": "string",
- "surname": "string"
}, - "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}, - "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}, - "user_name": "string"
}