Payment Method Tokens(3)

API Version v3

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.

operation/payment-tokens.create Create payment token for a given payment source

post/v3/vault/payment-tokens

Try it

Creates a Payment Token from the given payment source and adds it to the Vault of the associated customer.

SecurityOauth2

Request

header Parameters


PayPal-Request-Id	string[ 1 .. 10000 ] characters^.*$ The server stores keys for 3 hours.

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json required

Payment Token creation with a financial instrument and an optional customer_id.


payment_source required	object (Payment source request) The payment method to vault with the instrument details.
customer	object (customer) Customer in merchant's or partner's system of records.

Responses

200 Idempotent response for a successful creation of payment token.

201 A successful creation of payment token.

400 Request is not well-formed, syntactically incorrect, or violates schema.

403 Authorization failed due to insufficient permissions.

404 Request contains reference to resources that do not exist.

422 The requested action could not be performed, semantically incorrect, or failed business validation.

500 An internal server error has occurred.

Request samples

Payload
cURL

application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

Sample 1 - 201 - Create Payment Token - PayPal Wallet from Setup TokenSample 2 - 200 - Create Payment Token - Card with Full Request - IdempotentSample 3 - 400 - Create Payment Token - 400 Invalid Request Error - Empty Request BodySample 4 - 403 - Create Payment Token - 403 Forbidden Error - Merchant Not Onboarded to VaultSample 5 - 404 - Create Payment Token - 404 Not Found Error - Setup Token Does Not ExistSample 6 - 422 - Create Payment Token - 422 Unprocessable Entity Error - Inactive Billing AgreementSample 7 - 500 - Create Payment Token - 500 Internal Server ErrorSample 1 - 201 - Create Payment Token - PayPal Wallet from Setup Token

Copy

Expand allCollapse all

`{"payment_source": {"token": {"id": "4BD1763VB2781894",

"type": "SETUP_TOKEN"

}

Response samples

2 more4225002 more

application/json

Sample 1 - 201 - Create Payment Token - PayPal Wallet from Setup TokenSample 1 - 201 - Create Payment Token - PayPal Wallet from Setup Token

Copy

Expand allCollapse all

`{"id": "8kk8451t",

"customer": {"id": "BygeLlrpZF",

"merchant_customer_id": "customer@merchant.com"

"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",

"href": "https://api-m.paypal.com/v3/vault/payment-tokens/8kk8451t",

"method": "GET",

"encType": "application/json"

},

{"rel": "delete",

"href": "https://api-m.paypal.com/v3/vault/payment-tokens/8kk8451t",

"method": "DELETE",

"encType": "application/json"

}

]

operation/customer.payment-tokens.get List all payment tokens

get/v3/vault/payment-tokens

Try it

Returns all payment tokens for a customer.

SecurityOauth2

Request

query Parameters


customer_id required	string[ 7 .. 36 ] characters^[0-9a-zA-Z_-]+$ A unique identifier representing a specific customer in merchant's/partner's system or records.
page_size	integer[ 1 .. 5 ] Default:5 A non-negative, non-zero integer indicating the maximum number of results to return at one time.
page	integer[ 1 .. 10 ] Default:1 A non-negative, non-zero integer representing the page of the results.
total_required	boolean Default:false A boolean indicating total number of items (total_items) and pages (total_pages) are expected to be returned in the response.

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

any

Responses

200 Successful execution.

400 Request is not well-formed, syntactically incorrect, or violates schema.

403 Authorization failed due to insufficient permissions.

500 An internal server error has occurred.

Request samples

Payload
cURL

application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

Copy

{ }

Response samples

application/json

Sample 1 - 200 - List Payment Tokens - Retrieve All Tokens for Customer IdSample 2 - 200 - List Payment Tokens - Retrieve All Tokens for Customer Id - No Tokens FoundSample 1 - 200 - List Payment Tokens - Retrieve All Tokens for Customer Id

Copy

Expand allCollapse all

`{"customer": {"id": "BygeLlrpZF",

"merchant_customer_id": "[email protected]"

"payment_tokens": [{"id": "8kk8451t",

"customer": {"id": "BygeLlrpZF"

},

"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",

"href": "https://api-m.paypal.com/v3/vault/payment-tokens/8kk8451t",

"method": "GET",

"encType": "application/json"

},

{"rel": "delete",

"href": "https://api-m.paypal.com/v3/vault/payment-tokens/8kk8451t",

"method": "DELETE",

"encType": "application/json"

}

]

},

{"id": "fgh6561t",

"customer": {"id": "BygeLlrpZF"

},

"payment_source": {"paypal": {"description": "Description for PayPal to be shown to PayPal payer",

"email_address": "[email protected]",

"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",

"href": "https://api-m.paypal.com/v3/vault/payment-tokens/fgh6561t",

"method": "GET",

"encType": "application/json"

},

{"rel": "delete",

"href": "https://api-m.paypal.com/v3/vault/payment-tokens/fgh6561t",

"method": "DELETE",

"encType": "application/json"

}

]

},

{"id": "hg654s1t",

"customer": {"id": "BygeLlrpZF"

},

"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": "[email protected]",

"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",

"href": "https://api-m.paypal.com/v3/vault/payment-tokens/hg654s1t",

"method": "GET",

"encType": "application/json"

},

{"rel": "delete",

"href": "https://api-m.paypal.com/v3/vault/payment-tokens/hg654s1t",

"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": "self",

"href": "https://api-m.paypal.com/v3/vault/payment-tokens/8kk845",

"method": "GET"

},

{"rel": "delete",

"href": "https://api-m.paypal.com/v3/vault/payment-tokens/8kk845",

"method": "DELETE"

}

]

},

{"id": "8kk8458",

"payment_source": {"bank": {"ach_debit": {"last_digits": "9991",

"routing_number": "307075259",

"account_type": "CHECKING",

"ownership_type": "PERSONAL",

"account_holder_name": "John Doe",

"billing_address": {"country_code": "US"

},

"verification": {"external": {"status": "VERIFIED"

}

}

}

}

},

"links": [{"rel": "self",

"href": "https://api-m.paypal.com/v3/vault/payment-tokens/8kk8458",

"method": "GET",

"encType": "application/json"

},

{"rel": "delete",

"href": "https://api-m.paypal.com/v3/vault/payment-tokens/8kk8458",

"method": "DELETE",

"encType": "application/json"

}

]

},

{"id": "8kk82r8",

"customer": {"id": "BygeLlrpZF",

"merchant_customer_id": "[email protected]"

},

"payment_source": {"bank": {"ach_debit": {"last_digits": "9992",

"routing_number": "307075260",

"account_type": "CHECKING",

"ownership_type": "PERSONAL",

"account_holder_name": "John Doe",

"billing_address": {"country_code": "US"

},

"verification": {"paypal": {"method": "INSTANT_ACCOUNT_VERIFICATION",

"status": "VERIFIED"

}

}

}

}

},

"links": [{"rel": "self",

"href": "https://api-m.paypal.com/v3/vault/payment-tokens/8kk8458",

"method": "GET"

},

{"rel": "delete",

"href": "https://api-m.paypal.com/v3/vault/payment-tokens/8kk8458",

"method": "DELETE"

}

]

},

{"id": "8kk8459",

"payment_source": {"bank": {"sepa_debit": {"iban_last_chars": "5034",

"account_holder_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"

},

"authorization_details": {"status": "AUTHORIZED"

}

}

}

},

"links": [{"rel": "view-mandate",

"href": "https://msmaster.qa.paypal.com/directdebit/mandate/view?id=8kk8459&auth_code=C21_A.AAdol4tFtU0Q60ilyOPiTmmDax_YC1T00fAlBH_Uef_orr3TtzkcyKO4IuSxBlWmFHUzEvhiOXxV5WqE1bWNwmDyvsliIg",

"method": "GET"

},

{"rel": "self",

"href": "https://api-m.paypal.com/v3/vault/payment-tokens/8kk8459",

"method": "GET",

"encType": "application/json"

},

{"rel": "delete",

"href": "https://api-m.paypal.com/v3/vault/payment-tokens/8kk8459",

"method": "DELETE",

"encType": "application/json"

}

]

}

],

"links": [{"rel": "self",

"href": "https://api-m.paypal.com/v3/vault/payment-tokens?customer_id=BygeLlrpZF&page=1&page_size=5&total_required=false",

"method": "GET",

"encType": "application/json"

},

{"rel": "first",

"href": "https://api-m.paypal.com/v3/vault/payment-tokens?customer_id=BygeLlrpZF&page=1&page_size=5&total_required=false",

"method": "GET",

"encType": "application/json"

},

{"rel": "last",

"href": "https://api-m.paypal.com/v3/vault/payment-tokens?customer_id=BygeLlrpZF&page=1&page_size=5&total_required=false",

"method": "GET",

"encType": "application/json"

}

]

operation/payment-tokens.get Retrieve a payment token

get/v3/vault/payment-tokens/

Try it

Returns a readable representation of vaulted payment source associated with the payment token id.

SecurityOauth2

Request

path Parameters


id required	string[ 1 .. 36 ] characters^[0-9a-zA-Z_-]+$ ID of the payment token.

Responses

200 Successful execution.

403 Authorization failed due to insufficient permissions.

404 The specified resource does not exist.

500 An internal server error has occurred.

Request samples

cURL

Sample 1 - 200 - Retrieve Payment Token - Card TokenSample 2 - 200 - Retrieve Payment Token - PayPal Wallet TokenSample 3 - 200 - Retrieve Payment Token - Venmo TokenSample 4 - 403 - Get Payment Token - 403 Forbidden Error - Merchant Not Onboarded to VaultSample 5 - 404 - Get Payment Token - 404 Not Found Error - Payment Token Cannot Be LocatedSample 6 - 500 - Get Payment Token - 500 Internal Server ErrorSample 1 - 200 - Retrieve Payment Token - Card Token

Copy

curl -v -X GET https://api-m.sandbox.paypal.com/v3/vault/payment-tokens/8kk8451t \
-H 'Authorization: Bearer FULL_scoped_access_token'

Response samples

application/json

Sample 1 - 200 - Retrieve Payment Token - Card TokenSample 2 - 200 - Retrieve Payment Token - PayPal Wallet TokenSample 3 - 200 - Retrieve Payment Token - Venmo TokenSample 1 - 200 - Retrieve Payment Token - Card Token

Copy

Expand allCollapse all

`{"id": "8kk8451t",

"customer": {"id": "BygeLlrpZF",

"merchant_customer_id": "[email protected]"

"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"

}

operation/payment-tokens.delete Delete payment token

delete/v3/vault/payment-tokens/

Try it

Delete the payment token associated with the payment token id.

SecurityOauth2

Request

path Parameters


id required	string[ 1 .. 36 ] characters^[0-9a-zA-Z_-]+$ ID of the payment token.

Responses

204 The server has successfully executed the method, but there is no entity body to return.

400 Request is not well-formed, syntactically incorrect, or violates schema.

403 Authorization failed due to insufficient permissions.

500 An internal server error has occurred.

Request samples

cURL

Sample 1 - 204 - Delete Payment TokenSample 2 - 400 - Delete Payment Token - 400 Bad Request Error - Invalid Parameter SyntaxSample 3 - 403 - Delete Payment Token - 403 Forbidden Error - No Permission for the Payment TokenSample 4 - 500 - Delete Payment Token - 500 Internal Server ErrorSample 1 - 204 - Delete Payment Token

Copy

curl -v -X DELETE https://api-m.sandbox.paypal.com/v3/vault/payment-tokens/8kk8451t \
-H 'Authorization: Bearer FULL_scoped_access_token'

Response samples

application/json

Sample 1 - 204 - Delete Payment TokenSample 1 - 204 - Delete Payment Token

Copy

{ }

operation/setup-tokens.create Create a setup token

post/v3/vault/setup-tokens

Try it

Creates a Setup Token from the given payment source and adds it to the Vault of the associated customer.

SecurityOauth2

Request

header Parameters


PayPal-Request-Id	string[ 1 .. 10000 ] characters^.*$ The server stores keys for 3 hours.

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json required

Setup Token creation with a instrument type optional financial instrument details and customer_id.


payment_source required	object The payment method to vault with the instrument details.
customer	object (customer) Customer in merchant's or partner's system of records.

Responses

200 Idempotent response for a successful creation of setup token.

201 A successful creation of setup token.

400 Request is not well-formed, syntactically incorrect, or violates schema.

403 Authorization failed due to insufficient permissions.

422 The requested action could not be performed, semantically incorrect, or failed business validation.

500 An internal server error has occurred.

Request samples

Payload
cURL

application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

Sample 1 - 201 - Create Setup Token - Card with Full RequestSample 2 - 201 - Create Setup Token - Card with Full Request Returning 3DS Contingency (PAYER_ACTION_REQUIRED)Sample 3 - 201 - Create Setup Token - Card with Full Request by Partner on Behalf of MerchantSample 4 - 201 - Create Setup Token - Card with Full Request with Verification using Smart AuthSample 5 - 201 - Create Setup Token - PayPal Wallet with Full RequestSample 6 - 201 - Create Setup Token - PayPal Wallet with Full Request by Partner on Behalf of MerchantSample 7 - 201 - Create Setup Token - PayPal Wallet with Vault on Successful ApprovalSample 8 - 201 - Create Setup Token - PayPal Wallet with Full Billing PlanSample 9 - 201 - Create Setup Token - PayPal Wallet with Minimal Billing PlanSample 10 - 200 - Create Setup Token - Card with Full Request - IdempotentSample 11 - 400 - Create Setup Token - 400 Bad Request Error - Invalid Parameter SyntaxSample 12 - 400 - Create Setup Token - 400 Bad Request Error - Paypal Missing Required Fields in Billing PlanSample 13 - 422 - Create Setup Token - 422 Unprocessable Entity - Invalid security code for cardSample 14 - 403 - Create Setup Token - 403 Forbidden Error - PayPal Merchant Not Onboarded to VaultSample 15 - 422 - Create Setup Token - 422 Unprocessable Entity Error - Invalid Merchant Customer IdSample 16 - 500 - Create Setup Token - 500 Internal Server ErrorSample 1 - 201 - Create Setup Token - Card with Full Request

Copy

Expand allCollapse all

`{"customer": {"id": "BygeLlrpZF",

"merchant_customer_id": "[email protected]"

"payment_source": {"card": {"number": "4111111111111111",

"expiry": "2027-02",

"name": "John Doe",

"security_code": "321",

"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"

}

Response samples

1 more5001 more

application/json

Copy

Expand allCollapse all

`{"id": "5C991763VB2781612",

"customer": {"id": "BygeLlrpZF",

"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",

"href": "https://api-m.paypal.com/v3/vault/setup-tokens/5C991763VB2781612",

"method": "GET",

"encType": "application/json"

},

{"rel": "confirm",

"href": "https://api-m.paypal.com/v3/vault/payment-token",

"method": "POST",

"encType": "application/json"

}

]

operation/setup-tokens.get Retrieve a setup token

get/v3/vault/setup-tokens/

Try it

Returns a readable representation of temporarily vaulted payment source associated with the setup token id.

SecurityOauth2

Request

path Parameters


id required	string[ 7 .. 36 ] characters^[0-9a-zA-Z_-]+$ ID of the setup token.

Responses

200 Found requested setup-token, returned a payment method associated with the token.

400 Request is not well-formed, syntactically incorrect, or violates schema

403 Authorization failed due to insufficient permissions.

404 The specified resource does not exist.

500 An internal server error has occurred.

Request samples

cURL

Sample 1 - 200 - Retrieve Setup Token - Card with 3DS Contingency 3DS VERIFIEDSample 2 - 200 - Retrieve Setup Token - Card with Minimal Card Data in APPROVED state by CP4Sample 3 - 200 - Retrieve Setup Token - Card with 3DS Contingency in PAYER_ACTION_REQUIRED StateSample 4 - 200 - Retrieve Setup Token - PayPal Wallet ApprovedSample 5 - 200 - Retrieve Setup Token - PayPal Wallet with Payer Action RequiredSample 6 - 403 - Get Setup Token - 403 Forbidden Error - Merchant Not Onboarded to VaultSample 7 - 404 - Get Setup Token - 404 Not Found Error - Setup Token Does Not ExistSample 8 - 500 - Get Setup Token - 500 Internal Server ErrorSample 9 - 400 - Get Setup Token - 400 Bad Request Error - Invalid Parameter SyntaxSample 10 - 400 - Get Setup Token - 400 Bad Request Error - Invalid String LengthSample 1 - 200 - Retrieve Setup Token - Card with 3DS Contingency 3DS VERIFIED

Copy

curl -v -X GET https://api-m.sandbox.paypal.com/v3/vault/setup-tokens/5C991763VB2781612 \
-H 'Authorization: Bearer LOW_scoped_access_token' \
-H 'PayPal-Request-ID: b5efbe82-bbad-4bb0-aeeb-bfef5b442e49'

Response samples

application/json

Copy

Expand allCollapse all

`{"id": "5C991763VB2771612",

"customer": {"id": "BygeLlrpZF",

"merchant_customer_id": "[email protected]"

"status": "APPROVED",

"payment_source": {"card": {"brand": "VISA",

"last_digits": "1111",

"verification_status": "VERIFIED",

"network_transaction_reference": {"id": "20286098380002303",

"date": "1020",

"network": "VISA",

"time": "2020-10-20T22:44:41.000Z"

"verification": {"amount": {"value": "0.00",

"currency_code": "USD"

"processor_response": {"avs_code": "M",

"cvv_code": "P"

"three_d_secure": {"type": "THREE_DS_AUTHENTICATION",

"eci_flag": "FULLY_AUTHENTICATED_TRANSACTION",

"card_brand": "VISA",

"enrolled": "Y",

"pares_status": "Y",

"three_ds_version": "2",

"authentication_type": "DYNAMIC",

"three_ds_server_transaction_id": "3d-secure-txn-id"

}

"authentication_result": {"three_d_secure": {"authentication_status": "Y",

"enrollment_status": "Y"

}

"links": [{"href": "https://api-m.paypal.com/v3/vault/payment-token",

"rel": "confirm",

"method": "POST",

"encType": "application/json"

},

{"href": "https://api-m.paypal.com/v3/vault/setup-tokens/5C991763VB2771612",

"rel": "self",

"method": "GET",

"encType": "application/json"

}

]

tag/Errors Errors

section/CARD_EXPIRATION_YEAR_IS_INVALID CARD_EXPIRATION_YEAR_IS_INVALID

Message:

Expiration year outside of acceptable range.

Description: The requested action could not be performed, semantically incorrect, or failed business validation.

section/CREDIT_CARD_NUMBER_IS_INVALID CREDIT_CARD_NUMBER_IS_INVALID

Message:

Credit card number is invalid.

Description: The request is not well-formed, is syntactically incorrect, or violates schema.

section/EXACTLY_ONE_FIELD_REQUIRED EXACTLY_ONE_FIELD_REQUIRED

Message:

Exactly one payment source is required.

Description: The request is not well-formed, is syntactically incorrect, or violates schema.

section/INTERNAL_SERVER_ERROR INTERNAL_SERVER_ERROR

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.

section/INVALID_EXPIRY_DATE INVALID_EXPIRY_DATE

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.

section/INVALID_INTEGER_MIN_VALUE INVALID_INTEGER_MIN_VALUE

Message:

The integer value of a field is too small.

Description: The request is not well-formed, is syntactically incorrect, or violates schema.

section/INVALID_PARAMETER_SYNTAX INVALID_PARAMETER_SYNTAX

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.

section/INVALID_SECURITY_CODE INVALID_SECURITY_CODE

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.

section/INVALID_STRING_LENGTH INVALID_STRING_LENGTH

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.

section/INVALID_STRING_MAX_LENGTH INVALID_STRING_MAX_LENGTH

Message:

The value of a field is too long.

Description: The request is not well-formed, is syntactically incorrect, or violates schema.

section/MALFORMED_REQUEST_JSON MALFORMED_REQUEST_JSON

Message:

The request JSON is not well formed.

Description: The request is not well-formed, is syntactically incorrect, or violates schema.

section/MISSING_REQUIRED_PARAMETER MISSING_REQUIRED_PARAMETER

Message:

A required field / parameter is missing.

Description: The request is not well-formed, is syntactically incorrect, or violates schema.

section/NOT_ENABLED_TO_VAULT_PAYMENT_SOURCE NOT_ENABLED_TO_VAULT_PAYMENT_SOURCE

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.

section/OPERATION_NOT_SUPPORTED OPERATION_NOT_SUPPORTED

Message:

Specified operation not supported on any fields.

Description: The requested action could not be performed, semantically incorrect, or failed business validation.

section/PAYER_ACTION_REQUIRED PAYER_ACTION_REQUIRED

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.

section/PAYPAL_REQUEST_ID_PREVIOUSLY_USED PAYPAL_REQUEST_ID_PREVIOUSLY_USED

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.

section/PERMISSION_DENIED PERMISSION_DENIED

Message:

You do not have permission to access or perform operations on this resource.

Description: Authorization failed due to insufficient permissions.

section/RESOURCE_NOT_FOUND RESOURCE_NOT_FOUND

Message:

The specified resource does not exist.

Description: The requested resource ID was not found

section/SETUP_TOKEN_ALREADY_TOKENIZED SETUP_TOKEN_ALREADY_TOKENIZED

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.

section/SETUP_TOKEN_NOT_TOKENIZED SETUP_TOKEN_NOT_TOKENIZED

Message:

The payment source represented by this setup token is not vaulted.

Description: The requested action could not be performed, semantically incorrect, or failed business validation.

section/TOKEN_NOT_FOUND TOKEN_NOT_FOUND

Message:

The specified token id does not exist.

Description: The requested resource ID was not found.

tag/Definitions Definitions

schema/customized_3ds_result_1 3ds_result

any (3ds_result)

Copy

null

schema/account_registration_type Account Registration Type

The level of customer registration for the PayPal account.

string (Account Registration Type) [ 1 .. 255 ] characters^[A-Z0-9_]+$

The level of customer registration for the PayPal account.

Value	Description
ANONYMOUS	Anonymous account. The user does not even know that they have used PayPal. Typically used for the counterparty in a DCC or VT scenario where a merchant is directly charging a credit card.

Copy

"ANONYMOUS"

schema/activity_timestamps activity_timestamps

The date and time stamps that are common to authorized payment, captured payment, and refund transactions.


create_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]\|...Show pattern The date and time when the transaction occurred, in Internet date and time format.
update_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]\|...Show pattern The date and time when the transaction was last updated, in Internet date and time format.

Copy

`{"create_time": "stringstringstringst",

"update_time": "stringstringstringst"

schema/customized_address_entity_1 Address request details.

Address request details.


address_line_1	string<= 300 characters 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	string<= 300 characters The second line of the address, for example, a suite or apartment number.
admin_area_2	string<= 120 characters A city, town, or village. Smaller than `admin_area_level_1`.
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. 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	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 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.
id	string[ 1 .. 36 ] characters^[0-9A-Za-z-_]+$ The resource ID of the address.

Copy

`{"address_line_1": "string",

"address_line_2": "string",

"admin_area_2": "string",

"admin_area_1": "string",

"postal_code": "string",

"country_code": "st",

"id": "string"

schema/address_entity Address request details.

Address request details.


address_line_1	string<= 300 characters 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	string<= 300 characters The second line of the address, for example, a suite or apartment number.
admin_area_2	string<= 120 characters A city, town, or village. Smaller than `admin_area_level_1`.
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. 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	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 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.
id	string[ 1 .. 36 ] characters^[0-9A-Za-z-_]+$ The resource ID of the address.
company	string[ 1 .. 100 ] characters^.*$ The name of the company or business associated to the address.
phone	string[ 1 .. 16 ] characters^\+[1-9]\d{1,14}$ The phone number that can go on the mailing label with the address to track the shipping. Phone number is in E.164 format.
name	object (Name) The name of the party.
phone_number	object (Phone) Phone number associated to the address.

Copy

Expand allCollapse all

`{"address_line_1": "string",

"address_line_2": "string",

"admin_area_2": "string",

"admin_area_1": "string",

"postal_code": "string",

"country_code": "st",

"id": "string",

"company": "string",

"phone": "string",

"name": {"given_name": "string",

"surname": "string"

"phone_number": {"country_code": "str",

"national_number": "string",

"extension_number": "string"

}

schema/amount_breakdown amount_breakdown

The breakdown of the amount. Breakdown provides details such as total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.


item_total	object (Money) The subtotal for all items. Required if the request includes `purchase_units[].items[].unit_amount`. Must equal the sum of `(items[].unit_amount * items[].quantity)` for all items. `item_total.value` can not be a negative number.
shipping	object (Money) The shipping fee for all items within a given `purchase_unit`. `shipping.value` can not be a negative number.
handling	object (Money) The handling fee for all items within a given `purchase_unit`. `handling.value` can not be a negative number.
tax_total	object (Money) The total tax for all items. Required if the request includes `purchase_units.items.tax`. Must equal the sum of `(items[].tax * items[].quantity)` for all items. `tax_total.value` can not be a negative number.
insurance	object (Money) The insurance fee for all items within a given `purchase_unit`. `insurance.value` can not be a negative number.
shipping_discount	object (Money) The shipping discount for all items within a given `purchase_unit`. `shipping_discount.value` can not be a negative number.
discount	object (Money) The discount for all items within a given `purchase_unit`. `discount.value` can not be a negative number.

Copy

Expand allCollapse all

`{"item_total": {"currency_code": "str",

"value": "string"

"shipping": {"currency_code": "str",

"value": "string"

"handling": {"currency_code": "str",

"value": "string"

"tax_total": {"currency_code": "str",

"value": "string"

"insurance": {"currency_code": "str",

"value": "string"

"shipping_discount": {"currency_code": "str",

"value": "string"

"discount": {"currency_code": "str",

"value": "string"

}

schema/customized_apple_pay_card_1 apple_pay_card

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.

Enum Value	Description
CREDIT	A credit card.
DEBIT	A debit card.
PREPAID	A Prepaid card.
STORE	A store card.
UNKNOWN	Card type cannot be determined.
brand	string (card_brand) [ 1 .. 255 ] characters^[A-Z_]+$

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

Enum Value	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.
DINERS	The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services.
ELO	The Brazilian Elo card payment network.
HIPER	The Hiper - Ingenico ePayment network.
HIPERCARD	The Brazilian Hipercard payment network that's widely accepted in the retail market.
RUPAY	The RuPay payment network.
GE	The GE Credit Union 3Point card payment network.
SYNCHRONY	The Synchrony Financial (SYF) payment network.
EFTPOS	The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network.
UNKNOWN	UNKNOWN payment network.
billing_address	object (Portable Postal Address (Medium-Grained)) The billing address for this card. Supports only the `address_line_1`, `address_line_2`, `admin_area_1`, `admin_area_2`, `postal_code`, and `country_code` properties.

Copy

Expand allCollapse all

`{"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"

}

schema/apple_pay_payment_token_response apple_pay_payment_token_response

A resource representing a response for Apple Pay.


card	object (apple_pay_card) Card data for the card linked to the apple pay token.

Copy

Expand allCollapse all

`{"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"

}

schema/customized_authentication_response_1 authentication_response

Results of Authentication such as 3D Secure.


three_d_secure	object (three_d_secure_authentication_response) Results of 3D Secure Authentication.

Copy

Expand allCollapse all

`{"three_d_secure": {"authentication_status": "Y",

"enrollment_status": "Y",

"authentication_id": "string"

}

schema/customized_authorization_1 Authorization details

Authorization details.

| status | string (The authorization status) [ 1 .. 100 ] characters^[0-9A-Z_]+$

Instrument authorization status.

Enum Value	Description
AUTHORIZED	The authorization status is authorized.
BLOCKED	The authorization status is blocked.
FAILED	The authorization status is failed.
NOT_APPLICABLE	Authorization not applicable.
NOT_SUPPORTED	Authorization not supported.
UNAUTHORIZED	The authorization status is unauthorized.

Copy

`{"status": "AUTHORIZED"

schema/authorization_id authorization_id

A unique identifier for the financial instrument authorization sub-resource within the PayPal System.

string (authorization_id) [ 1 .. 255 ] characters^[A-Za-z0-9-_.+/=]*

A unique identifier for the financial instrument authorization sub-resource within the PayPal System.

Copy

"string"

schema/customized_bank_authorization_details_1 bank_authorization_details

The details of Bank mandate authorization

| status | string (The authorization status) [ 1 .. 100 ] characters^[0-9A-Z_]+$

The authorization status of the wallet instrument.

Enum Value	Description
AUTHORIZED	The authorization status is authorized.
BLOCKED	The authorization status is blocked.
FAILED	The authorization status is failed.
NOT_APPLICABLE	Authorization not applicable.
NOT_SUPPORTED	Authorization not supported.
UNAUTHORIZED	The authorization status is unauthorized.
authorization_codes	Array of strings[ 1 .. 50 ] items^[-._0-9a-zA-Z]+$ An array of the PayPal generated authorization codes. These codes can be based on the issuer specification.
type	string[ 1 .. 255 ] characters^[A-Z_]+$

Represents the type of mandate.

Enum Value	Description
ONE_OFF	Mandate of type ONE_OFF.
RECURRENT	Mandate of type RECURRENT.
time_authorized	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]\|...Show pattern The date and time when the instrument was authorized, in Internet date and time format.

Copy

Expand allCollapse all

`{"status": "AUTHORIZED",

"authorization_codes": ["string"

],

"type": "ONE_OFF",

"time_authorized": "string"

schema/billing_cycle billing_cycle

The billing cycle providing details of the billing frequency, amount, duration and if the billing cycle is a free, discounted or regular billing cycle. The sequence of the billing cycle will be in the following order - free trial billing cycle(s), discounted trial billing cycle(s), regular billing cycle(s).

| tenure_type
required | string[ 1 .. 24 ] characters^[A-Z_]+$

The tenure type of the billing cycle identifies if the billing cycle is a trial(free or discounted) or regular billing cycle.

Enum Value	Description
REGULAR	A regular billing cycle to identify recurring charges for the billing agreement.
TRIAL	A trial billing cycle to identify free or discounted charge for the billing agreement. Free trails will not have a price object in pricing scheme where as a discounted trial would have a discounted price compared to regular billing cycle.
total_cycles	integer<int32>[ 0 .. 999 ] Default:1 The number of times this billing cycle gets executed. Trial billing cycles can only be executed a finite number of times (value between `1` and `999` for `total_cycles`). Regular billing cycles can be executed infinite times (value of `0` for `total_cycles`) or a finite number of times (value between `1` and `999` for `total_cycles`).
sequence	integer<int32>[ 1 .. 3 ] Default:1 The order in which this cycle is to run among other billing cycles. For example, a trial billing cycle has a `sequence` of `1` while a regular billing cycle has a `sequence` of `2`, so that trial cycle runs before the regular cycle.
pricing_scheme	object (pricing_scheme) The active pricing scheme for this billing cycle. A free trial billing cycle does not require a pricing scheme.
start_date	string<ppaas_date_notime_v2> (date_no_time) = 10 characters^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|...Show pattern The start date for the billing cycle, in YYYY-MM-DD. This field should be not be provided if the billing cycle starts at the time of checkout. When this field is not provided, the billing cycle amount will be included in any data validations confirming that the total provided by the merchant match the sum of individual items due at the time of checkout. Only one billing cycle (with sequence equal to 1) can have a no start date.

Copy

Expand allCollapse all

`{"tenure_type": "REGULAR",

"total_cycles": 1,

"sequence": 1,

"pricing_scheme": {"pricing_model": "FIXED",

"price": {"currency_code": "str",

"value": "string"

"reload_threshold_amount": {"currency_code": "str",

"value": "string"

}

"start_date": "string"

schema/bin_details bin_details

Bank Identification Number (BIN) details used to fund a payment.


bin	string[ 1 .. 25 ] characters^[0-9]+$ The Bank Identification Number (BIN) signifies the number that is being used to identify the granular level details (except the PII information) of the card.
issuing_bank	string[ 1 .. 64 ] characters The issuer of the card instrument.
products	Array of strings[ 1 .. 256 ] items The type of card product assigned to the BIN by the issuer. These values are defined by the issuer and may change over time. Some examples include: PREPAID_GIFT, CONSUMER, CORPORATE.
bin_country_code	string<ppaas_common_country_code_v2> (country_code) = 2 characters^([A-Z]{2}\|C2)$ The two-character ISO-3166-1 country code of the bank.

Copy

Expand allCollapse all

`{"bin": "string",

"issuing_bank": "string",

"products": ["string"

],

"bin_country_code": "string"

schema/customized_card_1 card

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.

Enum Value	Description
CREDIT	A credit card.
DEBIT	A debit card.
PREPAID	A Prepaid card.
STORE	A store card.
UNKNOWN	Card type cannot be determined.
brand	string (card_brand) [ 1 .. 255 ] characters^[A-Z_]+$

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

Enum Value	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.
DINERS	The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services.
ELO	The Brazilian Elo card payment network.
HIPER	The Hiper - Ingenico ePayment network.
HIPERCARD	The Brazilian Hipercard payment network that's widely accepted in the retail market.
RUPAY	The RuPay payment network.
GE	The GE Credit Union 3Point card payment network.
SYNCHRONY	The Synchrony Financial (SYF) payment network.
EFTPOS	The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network.
UNKNOWN	UNKNOWN payment network.
billing_address	object (Portable Postal Address (Medium-Grained)) The billing address for this card. Supports only the `address_line_1`, `address_line_2`, `admin_area_1`, `admin_area_2`, `postal_code`, and `country_code` properties.

Copy

Expand allCollapse all

`{"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"

}

schema/customized_card_2 card

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 payment_initiator=MERCHANT. | | 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. | | brand | string (card_brand) [ 1 .. 255 ] characters^[A-Z_]+$

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

Enum Value	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.
DINERS	The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services.
ELO	The Brazilian Elo card payment network.
HIPER	The Hiper - Ingenico ePayment network.
HIPERCARD	The Brazilian Hipercard payment network that's widely accepted in the retail market.
RUPAY	The RuPay payment network.
GE	The GE Credit Union 3Point card payment network.
SYNCHRONY	The Synchrony Financial (SYF) payment network.
EFTPOS	The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network.
UNKNOWN	UNKNOWN payment network.
billing_address	object (Portable Postal Address (Medium-Grained)) The billing address for this card. Supports only the `address_line_1`, `address_line_2`, `admin_area_1`, `admin_area_2`, `postal_code`, and `country_code` properties.

Copy

Expand allCollapse all

`{"name": "string",

"number": "stringstrings",

"security_code": "stri",

"expiry": "string",

"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"

}

schema/card_verification Card Verification

The API caller can opt in to verify the card through PayPal offered verification services (e.g. Smart Dollar Auth, 3DS).

| method | string[ 1 .. 255 ] characters^[0-9A-Z_]+$

Default:"SCA_WHEN_REQUIRED"

The method used for card verification.

Enum Value	Description
SCA_ALWAYS	Selecting this option will attempt to force a strong customer authentication for the authorization/transaction. In countries where SCA has been defined and implemented it will result in a contingency and HATEOAS link being returned. The API caller should redirect the payer to that link so that they can authenticate themselves against their issuing bank or other entity. As noted, the HATEOAS link is only available in all regions where strong authentication is supported, (e.g. in European countries where 3DS is live). Merchants can use this setting as an additional layer of security if they choose to. In all cases, when an authorization is requested the AVS/CVV results will be returned in the response.
SCA_WHEN_REQUIRED	This is the default. When an authorization or transaction is attempted this option will return a contingency and HATEOAS link only when local regulations require strong customer authentication, (e.g. 3DS in countries and use cases where it is mandated). The API caller should redirect the payer to the link so that they can authenticate themselves. In all cases, when an authorization is requested the AVS/CVV results will be returned in the response.
3D_SECURE	The contingency surfaced as an additional security layer that helps prevent unauthorized card-not-present transactions and protects the merchant from exposure to fraud.
AVS_CVV	Places a temporary hold on the card to ensure its validity. This process protects the merchant from exposure to fraud. This verification method will confirm that the address information or CVV included matches what the issuing bank has on file for the associated card, ensuring that only authorized card users are able to make purchases from you.

Copy

`{"method": "SCA_ALWAYS"

schema/card_attributes card_attributes

Additional attributes associated with the use of this card.


customer	object (card_customer) The details about a customer in PayPal's system of record.
vault	object (vault_instruction_base) Instruction to vault the card based on the specified strategy.
verification	object (Card Verification) Instruction to optionally verify the card based on the specified strategy.

Copy

Expand allCollapse all

`{"customer": {"id": "string",

"email_address": "string",

"phone": {"phone_type": "FAX",

"phone_number": {"national_number": "string"

}

"merchant_customer_id": "string"

"vault": {"store_in_vault": "ON_SUCCESS"

"verification": {"method": "SCA_ALWAYS"

}

schema/card_brand card_brand

The card network or brand. Applies to credit, debit, gift, and payment cards.

string (card_brand) [ 1 .. 255 ] characters^[A-Z_]+$

The card network or brand. Applies to credit, debit, gift, and payment cards.

Enum Value	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.
DINERS	The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services.
ELO	The Brazilian Elo card payment network.
HIPER	The Hiper - Ingenico ePayment network.
HIPERCARD	The Brazilian Hipercard payment network that's widely accepted in the retail market.
RUPAY	The RuPay payment network.
GE	The GE Credit Union 3Point card payment network.
SYNCHRONY	The Synchrony Financial (SYF) payment network.
EFTPOS	The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network.
UNKNOWN	UNKNOWN payment network.

Copy

"VISA"

schema/card_customer card_customer

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


id	string (merchant_partner_customer_id) [ 1 .. 22 ] characters^[0-9a-zA-Z_-]+$ The unique ID for a customer generated by PayPal.
email_address	string<merchant_common_email_address_v2> (email) [ 3 .. 254 ] characters(?:[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[a-zA-...Show pattern Email address of the buyer as provided to the merchant or on file with the merchant. Email Address is required if you are processing the transaction using PayPal Guest Processing which is offered to select partners and merchants. For all other use cases we do not expect partners/merchant to send email_address of their customer.
phone	object (phone_with_type) The phone number of the buyer as provided to the merchant or on file with the merchant. The `phone.phone_number` supports only `national_number`.
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.
\
Copy\
\
Expand allCollapse all\
\
`{"id": "string",\
\
"email_address": "string",\
\
"phone": {"phone_type": "FAX",\
\
"phone_number": {"national_number": "string"\
\
}\
\
},\
\
"merchant_customer_id": "string"\
\
}`\
\

schema/customized_card_request_1 card_request\

schema/customized_card_request_2 card_request\

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 payment_initiator=MERCHANT. |
| 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. |
| brand | string (card_brand) [ 1 .. 255 ] characters^[A-Z_]+$

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

| Enum Value | 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. |
| DINERS | The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services. |
| ELO | The Brazilian Elo card payment network. |
| HIPER | The Hiper - Ingenico ePayment network. |
| HIPERCARD | The Brazilian Hipercard payment network that's widely accepted in the retail market. |
| RUPAY | The RuPay payment network. |
| GE | The GE Credit Union 3Point card payment network. |
| SYNCHRONY | The Synchrony Financial (SYF) payment network. |
| EFTPOS | The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network. |
| UNKNOWN | UNKNOWN payment network. | |
| billing_address | object (Portable Postal Address (Medium-Grained))
The billing address for this card. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties. |
| experience_context | 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).

| Enum Value | Description |
| --- | --- |
| SCA_WHEN_REQUIRED | When an authorization or transaction is attempted this option will return a contingency and HATEOAS link only when local regulations require strong customer authentication, (e.g. 3DS in countries and use cases where it is mandated). The API caller should redirect the payer to the link so that they can authenticate themselves. In all cases, when an authorization is requested the AVS/CVV results will be returned in the response. |
| SCA_ALWAYS | Selecting this option will attempt to force a strong customer authentication for the authorization/transaction. In countries where SCA has been defined and implemented it will result in a contingency and HATEOAS link being returned. The API caller should redirect the payer to that link so that they can authenticate themselves against their issuing bank or other entity. As noted, the HATEOAS link is only available in all regions where strong authentication is supported, (e.g. in European countries where 3DS is live). Merchants can use this setting as an additional layer of security if they choose to. In all cases, when an authorization is requested the AVS/CVV results will be returned in the response. | |

Copy

Expand allCollapse all

{"name": "string",\ \ "number": "stringstrings",\ \ "security_code": "stri",\ \ "expiry": "string",\ \ "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",\ \ "return_url": "http://example.com",\ \ "cancel_url": "http://example.com",\ \ "locale": "string",\ \ "vault_instruction": "ON_CREATE_PAYMENT_TOKENS"\ \ },\ \ "verification_method": "SCA_WHEN_REQUIRED"\ \ }
\

schema/card_response card_response\

Full representation of a Card Payment Token including network 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. |
| verification | object (card_verification_details)
Card Verification details including the authorization details and 3D SECURE details. |
| network_transaction_reference | object (network_transaction_reference_response)
Previous network transaction reference including id in response. |
| authentication_result | object (authentication_response)
Results of Authentication such as 3D Secure. |
| brand | string (card_brand) [ 1 .. 255 ] characters^[A-Z_]+$

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

| Enum Value | 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. |
| DINERS | The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services. |
| ELO | The Brazilian Elo card payment network. |
| HIPER | The Hiper - Ingenico ePayment network. |
| HIPERCARD | The Brazilian Hipercard payment network that's widely accepted in the retail market. |
| RUPAY | The RuPay payment network. |
| GE | The GE Credit Union 3Point card payment network. |
| SYNCHRONY | The Synchrony Financial (SYF) payment network. |
| EFTPOS | The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network. |
| UNKNOWN | UNKNOWN payment network. | |
| 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. |
| billing_address | object (Address request details.)
The billing address for this card. |
| verification_status | string (card_verification_status) [ 1 .. 255 ] characters^[0-9A-Z_]+$

Card Verification status.

| Enum Value | Description |
| --- | --- |
| VERIFIED | Card has been verified |
| FAILED | Card verification has failed | |
| bin_details | object (bin_details)
Bank Identification Number (BIN) details used to fund a payment. |
| type | string (card_type) [ 1 .. 255 ] characters^[A-Z_]+$

The payment card type.

| Enum Value | Description |
| --- | --- |
| CREDIT | A credit card. |
| DEBIT | A debit card. |
| PREPAID | A Prepaid card. |
| STORE | A store card. |
| UNKNOWN | Card type cannot be determined. | |

Copy

Expand allCollapse all

{"name": "string",\ \ "last_digits": "stri",\ \ "verification": {"network_transaction_id": "string",\ \ "date": "stri",\ \ "network": "VISA",\ \ "time": "string",\ \ "amount": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "processor_response": {"avs_code": "A",\ \ "cvv_code": "E"\ \ },\ \ "three_d_secure": null\ \ },\ \ "network_transaction_reference": {"id": "stringstr",\ \ "date": "stri",\ \ "network": "VISA",\ \ "time": "stringstringstringst"\ \ },\ \ "authentication_result": {"three_d_secure": {"authentication_status": "Y",\ \ "enrollment_status": "Y",\ \ "authentication_id": "string"\ \ }\ \ },\ \ "brand": "VISA",\ \ "expiry": "strings",\ \ "billing_address": {"address_line_1": "string",\ \ "address_line_2": "string",\ \ "admin_area_2": "string",\ \ "admin_area_1": "string",\ \ "postal_code": "string",\ \ "country_code": "st",\ \ "id": "string"\ \ },\ \ "verification_status": "VERIFIED",\ \ "bin_details": {"bin": "string",\ \ "issuing_bank": "string",\ \ "products": ["string"\ \ ],\ \ "bin_country_code": "string"\ \ },\ \ "type": "CREDIT"\ \ }
\

schema/customized_card_response_1 card_response\

schema/card_response_entity card_response_entity\

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. |
| verification | object (card_verification_details)
Card Verification details including the authorization details and 3D SECURE details. |
| network_transaction_reference | object (network_transaction_reference_response)
Previous network transaction reference including id in response. |
| authentication_result | object (authentication_response)
Results of Authentication such as 3D Secure. |
| brand | string (card_brand) [ 1 .. 255 ] characters^[A-Z_]+$

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

| Enum Value | 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. |
| DINERS | The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services. |
| ELO | The Brazilian Elo card payment network. |
| HIPER | The Hiper - Ingenico ePayment network. |
| HIPERCARD | The Brazilian Hipercard payment network that's widely accepted in the retail market. |
| RUPAY | The RuPay payment network. |
| GE | The GE Credit Union 3Point card payment network. |
| SYNCHRONY | The Synchrony Financial (SYF) payment network. |
| EFTPOS | The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network. |
| UNKNOWN | UNKNOWN payment network. | |
| 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. |
| billing_address | object (Address request details.)
The billing address for this card. |
| verification_status | string (card_verification_status) [ 1 .. 255 ] characters^[0-9A-Z_]+$

Card Verification status.

| Enum Value | Description |
| --- | --- |
| VERIFIED | Card has been verified |
| FAILED | Card verification has failed | |
| bin_details | object (bin_details)
Bank Identification Number (BIN) details used to fund a payment. |
| type | string (card_type) [ 1 .. 255 ] characters^[A-Z_]+$

The payment card type.

| Enum Value | Description |
| --- | --- |
| CREDIT | A credit card. |
| DEBIT | A debit card. |
| PREPAID | A Prepaid card. |
| STORE | A store card. |
| UNKNOWN | Card type cannot be determined. | |

Copy

Expand allCollapse all

{"name": "string",\ \ "last_digits": "stri",\ \ "verification": {"network_transaction_id": "string",\ \ "date": "stri",\ \ "network": "VISA",\ \ "time": "string",\ \ "amount": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "processor_response": {"avs_code": "A",\ \ "cvv_code": "E"\ \ },\ \ "three_d_secure": null\ \ },\ \ "network_transaction_reference": {"id": "stringstr",\ \ "date": "stri",\ \ "network": "VISA",\ \ "time": "stringstringstringst"\ \ },\ \ "authentication_result": {"three_d_secure": {"authentication_status": "Y",\ \ "enrollment_status": "Y",\ \ "authentication_id": "string"\ \ }\ \ },\ \ "brand": "VISA",\ \ "expiry": "strings",\ \ "billing_address": {"address_line_1": "string",\ \ "address_line_2": "string",\ \ "admin_area_2": "string",\ \ "admin_area_1": "string",\ \ "postal_code": "string",\ \ "country_code": "st",\ \ "id": "string"\ \ },\ \ "verification_status": "VERIFIED",\ \ "bin_details": {"bin": "string",\ \ "issuing_bank": "string",\ \ "products": ["string"\ \ ],\ \ "bin_country_code": "string"\ \ },\ \ "type": "CREDIT"\ \ }
\

schema/card_supplementary_data card_supplementary_data\

Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see checkout or multiparty checkout.

| | |
| --- | --- |
| level_2 | object (level_2)
The level 2 card processing data collections. If your merchant account has been configured for Level 2 processing this field will be passed to the processor on your behalf. Please contact your PayPal Technical Account Manager to define level 2 data for your business. |
| level_3 | object (level_3)
The level 3 card processing data collections, If your merchant account has been configured for Level 3 processing this field will be passed to the processor on your behalf. Please contact your PayPal Technical Account Manager to define level 3 data for your business. |

Copy

Expand allCollapse all

{"level_2": {"invoice_id": "string",\ \ "tax_total": {"currency_code": "str",\ \ "value": "string"\ \ }\ \ },\ \ "level_3": {"ships_from_postal_code": "string",\ \ "line_items": [{"name": "string",\ \ "quantity": "string",\ \ "description": "string",\ \ "sku": "string",\ \ "url": "http://example.com",\ \ "image_url": "http://example.com",\ \ "upc": {"type": "UPC-A",\ \ "code": "string"\ \ },\ \ "commodity_code": "string",\ \ "unit_of_measure": "string",\ \ "unit_amount": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "tax": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "discount_amount": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "total_amount": {"currency_code": "str",\ \ "value": "string"\ \ }\ \ }\ \ ],\ \ "shipping_amount": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "duty_amount": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "discount_amount": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "shipping_address": {"address_line_1": "string",\ \ "address_line_2": "string",\ \ "admin_area_2": "string",\ \ "admin_area_1": "string",\ \ "postal_code": "string",\ \ "country_code": "st"\ \ }\ \ }\ \ }
\

schema/card_type card_type\

Type of card. i.e Credit, Debit and so on.

string (card_type) [ 1 .. 255 ] characters^[A-Z_]+$

Type of card. i.e Credit, Debit and so on.

| Enum Value | Description |
| --- | --- |
| CREDIT | A credit card. |
| DEBIT | A debit card. |
| PREPAID | A Prepaid card. |
| STORE | A store card. |
| UNKNOWN | Card type cannot be determined. |

Copy

"CREDIT"
\

schema/card_verification_details card_verification_details\

Card Verification details including the authorization details and 3D SECURE details.

| network_transaction_id | string[ 1 .. 1024 ] characters^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$
DEPRECATED. This field is DEPRECATED. Please find the network transaction id data in the 'id' field under the 'network_transaction_reference' object instead of the 'verification' object. |
| date | string= 4 characters^[0-9]+$
DEPRECATED. This field is DEPRECATED. Please find the date data in the 'date' field under the 'network_transaction_reference' object instead of the 'verification' object. |
| network | string (card_brand) [ 1 .. 255 ] characters^[A-Z_]+$

DEPRECATED. This field is DEPRECATED. Please find the network data in the 'network' field under the 'network_transaction_reference' object instead of the 'verification' object.

| Enum Value | 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. |
| DINERS | The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services. |
| ELO | The Brazilian Elo card payment network. |
| HIPER | The Hiper - Ingenico ePayment network. |
| HIPERCARD | The Brazilian Hipercard payment network that's widely accepted in the retail market. |
| RUPAY | The RuPay payment network. |
| GE | The GE Credit Union 3Point card payment network. |
| SYNCHRONY | The Synchrony Financial (SYF) payment network. |
| EFTPOS | The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network. |
| UNKNOWN | UNKNOWN payment network. | |
| 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]|...Show pattern
DEPRECATED. This field is DEPRECATED. Please find the time data in the 'time' field under the 'network_transaction_reference' object instead of the 'verification' object. |
| amount | object (Money)
The amount used for card verification. |
| processor_response | object (processor_response)
The processor information. |
| three_d_secure | any (3ds_result)
DEPRECATED. This field is DEPRECATED. Please find the 3D secure authentication data in the 'three_d_secure' object under the 'authentication_result' object instead of the 'verification' object. |

Copy

Expand allCollapse all

{"network_transaction_id": "string",\ \ "date": "stri",\ \ "network": "VISA",\ \ "time": "string",\ \ "amount": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "processor_response": {"avs_code": "A",\ \ "cvv_code": "E"\ \ },\ \ "three_d_secure": null\ \ }
\

schema/card_verification_method card_verification_method\

The verification method of the card.

string (card_verification_method) [ 1 .. 255 ] characters^[0-9A-Z_]+$

The verification method of the card.

| Enum Value | Description |
| --- | --- |
| SCA_WHEN_REQUIRED | When an authorization or transaction is attempted this option will return a contingency and HATEOAS link only when local regulations require strong customer authentication, (e.g. 3DS in countries and use cases where it is mandated). The API caller should redirect the payer to the link so that they can authenticate themselves. In all cases, when an authorization is requested the AVS/CVV results will be returned in the response. |
| SCA_ALWAYS | Selecting this option will attempt to force a strong customer authentication for the authorization/transaction. In countries where SCA has been defined and implemented it will result in a contingency and HATEOAS link being returned. The API caller should redirect the payer to that link so that they can authenticate themselves against their issuing bank or other entity. As noted, the HATEOAS link is only available in all regions where strong authentication is supported, (e.g. in European countries where 3DS is live). Merchants can use this setting as an additional layer of security if they choose to. In all cases, when an authorization is requested the AVS/CVV results will be returned in the response. |

Copy

"SCA_WHEN_REQUIRED"
\

schema/card_verification_status card_verification_status\

Verification status of Card.

string (card_verification_status) [ 1 .. 255 ] characters^[0-9A-Z_]+$

Verification status of Card.

| Enum Value | Description |
| --- | --- |
| VERIFIED | Card has been verified |
| FAILED | Card verification has failed |

Copy

"VERIFIED"
\

schema/country_code country_code\

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.

string<ppaas_common_country_code_v2> (country_code) = 2 characters^([A-Z]{2}|C2)$

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.

Copy

"st"
\

schema/country_code_v3 country_code\

The two-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.

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

Copy

"st"
\

schema/currency_code currency_code\

The three-character ISO-4217 currency code that identifies the currency.

string<ppaas_common_currency_code_v2> (currency_code) = 3 characters

The three-character ISO-4217 currency code that identifies the currency.

Copy

"str"
\

schema/customer customer\

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

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

Copy

{"merchant_customer_id": "string",\ \ "id": "string"\ \ }
\

schema/customer_v1 customer\

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

| | |
| --- | --- |
| id | string (merchant_partner_customer_id) [ 1 .. 22 ] characters^[0-9a-zA-Z_-]+$
The unique ID for a customer generated by PayPal. |
| email_address | string<merchant_common_email_address_v2> (email) [ 3 .. 254 ] characters(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.\a-zA-...Show pattern
Email address of the buyer as provided to the merchant or on file with the merchant. Email Address is required if you are processing the transaction using PayPal Guest Processing which is offered to select partners and merchants. For all other use cases we do not expect partners/merchant to send email_address of their customer. |
| phone | object (phone_with_type)
The phone number of the buyer as provided to the merchant or on file with the merchant. The phone.phone_number supports only national_number. |

Copy

Expand allCollapse all

{"id": "string",\ \ "email_address": "string",\ \ "phone": {"phone_type": "FAX",\ \ "phone_number": {"national_number": "string"\ \ }\ \ }\ \ }
\

[schema/customized_customer_1 customer\

schema/customized_customer_2 customer\

schema/customized_customer_3 customer\

schema/customized_customer_4 customer\

schema/date_no_time date_no_time\

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.

string<ppaas_date_notime_v2> (date_no_time) = 10 characters^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern

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.

Copy

"stringstri"
\

schema/date_time date_time\

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.

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]|...Show pattern

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.

Copy

"stringstringstringst"
\

schema/date_time_v4 date_time\

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.

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]|...Show pattern

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.

Copy

"stringstringstringst"
\

schema/date_year_month date_year_month\

The year and month, in ISO-8601 YYYY-MM date format. See Internet date and time format.

string (date_year_month) = 7 characters^[0-9]{4}-(0[1-9]|1[0-2])$

The year and month, in ISO-8601 YYYY-MM date format. See Internet date and time format.

Copy

"strings"
\

schema/wallet_base digital_wallet\

Resource consolidating common request and response attributes for vaulting a Digital Wallet.

| description | string[ 1 .. 128 ] characters^.*$
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. |
| usage_pattern | string[ 1 .. 30 ] characters^[0-9A-Z_]+$

Expected business/charge model for the billing agreement.

| Enum Value | Description |
| --- | --- |
| IMMEDIATE | On-demand instant payments - non-recurring, pre-paid, variable amount, variable frequency. |
| DEFERRED | Pay after use, non-recurring post-paid, variable amount, irregular frequency. |
| RECURRING_PREPAID | Pay upfront fixed or variable amount on a fixed date before the goods/service is delivered. |
| RECURRING_POSTPAID | Pay on a fixed date based on usage or consumption after the goods/service is delivered. |
| THRESHOLD_PREPAID | Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, before the goods/service is delivered. |
| THRESHOLD_POSTPAID | Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, after the goods/service is delivered. |
| UNSCHEDULED_POSTPAID | Merchant-managed installment plan when the amount to be paid and the billing frequency are fixed, but there is a defined number of payments with the payment due after the goods/services are delivered. |
| UNSCHEDULED_PREPAID | Unscheduled card on file plan where the merchant can bill buyer upfront based on an agreed logic, but amount due and frequency can vary. Inclusive of automatic reload plans. |
| SUBSCRIPTION_PREPAID | Subscription plan where the amount due and the billing frequency are fixed, and there is no defined duration with the payment due before the good/service is delivered. |
| SUBSCRIPTION_POSTPAID | Subscription plan where the amount due and the billing frequency are fixed, and there is no defined duration with the payment due after the goods/services are delivered. |
| INSTALLMENT_POSTPAID | Merchant-managed installment plan when the amount to be paid and the billing frequency are fixed, but there is a defined number of payments with the payment due after the goods/services are delivered. |
| INSTALLMENT_PREPAID | Merchant-managed installment plan when the amount to be paid and the billing frequency are fixed, but there is a defined number of payments with the payment due before the good/service is delivered. | |
| 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.

| Enum Value | Description |
| --- | --- |
| MERCHANT | The PayPal Payment Token will be used for future transaction directly with a merchant. |
| PLATFORM | The PayPal Payment Token will be used for future transaction on a platform. A platform is typically a marketplace or a channel that a payer can purchase goods and services from multiple merchants. | |
| 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.

| Enum Value | Description |
| --- | --- |
| CONSUMER | The customer vaulting the PayPal payment token is a consumer on the merchant / platform. |
| BUSINESS | The customer vaulting the PayPal payment token is a business on merchant / platform. | |
| shipping | object (shipping_detail)
The shipping address for the Payer. |

Copy

Expand allCollapse all

{"description": "string",\ \ "usage_pattern": "IMMEDIATE",\ \ "permit_multiple_payment_tokens": false,\ \ "usage_type": "MERCHANT",\ \ "customer_type": "CONSUMER",\ \ "shipping": {"type": "SHIPPING",\ \ "name": {"full_name": "string"\ \ },\ \ "phone_number": {"country_code": "str",\ \ "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"\ \ }\ \ }\ \ }
\

schema/disbursement_mode disbursement_mode\

The funds that are held on behalf of the merchant.

string (disbursement_mode) [ 1 .. 16 ] characters^[A-Z_]+$

Default:"INSTANT"

The funds that are held on behalf of the merchant.

| Enum Value | Description |
| --- | --- |
| INSTANT | The funds are released to the merchant immediately. |
| DELAYED | The funds are held for a finite number of days. The actual duration depends on the region and type of integration. You can release the funds through a referenced payout. Otherwise, the funds disbursed automatically after the specified duration. |

Copy

"INSTANT"
\

schema/email email\

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<merchant_common_email_address_v2> (email) [ 3 .. 254 ] characters(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.\a-zA-...Show pattern

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.

Copy

"string"
\

[schema/enrolled enrolled\

Status of Authentication eligibility.

string (enrolled) [ 1 .. 255 ] characters^[0-9A-Z_]+$

Status of Authentication eligibility.

| Enum Value | Description |
| --- | --- |
| Y | Yes. The bank is participating in 3-D Secure protocol and will return the ACSUrl. |
| N | No. The bank is not participating in 3-D Secure protocol. |
| U | Unavailable. The DS or ACS is not available for authentication at the time of the request. |
| B | Bypass. The merchant authentication rule is triggered to bypass authentication. |

Copy

"Y"
\

schema/error Error\

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. |
| details | Array of objects (Error Details)
An array of additional details about the error. |
| links | Array of objects (Link Description)
An array of request-related HATEOAS links. |

Copy

Expand allCollapse all

{"name": "string",\ \ "message": "string",\ \ "debug_id": "string",\ \ "details": [{"field": "string",\ \ "value": "string",\ \ "location": "body",\ \ "issue": "string",\ \ "links": [{"href": "string",\ \ "rel": "string",\ \ "method": "GET"\ \ }\ \ ],\ \ "description": "string"\ \ }\ \ ],\ \ "links": [{"href": "string",\ \ "rel": "string",\ \ "method": "GET"\ \ }\ \ ]\ \ }
\

schema/error_details Error Details\

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 body, path, or query. |
| issue
required | string
The unique, fine-grained application-level error code. |
| links | Array of objects (Link Description) [ 1 .. 4 ] items
An array of request-related HATEOAS links that are either relevant to the issue by providing additional information or offering potential resolutions. |
| 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. |

Copy

Expand allCollapse all

{"field": "string",\ \ "value": "string",\ \ "location": "body",\ \ "issue": "string",\ \ "links": [{"href": "string",\ \ "rel": "string",\ \ "method": "GET"\ \ }\ \ ],\ \ "description": "string"\ \ }
\

schema/customized_experience_context_1 experience_context\

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}|[...Show pattern
The BCP 47-formatted locale of pages that the PayPal vaulting experience shows. PayPal supports a five-character code. For example, DA-DK, HE-IL, ID-ID, JA-JP, NO-NO, PT-BR, RU-RU, SV-SE, TH-TH, ZH-CN, ZH-HK, or ZH-TW. |
| 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.

| Enum Value | Description |
| --- | --- |
| ON_CREATE_PAYMENT_TOKENS | Vault the payment method after API caller performs a successful POST on Payment Tokens. |
| ON_PAYER_APPROVAL | Vault the payment method on successful payer authentication and approval. | |

Copy

{"brand_name": "string",\ \ "return_url": "http://example.com",\ \ "cancel_url": "http://example.com",\ \ "locale": "string",\ \ "vault_instruction": "ON_CREATE_PAYMENT_TOKENS"\ \ }
\

schema/experience_context experience_context\

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.

| Enum Value | Description |
| --- | --- |
| GET_FROM_FILE | Use the payer-provided shipping address on the PayPal site. |
| NO_SHIPPING | Redact the shipping address from the PayPal site. Recommended for digital goods. |
| SET_PROVIDED_ADDRESS | Use the merchant/platform-provided address. The payer cannot change this address on the PayPal site. If the merchant does not pass an address, the customer can choose the address on the PayPal site. | |
| locale | string<ppaas_common_language_v3> (language) [ 2 .. 10 ] characters^[a-z]{2}(?:-[A-Z][a-z]{3})?(?😦?:[A-Z]{2}|[...Show pattern
The BCP 47-formatted locale of pages that the PayPal vaulting experience shows. PayPal supports a five-character code. For example, DA-DK, HE-IL, ID-ID, JA-JP, NO-NO, PT-BR, RU-RU, SV-SE, TH-TH, ZH-CN, ZH-HK, or ZH-TW. |
| 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.

| Enum Value | Description |
| --- | --- |
| ON_CREATE_PAYMENT_TOKENS | Vault the payment method after API caller performs a successful POST on Payment Tokens. |
| ON_PAYER_APPROVAL | Vault the payment method on successful payer authentication and approval. | |

Copy

{"brand_name": "string",\ \ "return_url": "http://example.com",\ \ "cancel_url": "http://example.com",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "vault_instruction": "ON_CREATE_PAYMENT_TOKENS"\ \ }
\

schema/customized_experience_context_2 experience_context\

schema/external_reference external_reference\

Stores the external id value for a given vault session cache.

| id | string[ 1 .. 255 ] characters^[0-9a-zA-Z_-]+$
The PayPal-generated ID for the external reference. |
| type | string[ 1 .. 255 ] characters^[0-9A-Z_]+$

The tokenization method that generated the external reference.

| Value | Description |
| --- | --- |
| BA_TOKEN | The PayPal billing agreement token type. References an approval token created on which approval is to be provided. | |

Copy

{"id": "string",\ \ "type": "BA_TOKEN"\ \ }
\

schema/iban_last_chars iban_last_chars\

The last characters of the IBAN used to pay.

string (iban_last_chars) [ 4 .. 34 ] characters[a-zA-Z0-9]{4}

The last characters of the IBAN used to pay.

Copy

"string"
\

schema/vault_id id\

The PayPal-generated ID for the vault token.

string (id) [ 1 .. 36 ] characters^[0-9a-zA-Z_-]+$

The PayPal-generated ID for the vault token.

Copy

"string"
\

schema/instrument_id instrument_id\

The identifier of the instrument.

string (instrument_id) [ 1 .. 256 ] characters^[A-Za-z0-9-_.+=]+$

The identifier of the instrument.

Copy

"string"
\

schema/customized_item_1 item\

The details for the items to be purchased.

| | |
| --- | --- |
| name
required | string[ 1 .. 127 ] characters
The item name or title. |
| quantity
required | string<= 10 characters^[1-9][0-9]{0,9}$
The item quantity. Must be a whole number. |
| description | string<= 127 characters
The detailed item description. |
| sku | string<= 127 characters
The stock keeping unit (SKU) for the item. |
| url | string<uri>[ 1 .. 2048 ] characters
The URL to the item being purchased. Visible to buyer and used in buyer experiences. |
| image_url | string<uri>[ 1 .. 2048 ] characters^(https:)([/|.|\w|\s|-])*\.(?:jpg|gif|png|jpe...Show pattern
The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored. |
| upc | object (universal_product_code)
The Universal Product Code of the item. |

Copy

Expand allCollapse all

{"name": "string",\ \ "quantity": "string",\ \ "description": "string",\ \ "sku": "string",\ \ "url": "http://example.com",\ \ "image_url": "http://example.com",\ \ "upc": {"type": "UPC-A",\ \ "code": "string"\ \ }\ \ }
\

schema/language language\

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<ppaas_common_language_v3> (language) [ 2 .. 10 ] characters^[a-z]{2}(?:-[A-Z][a-z]{3})?(?😦?:[A-Z]{2}|...Show pattern

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.

Copy

"string"
\

schema/language_v4 language\

schema/level_2_card_processing_data level_2\

The level 2 card processing data collections. If your merchant account has been configured for Level 2 processing this field will be passed to the processor on your behalf. Please contact your PayPal Technical Account Manager to define level 2 data for your business.

| | |
| --- | --- |
| invoice_id | string[ 1 .. 127 ] characters^[\w‘\-.,":;\!?]*$
Use this field to pass a purchase identification value of up to 127 ASCII characters. The length of this field will be adjusted to meet network specifications (25chars for Visa and Mastercard, 17chars for Amex), and the original invoice ID will still be displayed in your existing reports. |
| tax_total | object (Money)
Use this field to break down the amount of tax included in the total purchase amount. The value provided here will not add to the total purchase amount. The value can't be negative, and in most cases, it must be greater than zero in order to qualify for lower interchange rates.
Value, by country, is:
 UK. A county. US. A state. Canada. A province. Japan. A prefecture. Switzerland. A kanton.  |

Copy

Expand allCollapse all

{"invoice_id": "string",\ \ "tax_total": {"currency_code": "str",\ \ "value": "string"\ \ }\ \ }
\

schema/level_3_card_processing_data level_3\

The level 3 card processing data collections, If your merchant account has been configured for Level 3 processing this field will be passed to the processor on your behalf. Please contact your PayPal Technical Account Manager to define level 3 data for your business.

| | |
| --- | --- |
| ships_from_postal_code | string[ 1 .. 60 ] characters^[a-zA-Z0-9_'.-]*$
Use this field to specify the postal code of the shipping location. |
| line_items | Array of objects (line_item) [ 1 .. 100 ] items
A list of the items that were purchased with this payment. If your merchant account has been configured for Level 3 processing this field will be passed to the processor on your behalf. |
| shipping_amount | object (Money)
Use this field to break down the shipping cost included in the total purchase amount. The value provided here will not add to the total purchase amount. The value cannot be negative. |
| duty_amount | object (Money)
Use this field to break down the duty amount included in the total purchase amount. The value provided here will not add to the total purchase amount. The value cannot be negative. |
| discount_amount | object (Money)
Use this field to break down the discount amount included in the total purchase amount. The value provided here will not add to the total purchase amount. The value cannot be negative. |
| shipping_address | object (Portable Postal Address (Medium-Grained))
The address of the person to whom to ship the items. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties. |

Copy

Expand allCollapse all

{"ships_from_postal_code": "string",\ \ "line_items": [{"name": "string",\ \ "quantity": "string",\ \ "description": "string",\ \ "sku": "string",\ \ "url": "http://example.com",\ \ "image_url": "http://example.com",\ \ "upc": {"type": "UPC-A",\ \ "code": "string"\ \ },\ \ "commodity_code": "string",\ \ "unit_of_measure": "string",\ \ "unit_amount": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "tax": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "discount_amount": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "total_amount": {"currency_code": "str",\ \ "value": "string"\ \ }\ \ }\ \ ],\ \ "shipping_amount": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "duty_amount": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "discount_amount": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "shipping_address": {"address_line_1": "string",\ \ "address_line_2": "string",\ \ "admin_area_2": "string",\ \ "admin_area_1": "string",\ \ "postal_code": "string",\ \ "country_code": "st"\ \ }\ \ }
\

schema/liability_shift liability_shift\

Liability shift indicator. The outcome of the issuer's authentication.

string (liability_shift) [ 1 .. 255 ] characters^[0-9A-Z_]+$

Liability shift indicator. The outcome of the issuer's authentication.

| Enum Value | Description |
| --- | --- |
| NO | Liability is with the merchant. |
| POSSIBLE | Liability may shift to the card issuer. |
| UNKNOWN | The authentication system is not available. |

Copy

"NO"
\

schema/line_item line_item\

The line items for this purchase. If your merchant account has been configured for Level 3 processing this field will be passed to the processor on your behalf.

| | |
| --- | --- |
| name
required | string[ 1 .. 127 ] characters
The item name or title. |
| quantity
required | string<= 10 characters^[1-9][0-9]{0,9}$
The item quantity. Must be a whole number. |
| description | string<= 127 characters
The detailed item description. |
| sku | string<= 127 characters
The stock keeping unit (SKU) for the item. |
| url | string<uri>[ 1 .. 2048 ] characters
The URL to the item being purchased. Visible to buyer and used in buyer experiences. |
| image_url | string<uri>[ 1 .. 2048 ] characters^(https:)([/|.|\w|\s|-])*\.(?:jpg|gif|png|jpe...Show pattern
The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored. |
| upc | object (universal_product_code)
The Universal Product Code of the item. |
| commodity_code | string[ 1 .. 12 ] characters^[a-zA-Z0-9_'.-]*$
Code used to classify items purchased and track the total amount spent across various categories of products and services. Different corporate purchasing organizations may use different standards, but the United Nations Standard Products and Services Code (UNSPSC) is frequently used. |
| unit_of_measure | string[ 1 .. 12 ] characters^[a-zA-Z0-9_'.-]*$
Unit of measure is a standard used to express the magnitude of a quantity in international trade. Most commonly used (but not limited to) examples are: Acre (ACR), Ampere (AMP), Centigram (CGM), Centimetre (CMT), Cubic inch (INQ), Cubic metre (MTQ), Fluid ounce (OZA), Foot (FOT), Hour (HUR), Item (ITM), Kilogram (KGM), Kilometre (KMT), Kilowatt (KWT), Liquid gallon (GLL), Liter (LTR), Pounds (LBS), Square foot (FTK). |
| unit_amount
required | object (Money)
The item price or rate per unit. Must equal unit_amount * quantity for all items. unit_amount.value can not be a negative number. |
| tax | object (Money)
The item tax for each unit. Must equal tax * quantity for all items. tax.value can not be a negative number. |
| discount_amount | object (Money)
Use this field to break down the discount amount included in the total purchase amount. The value provided here will not add to the total purchase amount. The value cannot be negative. |
| total_amount | object (Money)
The subtotal for all items. Must equal the sum of (items[].unit_amount * items[].quantity) for all items. item_total.value can not be a negative number. |

Copy

Expand allCollapse all

{"name": "string",\ \ "quantity": "string",\ \ "description": "string",\ \ "sku": "string",\ \ "url": "http://example.com",\ \ "image_url": "http://example.com",\ \ "upc": {"type": "UPC-A",\ \ "code": "string"\ \ },\ \ "commodity_code": "string",\ \ "unit_of_measure": "string",\ \ "unit_amount": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "tax": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "discount_amount": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "total_amount": {"currency_code": "str",\ \ "value": "string"\ \ }\ \ }
\

schema/link_description Link Description\

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 $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call. |
| 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.
Enum:"GET""POST""PUT""DELETE""HEAD""CONNECT""OPTIONS""PATCH" |

Copy

{"href": "string",\ \ "rel": "string",\ \ "method": "GET"\ \ }
\

schema/link_description_v5 Link Description\

schema/merchant_partner_customer_id merchant_partner_customer_id\

The unique ID for a customer generated by PayPal.

string (merchant_partner_customer_id) [ 1 .. 22 ] characters^[0-9a-zA-Z_-]+$

The unique ID for a customer generated by PayPal.

Copy

"string"
\

schema/money Money\

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:
- An integer for currencies like JPY that are not typically fractional.
- A decimal fraction for currencies like TND that are subdivided into thousandths.
For the required number of decimal places for a currency code, see Currency Codes. |

Copy

{"currency_code": "str",\ \ "value": "string"\ \ }
\

schema/customized_name_1 Name\

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

Copy

{"given_name": "string",\ \ "surname": "string"\ \ }
\

schema/customized_name_2 Name\

The name of the party.

| | |
| --- | --- |
| full_name | string<= 300 characters
When the party is a person, the party's full name. |

Copy

{"full_name": "string"\ \ }
\

schema/customized_name_3 Name\

schema/customized_name_4 Name\

schema/customized_name_5 Name\

The name of the party.

| | |
| --- | --- |
| full_name | string<= 300 characters
When the party is a person, the party's full name. |

Copy

{"full_name": "string"\ \ }
\

schema/network_token_response network_token_response\

A 3rd party network token refers to a token that is provisioned and vaulted on behalf of the merchants with an external TSP (Token Service Provider).

| | |
| --- | --- |
| id | string[ 1 .. 255 ] characters^.*$
Third party network token id. |
| cryptogram | string[ 1 .. 262144 ] characters^.*$
An Encrypted one-time use value that's sent along with Network Token. |
| expiry | string (date_year_month) = 7 characters^[0-9]{4}-(0[1-9]|1[0-2])$
The token expiration year and month, in Internet date format. |

Copy

{"id": "string",\ \ "cryptogram": "string",\ \ "expiry": "string"\ \ }
\

schema/customized_network_transaction_reference_1 network_transaction_reference\

Reference values used by the card network to identify a transaction.

| id
required | string[ 9 .. 36 ] characters^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$
Transaction reference id returned by the scheme. For Visa and Amex, this is the "Tran id" field in response. For MasterCard, this is the "BankNet reference id" field in response. For Discover, this is the "NRID" field in response. The pattern we expect for this field from Visa/Amex/CB/Discover is numeric, Mastercard/BNPP is alphanumeric and Paysecure is alphanumeric with special character -. |
| date | string= 4 characters^[0-9]+$
The date that the transaction was authorized by the scheme. This field may not be returned for all networks. MasterCard refers to this field as "BankNet reference date. |
| network | string (card_brand) [ 1 .. 255 ] characters^[A-Z_]+$

Name of the card network through which the transaction was routed.

| Enum Value | 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. |
| DINERS | The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services. |
| ELO | The Brazilian Elo card payment network. |
| HIPER | The Hiper - Ingenico ePayment network. |
| HIPERCARD | The Brazilian Hipercard payment network that's widely accepted in the retail market. |
| RUPAY | The RuPay payment network. |
| GE | The GE Credit Union 3Point card payment network. |
| SYNCHRONY | The Synchrony Financial (SYF) payment network. |
| EFTPOS | The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network. |
| UNKNOWN | UNKNOWN payment network. | |

Copy

{"id": "stringstr",\ \ "date": "stri",\ \ "network": "VISA"\ \ }
\

schema/network_transaction_reference_entity network_transaction_reference_entity\

Previous network transaction reference including id and network.

| id
required | string[ 9 .. 36 ] characters^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$
Transaction reference id returned by the scheme. For Visa and Amex, this is the "Tran id" field in response. For MasterCard, this is the "BankNet reference id" field in response. For Discover, this is the "NRID" field in response. The pattern we expect for this field from Visa/Amex/CB/Discover is numeric, Mastercard/BNPP is alphanumeric and Paysecure is alphanumeric with special character -. |
| date | string= 4 characters^[0-9]+$
The date that the transaction was authorized by the scheme. This field may not be returned for all networks. MasterCard refers to this field as "BankNet reference date. |
| network | string (card_brand) [ 1 .. 255 ] characters^[A-Z_]+$

Name of the card network through which the transaction was routed.

| Enum Value | 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. |
| DINERS | The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services. |
| ELO | The Brazilian Elo card payment network. |
| HIPER | The Hiper - Ingenico ePayment network. |
| HIPERCARD | The Brazilian Hipercard payment network that's widely accepted in the retail market. |
| RUPAY | The RuPay payment network. |
| GE | The GE Credit Union 3Point card payment network. |
| SYNCHRONY | The Synchrony Financial (SYF) payment network. |
| EFTPOS | The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network. |
| UNKNOWN | UNKNOWN payment network. | |
| 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]|...Show pattern
The date and time when the instrument was verified. |

Copy

{"id": "stringstr",\ \ "date": "stri",\ \ "network": "VISA",\ \ "time": "stringstringstringst"\ \ }
\

schema/network_transaction_reference_response network_transaction_reference_response\

Previous network transaction reference including id in response.

| id
required | string[ 9 .. 36 ] characters^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$
Transaction reference id returned by the scheme. For Visa and Amex, this is the "Tran id" field in response. For MasterCard, this is the "BankNet reference id" field in response. For Discover, this is the "NRID" field in response. The pattern we expect for this field from Visa/Amex/CB/Discover is numeric, Mastercard/BNPP is alphanumeric and Paysecure is alphanumeric with special character -. |
| date | string= 4 characters^[0-9]+$
The date that the transaction was authorized by the scheme. This field may not be returned for all networks. MasterCard refers to this field as "BankNet reference date. |
| network | string (card_brand) [ 1 .. 255 ] characters^[A-Z_]+$

Name of the card network through which the transaction was routed.

| Enum Value | 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. |
| DINERS | The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services. |
| ELO | The Brazilian Elo card payment network. |
| HIPER | The Hiper - Ingenico ePayment network. |
| HIPERCARD | The Brazilian Hipercard payment network that's widely accepted in the retail market. |
| RUPAY | The RuPay payment network. |
| GE | The GE Credit Union 3Point card payment network. |
| SYNCHRONY | The Synchrony Financial (SYF) payment network. |
| EFTPOS | The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network. |
| UNKNOWN | UNKNOWN payment network. | |
| 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]|...Show pattern
The date and time when the instrument was verified. |

Copy

{"id": "stringstr",\ \ "date": "stri",\ \ "network": "VISA",\ \ "time": "stringstringstringst"\ \ }
\

schema/one_time_charges one_time_charges\

The one-time charge info at the time of checkout.

| | |
| --- | --- |
| setup_fee | object (Money)
The setup fee for the recurring plan. |
| shipping_amount | object (Money)
The shipping amount due at the time of checkout. |
| taxes | object (Money)
The taxes due at the time of checkout. |
| product_price | object (Money)
The product price for any one-time product purchased at the time of checkout. |
| subtotal | object (Money)
The subtotal at the time of checkout. This is calculated by using the formula x + y + z where x is first-recurring-charge, y is setup-fee and z is item-price. |
| total_amount
required | object (Money)
The total amount at the time of checkout. This is calculated by using the formula x + y + z where x is subtotal, y is shipping-amount and z is taxes. |

Copy

Expand allCollapse all

{"setup_fee": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "shipping_amount": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "taxes": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "product_price": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "subtotal": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "total_amount": {"currency_code": "str",\ \ "value": "string"\ \ }\ \ }
\

schema/pares_status pares_status\

Transactions status result identifier. The outcome of the issuer's authentication.

string (pares_status) [ 1 .. 255 ] characters^[0-9A-Z_]+$

Transactions status result identifier. The outcome of the issuer's authentication.

| Enum Value | Description |
| --- | --- |
| Y | Successful authentication. |
| N | Failed authentication / account not verified / transaction denied. |
| U | Unable to complete authentication. |
| A | Successful attempts transaction. |
| C | Challenge required for authentication. |
| R | Authentication rejected (merchant must not submit for authorization). |
| D | Challenge required; decoupled authentication confirmed. |
| I | Informational only; 3DS requestor challenge preference acknowledged. |

Copy

"Y"
\

schema/patch Patch\

The JSON patch object to apply partial updates to resources.

| op
required | string

The operation.

| Enum Value | Description |
| --- | --- |
| add | Depending on the target location reference, completes one of these functions:
- The target location is an array index. Inserts a new value into the array at the specified index.
- The target location is an object parameter that does not already exist. Adds a new parameter to the object.
- The target location is an object parameter that does exist. Replaces that parameter's value.
The value parameter defines the value to add. For more information, see 4.1. add. |
| remove | Removes the value at the target location. For the operation to succeed, the target location must exist. For more information, see 4.2. remove. |
| replace | Replaces the value at the target location with a new value. The operation object must contain a value parameter that defines the replacement value. For the operation to succeed, the target location must exist. For more information, see 4.3. replace. |
| move | Removes the value at a specified location and adds it to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to move the value. For the operation to succeed, the from location must exist. For more information, see 4.4. move. |
| copy | Copies the value at a specified location to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to copy the value. For the operation to succeed, the from location must exist. For more information, see 4.5. copy. |
| test | Tests that a value at the target location is equal to a specified value. The operation object must contain a value parameter that defines the value to compare to the target location's value. For the operation to succeed, the target location must be equal to the value value. For test, equal indicates that the value at the target location and the value that value defines are of the same JSON type. The data type of the value determines how equality is defined:

| Type | Considered equal if both values |
| --- | --- |
| strings | Contain the same number of Unicode characters and their code points are byte-by-byte equal. |
| numbers | Are numerically equal. |
| arrays | Contain the same number of values, and each value is equal to the value at the corresponding position in the other array, by using these type-specific rules. |
| objects | Contain the same number of parameters, and each parameter is equal to a parameter in the other object, by comparing their keys (as strings) and their values (by using these type-specific rules). |
| literals (false, true, and null) | Are the same. The comparison is a logical comparison. For example, whitespace between the parameter values of an array is not significant. Also, ordering of the serialization of object parameters is not significant. |

For more information, see 4.6. test. | |
| path | string
The JSON Pointer to the target document location at which to complete the operation. |
| value | any (Patch Value)
The value to apply. The remove, copy, and move operations do not require a value. Since JSON Patch allows any type for value, the type property is not specified. |
| from | string
The JSON Pointer to the target document location from which to move the value. Required for the move operation. |

Copy

{"op": "add",\ \ "path": "string",\ \ "value": null,\ \ "from": "string"\ \ }
\

schema/patch_v4 Patch\

schema/payee_base payee_base\

The details for the merchant who receives the funds and fulfills the order. The merchant is also known as the payee.

| | |
| --- | --- |
| email_address | string<merchant_common_email_address_v2> (email) [ 3 .. 254 ] characters(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-...Show pattern
The email address of merchant. |
| merchant_id | string<ppaas_payer_id_v3> (PayPal Account Identifier) = 13 characters^[2-9A-HJ-NP-Z]{13}$
The encrypted PayPal account ID of the merchant. |

Copy

{"email_address": "string",\ \ "merchant_id": "stringstrings"\ \ }
\

schema/customized_payer_1 payer\

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-...Show pattern
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. |
| name | object (Name)
The name of the payer. Supports only the given_name and surname properties. |
| phone | 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 phone.phone_number supports only national_number. |
| address | object (Portable Postal Address (Medium-Grained))
The address of the payer. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties. Also referred to as the billing address of the customer. |

Copy

Expand allCollapse all

{"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"\ \ }\ \ }
\

schema/customized_payer_2 payer\

schema/payer_base payer_base\

schema/payment_method_credentials_card_response payment_method_credentials_card_response\

Full representation of a Card Payment Token including network token for payment method credentials.

| last_digits | string[ 2 .. 4 ] characters[0-9]
The last digits of the payment card. |
| network_token | object (network_token_response)
A 3rd party network token refers to a token that is provisioned and vaulted on behalf of the merchants with an external TSP (Token Service Provider). |
| brand | string (card_brand) [ 1 .. 255 ] characters^[A-Z_]+$

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

| Enum Value | 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. |
| DINERS | The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services. |
| ELO | The Brazilian Elo card payment network. |
| HIPER | The Hiper - Ingenico ePayment network. |
| HIPERCARD | The Brazilian Hipercard payment network that's widely accepted in the retail market. |
| RUPAY | The RuPay payment network. |
| GE | The GE Credit Union 3Point card payment network. |
| SYNCHRONY | The Synchrony Financial (SYF) payment network. |
| EFTPOS | The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network. |
| UNKNOWN | UNKNOWN payment network. | |
| 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. |

Copy

Expand allCollapse all

{"last_digits": "stri",\ \ "network_token": {"id": "string",\ \ "cryptogram": "string",\ \ "expiry": "string"\ \ },\ \ "brand": "VISA",\ \ "expiry": "string"\ \ }
\

schema/payment_method_credentials_token_request payment_method_credentials_token_request\

Payment Method Credentials request to generate network token details for the underlying card associated with the single use token or payment method token.

| id
required | string[ 1 .. 255 ] characters^[0-9A-Za-z_-]+$
The PayPal-generated single use token or payment method token. |
| type
required | string[ 1 .. 32 ] characters^[A-Z0-9_]+$

The tokenization method that generated the ID.

| Enum Value | Description |
| --- | --- |
| SINGLE_USE_TOKEN | The single use token is a PayPal generated one time use token, representing underlying payment source. |
| PAYMENT_METHOD_TOKEN | The payment method token is a permanent token generated by the merchant, representing underlying payment source. | |

Copy

{"id": "string",\ \ "type": "SINGLE_USE_TOKEN"\ \ }
\

schema/payment_token_response payment_token_response\

Full representation of a saved payment token.

| | |
| --- | --- |
| payment_source | object (Payment token response payment source)
The vaulted payment method details. |
| links | 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. |
| customer | object (customer)
Customer in merchant's or partner's system of records. |

Copy

Expand allCollapse all

{"payment_source": {"card": {"name": "string",\ \ "last_digits": "stri",\ \ "verification": {"network_transaction_id": "string",\ \ "date": "stri",\ \ "network": "VISA",\ \ "time": "string",\ \ "amount": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "processor_response": {"avs_code": "A",\ \ "cvv_code": "E"\ \ },\ \ "three_d_secure": null\ \ },\ \ "network_transaction_reference": {"id": "stringstr",\ \ "date": "stri",\ \ "network": "VISA",\ \ "time": "stringstringstringst"\ \ },\ \ "authentication_result": {"three_d_secure": {"authentication_status": "Y",\ \ "enrollment_status": "Y",\ \ "authentication_id": "string"\ \ }\ \ },\ \ "brand": "VISA",\ \ "expiry": "strings",\ \ "billing_address": {"address_line_1": "string",\ \ "address_line_2": "string",\ \ "admin_area_2": "string",\ \ "admin_area_1": "string",\ \ "postal_code": "string",\ \ "country_code": "st",\ \ "id": "string"\ \ },\ \ "verification_status": "VERIFIED",\ \ "bin_details": {"bin": "string",\ \ "issuing_bank": "string",\ \ "products": ["string"\ \ ],\ \ "bin_country_code": "string"\ \ },\ \ "type": "CREDIT"\ \ },\ \ "paypal": {"description": "string",\ \ "usage_pattern": "IMMEDIATE",\ \ "permit_multiple_payment_tokens": false,\ \ "usage_type": "MERCHANT",\ \ "customer_type": "CONSUMER",\ \ "shipping": {"type": "SHIPPING",\ \ "name": {"full_name": "string"\ \ },\ \ "phone_number": {"country_code": "str",\ \ "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"\ \ }\ \ },\ \ "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"\ \ },\ \ "account_id": "stringstrings",\ \ "phone_number": {"country_code": "str",\ \ "national_number": "string",\ \ "extension_number": "string"\ \ }\ \ },\ \ "venmo": {"description": "string",\ \ "usage_pattern": "IMMEDIATE",\ \ "permit_multiple_payment_tokens": false,\ \ "usage_type": "MERCHANT",\ \ "customer_type": "CONSUMER",\ \ "shipping": {"type": "SHIPPING",\ \ "name": {"full_name": "string"\ \ },\ \ "phone_number": {"country_code": "str",\ \ "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"\ \ }\ \ },\ \ "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"\ \ }\ \ }\ \ }\ \ },\ \ "links": [{"href": "string",\ \ "rel": "string",\ \ "method": "GET"\ \ }\ \ ],\ \ "id": "string",\ \ "customer": {"merchant_customer_id": "string",\ \ "id": "string"\ \ }\ \ }
\

schema/payment_token_status payment_token_status\

The status of the payment token.

string (payment_token_status) [ 1 .. 255 ] characters^[0-9A-Z_]+$

Default:"CREATED"

The status of the payment token.

| Enum Value | Description |
| --- | --- |
| CREATED | A setup token is initialized with minimal information, more data must be added to the setup-token to be vaulted |
| PAYER_ACTION_REQUIRED | A contingecy on payer approval is required before the payment method can be saved. |
| APPROVED | Setup token is ready to be vaulted. If a buyer approval contigency was returned, it is has been approved. |
| VAULTED | The payment token has been vaulted. |
| TOKENIZED | A vaulted payment method token has been tokenized for short term (one time) use. |

Copy

"CREATED"
\

schema/account_id PayPal Account Identifier\

The account identifier for a PayPal account.

string<ppaas_payer_id_v3> (PayPal Account Identifier) = 13 characters^[2-9A-HJ-NP-Z]{13}$

The account identifier for a PayPal account.

Copy

"stringstrings"
\

schema/paypal_wallet_request paypal_wallet_request\

A resource representing a request to vault PayPal Wallet.

| description | string[ 1 .. 128 ] characters^.*$
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. |
| usage_pattern | string[ 1 .. 30 ] characters^[0-9A-Z_]+$

Expected business/charge model for the billing agreement.

| Enum Value | Description |
| --- | --- |
| IMMEDIATE | On-demand instant payments - non-recurring, pre-paid, variable amount, variable frequency. |
| DEFERRED | Pay after use, non-recurring post-paid, variable amount, irregular frequency. |
| RECURRING_PREPAID | Pay upfront fixed or variable amount on a fixed date before the goods/service is delivered. |
| RECURRING_POSTPAID | Pay on a fixed date based on usage or consumption after the goods/service is delivered. |
| THRESHOLD_PREPAID | Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, before the goods/service is delivered. |
| THRESHOLD_POSTPAID | Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, after the goods/service is delivered. |
| UNSCHEDULED_POSTPAID | Merchant-managed installment plan when the amount to be paid and the billing frequency are fixed, but there is a defined number of payments with the payment due after the goods/services are delivered. |
| UNSCHEDULED_PREPAID | Unscheduled card on file plan where the merchant can bill buyer upfront based on an agreed logic, but amount due and frequency can vary. Inclusive of automatic reload plans. |
| SUBSCRIPTION_PREPAID | Subscription plan where the amount due and the billing frequency are fixed, and there is no defined duration with the payment due before the good/service is delivered. |
| SUBSCRIPTION_POSTPAID | Subscription plan where the amount due and the billing frequency are fixed, and there is no defined duration with the payment due after the goods/services are delivered. |
| INSTALLMENT_POSTPAID | Merchant-managed installment plan when the amount to be paid and the billing frequency are fixed, but there is a defined number of payments with the payment due after the goods/services are delivered. |
| INSTALLMENT_PREPAID | Merchant-managed installment plan when the amount to be paid and the billing frequency are fixed, but there is a defined number of payments with the payment due before the good/service is delivered. | |
| 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.

| Enum Value | Description |
| --- | --- |
| MERCHANT | The PayPal Payment Token will be used for future transaction directly with a merchant. |
| PLATFORM | The PayPal Payment Token will be used for future transaction on a platform. A platform is typically a marketplace or a channel that a payer can purchase goods and services from multiple merchants. | |
| 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.

| Enum Value | Description |
| --- | --- |
| CONSUMER | The customer vaulting the PayPal payment token is a consumer on the merchant / platform. |
| BUSINESS | The customer vaulting the PayPal payment token is a business on merchant / platform. | |
| shipping | object (shipping_detail)
The shipping address for the Payer. |
| billing_plan | object (recurring_billing_plan_metadata)
The merchant level Recurring Billing plan metadata for the Billing Agreement. |
| experience_context | object (experience_context)
Customizes the Vault creation flow experience for your customers. |

Copy

Expand allCollapse all

{"description": "string",\ \ "usage_pattern": "IMMEDIATE",\ \ "permit_multiple_payment_tokens": false,\ \ "usage_type": "MERCHANT",\ \ "customer_type": "CONSUMER",\ \ "shipping": {"type": "SHIPPING",\ \ "name": {"full_name": "string"\ \ },\ \ "phone_number": {"country_code": "str",\ \ "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"\ \ }\ \ },\ \ "billing_plan": {"billing_cycles": [{"tenure_type": "REGULAR",\ \ "total_cycles": 1,\ \ "sequence": 1,\ \ "pricing_scheme": {"pricing_model": "FIXED",\ \ "price": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "reload_threshold_amount": {"currency_code": "str",\ \ "value": "string"\ \ }\ \ },\ \ "start_date": "string"\ \ }\ \ ],\ \ "name": "string",\ \ "one_time_charges": {"setup_fee": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "shipping_amount": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "taxes": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "product_price": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "subtotal": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "total_amount": {"currency_code": "str",\ \ "value": "string"\ \ }\ \ }\ \ },\ \ "experience_context": {"brand_name": "string",\ \ "return_url": "http://example.com",\ \ "cancel_url": "http://example.com",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "vault_instruction": "ON_CREATE_PAYMENT_TOKENS"\ \ }\ \ }
\

schema/paypal_wallet_response paypal_wallet_response\

Full representation of a PayPal Payment Token.

| description | string[ 1 .. 128 ] characters^.*$
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. |
| usage_pattern | string[ 1 .. 30 ] characters^[0-9A-Z_]+$

Expected business/charge model for the billing agreement.

| Enum Value | Description |
| --- | --- |
| IMMEDIATE | On-demand instant payments - non-recurring, pre-paid, variable amount, variable frequency. |
| DEFERRED | Pay after use, non-recurring post-paid, variable amount, irregular frequency. |
| RECURRING_PREPAID | Pay upfront fixed or variable amount on a fixed date before the goods/service is delivered. |
| RECURRING_POSTPAID | Pay on a fixed date based on usage or consumption after the goods/service is delivered. |
| THRESHOLD_PREPAID | Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, before the goods/service is delivered. |
| THRESHOLD_POSTPAID | Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, after the goods/service is delivered. |
| UNSCHEDULED_POSTPAID | Merchant-managed installment plan when the amount to be paid and the billing frequency are fixed, but there is a defined number of payments with the payment due after the goods/services are delivered. |
| UNSCHEDULED_PREPAID | Unscheduled card on file plan where the merchant can bill buyer upfront based on an agreed logic, but amount due and frequency can vary. Inclusive of automatic reload plans. |
| SUBSCRIPTION_PREPAID | Subscription plan where the amount due and the billing frequency are fixed, and there is no defined duration with the payment due before the good/service is delivered. |
| SUBSCRIPTION_POSTPAID | Subscription plan where the amount due and the billing frequency are fixed, and there is no defined duration with the payment due after the goods/services are delivered. |
| INSTALLMENT_POSTPAID | Merchant-managed installment plan when the amount to be paid and the billing frequency are fixed, but there is a defined number of payments with the payment due after the goods/services are delivered. |
| INSTALLMENT_PREPAID | Merchant-managed installment plan when the amount to be paid and the billing frequency are fixed, but there is a defined number of payments with the payment due before the good/service is delivered. | |
| 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.

| Enum Value | Description |
| --- | --- |
| MERCHANT | The PayPal Payment Token will be used for future transaction directly with a merchant. |
| PLATFORM | The PayPal Payment Token will be used for future transaction on a platform. A platform is typically a marketplace or a channel that a payer can purchase goods and services from multiple merchants. | |
| 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.

| Enum Value | Description |
| --- | --- |
| CONSUMER | The customer vaulting the PayPal payment token is a consumer on the merchant / platform. |
| BUSINESS | The customer vaulting the PayPal payment token is a business on merchant / platform. | |
| shipping | object (shipping_detail)
The shipping address for the Payer. |
| email_address | string<merchant_common_email_address_v2> (email) [ 3 .. 254 ] characters(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-...Show pattern
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. |
| name | object (Name)
The name of the payer. Supports only the given_name and surname properties. |
| phone | 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 phone.phone_number supports only national_number. |
| address | object (Portable Postal Address (Medium-Grained))
The address of the payer. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties. Also referred to as the billing address of the customer. |
| 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. |
| phone_number | object (Phone)
The phone number, in its canonical international E.164 numbering plan format. |

Copy

Expand allCollapse all

{"description": "string",\ \ "usage_pattern": "IMMEDIATE",\ \ "permit_multiple_payment_tokens": false,\ \ "usage_type": "MERCHANT",\ \ "customer_type": "CONSUMER",\ \ "shipping": {"type": "SHIPPING",\ \ "name": {"full_name": "string"\ \ },\ \ "phone_number": {"country_code": "str",\ \ "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"\ \ }\ \ },\ \ "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"\ \ },\ \ "account_id": "stringstrings",\ \ "phone_number": {"country_code": "str",\ \ "national_number": "string",\ \ "extension_number": "string"\ \ }\ \ }
\

schema/phone Phone\

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

Copy

{"country_code": "str",\ \ "national_number": "string",\ \ "extension_number": "string"\ \ }
\

schema/customized_phone_1 Phone\

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

Copy

{"country_code": "str",\ \ "national_number": "string"\ \ }
\

schema/customized_phone_2 Phone\

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

Copy

{"national_number": "string"\ \ }
\

schema/customized_phone_3 Phone\

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

Copy

{"country_code": "str",\ \ "national_number": "string"\ \ }
\

schema/phone_type Phone Type\

The phone type.

string (Phone Type)

The phone type.

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

Copy

"FAX"
\

schema/phone_with_type phone_with_type\

The phone information.

| | |
| --- | --- |
| phone_type | string (Phone Type)
The phone type.
Enum:"FAX""HOME""MOBILE""OTHER""PAGER" |
| phone_number
required | object (Phone)
The phone number, in its canonical international E.164 numbering plan format. Supports only the national_number property. |

Copy

Expand allCollapse all

{"phone_type": "FAX",\ \ "phone_number": {"national_number": "string"\ \ }\ \ }
\

schema/platform_fee platform_fee\

The platform or partner fee, commission, or brokerage fee that is associated with the transaction. Not a separate or isolated transaction leg from the external perspective. The platform fee is limited in scope and is always associated with the original payment for the purchase unit.

| | |
| --- | --- |
| amount
required | object (Money)
The fee for this transaction. |
| payee | object (payee_base)
The recipient of the fee for this transaction. If you omit this value, the default is the API caller. |

Copy

Expand allCollapse all

{"amount": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "payee": {"email_address": "string",\ \ "merchant_id": "stringstrings"\ \ }\ \ }
\

schema/customized_address_portable_1 Portable Postal Address (Medium-Grained)\

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, 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 | string<= 300 characters
The second line of the address, for example, a suite or apartment number. |
| admin_area_2 | string<= 120 characters
A city, town, or village. Smaller than admin_area_level_1. |
| 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. 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 | 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 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. |

Copy

{"address_line_1": "string",\ \ "address_line_2": "string",\ \ "admin_area_2": "string",\ \ "admin_area_1": "string",\ \ "postal_code": "string",\ \ "country_code": "st"\ \ }
\

schema/customized_address_portable_2 Portable Postal Address (Medium-Grained)\

schema/customized_address_portable_3 Portable Postal Address (Medium-Grained)\

schema/customized_address_portable_4 Portable Postal Address (Medium-Grained)\

schema/customized_address_portable_5 Portable Postal Address (Medium-Grained)\

schema/customized_address_portable_6 Portable Postal Address (Medium-Grained)\

schema/customized_address_portable_7 Portable Postal Address (Medium-Grained)\

schema/customized_address_portable_8 Portable Postal Address (Medium-Grained)\

schema/customized_address_portable_9 Portable Postal Address (Medium-Grained)\

schema/customized_address_portable_10 Portable Postal Address (Medium-Grained)\

schema/pricing_scheme pricing_scheme\

The pricing scheme details.

| pricing_model
required | string[ 1 .. 24 ] characters^[A-Z_]+$

The pricing model for the billing cycle.

| Enum Value | Description |
| --- | --- |
| FIXED | A fixed pricing scheme where the customer is charged a fixed amount. |
| VARIABLE | A variable pricing scheme where the customer is charged a variable amount. |
| AUTO_RELOAD | A auto-reload pricing scheme where the customer is charged a fixed amount for reload. | |
| price | object (Money)
The price the customer will be charged based on the pricing model |
| reload_threshold_amount | object (Money)
The threshold amount on which the reload charge would be triggered. This will be associated with the account-balance where if the account-balance goes below this amount then customer would incur reload charge. |

Copy

Expand allCollapse all

{"pricing_model": "FIXED",\ \ "price": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "reload_threshold_amount": {"currency_code": "str",\ \ "value": "string"\ \ }\ \ }
\

schema/customized_processor_response_1 processor_response\

The processor response information for payment requests, such as direct credit card transactions.

| avs_code | string

The address verification code for Visa, Discover, Mastercard, or American Express transactions.

| Enum Value | Description |
| --- | --- |
| 0 | For Maestro, all address information matches. |
| 1 | For Maestro, none of the address information matches. |
| 2 | For Maestro, part of the address information matches. |
| 3 | For Maestro, the merchant did not provide AVS information. It was not processed. |
| 4 | For Maestro, the address was not checked or the acquirer had no response. The service is not available. |
| A | For Visa, Mastercard, or Discover transactions, the address matches but the zip code does not match. For American Express transactions, the card holder address is correct. |
| B | For Visa, Mastercard, or Discover transactions, the address matches. International A. |
| C | For Visa, Mastercard, or Discover transactions, no values match. International N. |
| D | For Visa, Mastercard, or Discover transactions, the address and postal code match. International X. |
| E | For Visa, Mastercard, or Discover transactions, not allowed for Internet or phone transactions. For American Express card holder, the name is incorrect but the address and postal code match. |
| F | For Visa, Mastercard, or Discover transactions, the address and postal code match. UK-specific X. For American Express card holder, the name is incorrect but the address matches. |
| G | For Visa, Mastercard, or Discover transactions, global is unavailable. Nothing matches. |
| I | For Visa, Mastercard, or Discover transactions, international is unavailable. Not applicable. |
| M | For Visa, Mastercard, or Discover transactions, the address and postal code match. For American Express card holder, the name, address, and postal code match. |
| N | For Visa, Mastercard, or Discover transactions, nothing matches. For American Express card holder, the address and postal code are both incorrect. |
| P | For Visa, Mastercard, or Discover transactions, postal international Z. Postal code only. |
| R | For Visa, Mastercard, or Discover transactions, re-try the request. For American Express, the system is unavailable. |
| S | For Visa, Mastercard, Discover, or American Express, the service is not supported. |
| U | For Visa, Mastercard, or Discover transactions, the service is unavailable. For American Express, information is not available. For Maestro, the address is not checked or the acquirer had no response. The service is not available. |
| W | For Visa, Mastercard, or Discover transactions, whole ZIP code. For American Express, the card holder name, address, and postal code are all incorrect. |
| X | For Visa, Mastercard, or Discover transactions, exact match of the address and the nine-digit ZIP code. For American Express, the card holder name, address, and postal code are all incorrect. |
| Y | For Visa, Mastercard, or Discover transactions, the address and five-digit ZIP code match. For American Express, the card holder address and postal code are both correct. |
| Z | For Visa, Mastercard, or Discover transactions, the five-digit ZIP code matches but no address. For American Express, only the card holder postal code is correct. |
| Null | For Maestro, no AVS response was obtained. | |
| cvv_code | string

The card verification value code for for Visa, Discover, Mastercard, or American Express.

| Enum Value | Description |
| --- | --- |
| 0 | For Maestro, the CVV2 matched. |
| 1 | For Maestro, the CVV2 did not match. |
| 2 | For Maestro, the merchant has not implemented CVV2 code handling. |
| 3 | For Maestro, the merchant has indicated that CVV2 is not present on card. |
| 4 | For Maestro, the service is not available. |
| E | For Visa, Mastercard, Discover, or American Express, error - unrecognized or unknown response. |
| I | For Visa, Mastercard, Discover, or American Express, invalid or null. |
| M | For Visa, Mastercard, Discover, or American Express, the CVV2/CSC matches. |
| N | For Visa, Mastercard, Discover, or American Express, the CVV2/CSC does not match. |
| P | For Visa, Mastercard, Discover, or American Express, it was not processed. |
| S | For Visa, Mastercard, Discover, or American Express, the service is not supported. |
| U | For Visa, Mastercard, Discover, or American Express, unknown - the issuer is not certified. |
| X | For Visa, Mastercard, Discover, or American Express, no response. For Maestro, the service is not available. |
| All others | For Visa, Mastercard, Discover, or American Express, error. | |

Copy

{"avs_code": "A",\ \ "cvv_code": "E"\ \ }
\

schema/plan recurring_billing_plan_metadata\

The merchant level Recurring Billing plan metadata for the Billing Agreement.

| | |
| --- | --- |
| billing_cycles
required | Array of objects (billing_cycle) [ 1 .. 3 ] items
An array of billing cycles for trial billing and regular billing. A plan can have at most two trial cycles and only one regular cycle. |
| name | string[ 1 .. 127 ] characters^[A-Za-z0-9() +',.:-]+$
Name of the recurring plan. |
| one_time_charges
required | object (one_time_charges)
Price and currency for any one-time charges due at plan signup. |

Copy

Expand allCollapse all

{"billing_cycles": [{"tenure_type": "REGULAR",\ \ "total_cycles": 1,\ \ "sequence": 1,\ \ "pricing_scheme": {"pricing_model": "FIXED",\ \ "price": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "reload_threshold_amount": {"currency_code": "str",\ \ "value": "string"\ \ }\ \ },\ \ "start_date": "string"\ \ }\ \ ],\ \ "name": "string",\ \ "one_time_charges": {"setup_fee": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "shipping_amount": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "taxes": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "product_price": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "subtotal": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "total_amount": {"currency_code": "str",\ \ "value": "string"\ \ }\ \ }\ \ }
\

schema/customized_sepa_debit_details_1 sepa_debit_details\

object (sepa_debit_details)

Copy

{ }
\

schema/sepa_debit_experience_context sepa_debit_experience_context\

Customizes the payer experience during the approval process for the SEPA Debit payment.

| | |
| --- | --- |
| locale | string<ppaas_common_language_v3> (language) [ 2 .. 10 ] characters^[a-z]{2}(?:-[A-Z][a-z]{3})?(?😦?:[A-Z]{2}|...Show pattern
The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW. |
| return_url
required | string<uri> (url)
The URL where the customer is redirected after the customer approves the payment. |
| cancel_url
required | string<uri> (url)
The URL where the customer is redirected after the customer cancels the payment. |

Copy

{"locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }
\

[schema/setup_token_request setup_token_request\

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

| | |
| --- | --- |
| payment_source
required | object
The payment method to vault with the instrument details. |
| customer | object (customer)
Customer in merchant's or partner's system of records. |

Copy

Expand allCollapse all

{"payment_source": {"card": {"name": "string",\ \ "number": "stringstrings",\ \ "security_code": "stri",\ \ "expiry": "string",\ \ "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",\ \ "return_url": "http://example.com",\ \ "cancel_url": "http://example.com",\ \ "locale": "string",\ \ "vault_instruction": "ON_CREATE_PAYMENT_TOKENS"\ \ },\ \ "verification_method": "SCA_WHEN_REQUIRED"\ \ },\ \ "paypal": {"description": "string",\ \ "usage_pattern": "IMMEDIATE",\ \ "permit_multiple_payment_tokens": false,\ \ "usage_type": "MERCHANT",\ \ "customer_type": "CONSUMER",\ \ "shipping": {"type": "SHIPPING",\ \ "name": {"full_name": "string"\ \ },\ \ "phone_number": {"country_code": "str",\ \ "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"\ \ }\ \ },\ \ "billing_plan": {"billing_cycles": [{"tenure_type": "REGULAR",\ \ "total_cycles": 1,\ \ "sequence": 1,\ \ "pricing_scheme": {"pricing_model": "FIXED",\ \ "price": {"currency_code": null,\ \ "value": null\ \ },\ \ "reload_threshold_amount": {"currency_code": null,\ \ "value": null\ \ }\ \ },\ \ "start_date": "string"\ \ }\ \ ],\ \ "name": "string",\ \ "one_time_charges": {"setup_fee": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "shipping_amount": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "taxes": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "product_price": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "subtotal": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "total_amount": {"currency_code": "str",\ \ "value": "string"\ \ }\ \ }\ \ },\ \ "experience_context": {"brand_name": "string",\ \ "return_url": "http://example.com",\ \ "cancel_url": "http://example.com",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "vault_instruction": "ON_CREATE_PAYMENT_TOKENS"\ \ }\ \ },\ \ "venmo": {"description": "string",\ \ "usage_pattern": "IMMEDIATE",\ \ "permit_multiple_payment_tokens": false,\ \ "usage_type": "MERCHANT",\ \ "customer_type": "CONSUMER",\ \ "shipping": {"type": "SHIPPING",\ \ "name": {"full_name": "string"\ \ },\ \ "phone_number": {"country_code": "str",\ \ "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"\ \ }\ \ },\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "vault_instruction": "ON_CREATE_PAYMENT_TOKENS"\ \ }\ \ },\ \ "token": {"id": "string",\ \ "type": "SETUP_TOKEN"\ \ }\ \ },\ \ "customer": {"merchant_customer_id": "string",\ \ "id": "string"\ \ }\ \ }
\

schema/setup_token_response setup_token_response\

Minimal representation of a cached setup token.

| payment_source | object
The setup payment method details. |
| links | 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. |
| customer | 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.

| Enum Value | Description |
| --- | --- |
| CREATED | A setup token is initialized with minimal information, more data must be added to the setup-token to be vaulted |
| PAYER_ACTION_REQUIRED | A contingecy on payer approval is required before the payment method can be saved. |
| APPROVED | Setup token is ready to be vaulted. If a buyer approval contigency was returned, it is has been approved. |
| VAULTED | The payment token has been vaulted. |
| TOKENIZED | A vaulted payment method token has been tokenized for short term (one time) use. | |

Copy

Expand allCollapse all

{"payment_source": {"card": {"name": "string",\ \ "last_digits": "stri",\ \ "verification": {"network_transaction_id": "string",\ \ "date": "stri",\ \ "network": "VISA",\ \ "time": "string",\ \ "amount": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "processor_response": {"avs_code": "A",\ \ "cvv_code": "E"\ \ },\ \ "three_d_secure": null\ \ },\ \ "network_transaction_reference": {"id": "stringstr",\ \ "date": "stri",\ \ "network": "VISA",\ \ "time": "stringstringstringst"\ \ },\ \ "authentication_result": {"three_d_secure": {"authentication_status": "Y",\ \ "enrollment_status": "Y",\ \ "authentication_id": "string"\ \ }\ \ },\ \ "brand": "VISA",\ \ "expiry": "strings",\ \ "billing_address": {"address_line_1": "string",\ \ "address_line_2": "string",\ \ "admin_area_2": "string",\ \ "admin_area_1": "string",\ \ "postal_code": "string",\ \ "country_code": "st",\ \ "id": "string"\ \ },\ \ "verification_status": "VERIFIED",\ \ "bin_details": {"bin": "string",\ \ "issuing_bank": "string",\ \ "products": ["string"\ \ ],\ \ "bin_country_code": "string"\ \ },\ \ "type": "CREDIT"\ \ },\ \ "paypal": {"description": "string",\ \ "usage_pattern": "IMMEDIATE",\ \ "permit_multiple_payment_tokens": false,\ \ "usage_type": "MERCHANT",\ \ "customer_type": "CONSUMER",\ \ "shipping": {"type": "SHIPPING",\ \ "name": {"full_name": "string"\ \ },\ \ "phone_number": {"country_code": "str",\ \ "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"\ \ }\ \ },\ \ "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"\ \ },\ \ "account_id": "stringstrings",\ \ "phone_number": {"country_code": "str",\ \ "national_number": "string",\ \ "extension_number": "string"\ \ }\ \ },\ \ "venmo": {"description": "string",\ \ "usage_pattern": "IMMEDIATE",\ \ "permit_multiple_payment_tokens": false,\ \ "usage_type": "MERCHANT",\ \ "customer_type": "CONSUMER",\ \ "shipping": {"type": "SHIPPING",\ \ "name": {"full_name": "string"\ \ },\ \ "phone_number": {"country_code": "str",\ \ "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"\ \ }\ \ },\ \ "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",\ \ "customer": {"merchant_customer_id": "string",\ \ "id": "string"\ \ },\ \ "status": "CREATED"\ \ }
\

schema/customized_setup_token_response_1 setup_token_response\

schema/customized_shipping_detail_1 shipping_detail\

The shipping details.

| type | string (Fullfillment Type) [ 1 .. 255 ] characters^[0-9A-Z_]+$

A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either type or options may be present, but not both.

| Enum Value | Description |
| --- | --- |
| SHIPPING | The payer intends to receive the items at a specified address. |
| PICKUP_IN_PERSON | DEPRECATED. Please use "PICKUP_FROM_PERSON" instead. |
| PICKUP_IN_STORE | The payer intends to pick up the item(s) from the payee's physical store. Also termed as BOPIS, "Buy Online, Pick-up in Store". Seller protection is provided with this option. |
| PICKUP_FROM_PERSON | The payer intends to pick up the item(s) from the payee in person. Also termed as BOPIP, "Buy Online, Pick-up in Person". Seller protection is not available, since the payer is receiving the item from the payee in person, and can validate the item prior to payment. | |
| name | object (Name)
The name of the person to whom to ship the items. Supports only the full_name property. |
| phone_number | object (Phone)
The phone number of the recipient of the shipped items, which may belong to either the payer, or an alternate contact, for delivery. \Format - canonical international [E.164 numbering plan] |
| address | object (Portable Postal Address (Medium-Grained))
The address of the person to whom to ship the items. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties. |

Copy

Expand allCollapse all

{"type": "SHIPPING",\ \ "name": {"full_name": "string"\ \ },\ \ "phone_number": {"country_code": "str",\ \ "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"\ \ }\ \ }
\

schema/shipping_option shipping_option\

The options that the payee or merchant offers to the payer to ship or pick up their items.

| id
required | string<= 127 characters
A unique ID that identifies a payer-selected shipping option. |
| label
required | string<= 127 characters
A description that the payer sees, which helps them choose an appropriate shipping option. For example, Free Shipping, USPS Priority Shipping, Expédition prioritaire USPS, or USPS yōuxiān fā huò. Localize this description to the payer's locale. |
| selected
required | boolean
If the API request sets selected = true, it represents the shipping option that the payee or merchant expects to be pre-selected for the payer when they first view the shipping.options in the PayPal Checkout experience. As part of the response if a shipping.option contains selected=true, it represents the shipping option that the payer selected during the course of checkout with PayPal. Only one shipping.option can be set to selected=true. |
| type | string (shipping_type)

A classification for the method of purchase fulfillment.

| Enum Value | Description |
| --- | --- |
| SHIPPING | The payer intends to receive the items at a specified address. |
| PICKUP | DEPRECATED. To ensure that seller protection is correctly assigned, please use 'PICKUP_IN_STORE' or 'PICKUP_FROM_PERSON' instead. Currently, this field indicates that the payer intends to pick up the items at a specified address (ie. a store address). |
| PICKUP_IN_STORE | The payer intends to pick up the item(s) from the payee's physical store. Also termed as BOPIS, "Buy Online, Pick-up in Store". Seller protection is provided with this option. |
| PICKUP_FROM_PERSON | The payer intends to pick up the item(s) from the payee in person. Also termed as BOPIP, "Buy Online, Pick-up in Person". Seller protection is not available, since the payer is receiving the item from the payee in person, and can validate the item prior to payment. | |
| amount | object (Money)
The shipping cost for the selected option. |

Copy

Expand allCollapse all

{"id": "string",\ \ "label": "string",\ \ "selected": true,\ \ "type": "SHIPPING",\ \ "amount": {"currency_code": "str",\ \ "value": "string"\ \ }\ \ }
\

schema/shipping_type shipping_type\

A classification for the method of purchase fulfillment.

string (shipping_type)

A classification for the method of purchase fulfillment.

| Enum Value | Description |
| --- | --- |
| SHIPPING | The payer intends to receive the items at a specified address. |
| PICKUP | DEPRECATED. To ensure that seller protection is correctly assigned, please use 'PICKUP_IN_STORE' or 'PICKUP_FROM_PERSON' instead. Currently, this field indicates that the payer intends to pick up the items at a specified address (ie. a store address). |
| PICKUP_IN_STORE | The payer intends to pick up the item(s) from the payee's physical store. Also termed as BOPIS, "Buy Online, Pick-up in Store". Seller protection is provided with this option. |
| PICKUP_FROM_PERSON | The payer intends to pick up the item(s) from the payee in person. Also termed as BOPIP, "Buy Online, Pick-up in Person". Seller protection is not available, since the payer is receiving the item from the payee in person, and can validate the item prior to payment. |

Copy

"SHIPPING"
\

schema/store_in_vault_instruction store_in_vault_instruction\

Defines how and when the payment source gets vaulted.

string (store_in_vault_instruction) [ 1 .. 255 ] characters^[0-9A-Z_]+$

Defines how and when the payment source gets vaulted.

| Value | Description |
| --- | --- |
| ON_SUCCESS | Defines that the payment_source will be vaulted only when at least one authorization or capture using that payment_source is successful. |

Copy

"ON_SUCCESS"
\

schema/tax_info tax_info\

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.

| Enum Value | Description |
| --- | --- |
| BR_CPF | The individual tax ID type, typically is 11 characters long. |
| BR_CNPJ | The business tax ID type, typically is 14 characters long. | |

Copy

{"tax_id": "string",\ \ "tax_id_type": "BR_CPF"\ \ }
\

schema/authorization_state The authorization state\

The authorization state of the wallet instrument during transaction.

string (The authorization state) [ 1 .. 100 ] characters^[0-9A-Z_]+$

The authorization state of the wallet instrument during transaction.

| Enum Value | Description |
| --- | --- |
| NOT_STARTED | The authorization state is not started. |
| PENDING | The authorization state is pending. |
| CREATED | The authorization state is created. |
| CANCELLED | The authorization state is cancelled. |
| REVOKED | The authorization state is revoked. |
| REFUSED | The authorization state is refused. |
| CANCELLATION_REQUESTED | The authorization state is in process on cancellation. |
| CANCELLATION_REFUSED | The authorization state is refused to cancel. |
| LODGED | The authorization state is lodged. |

Copy

"NOT_STARTED"
\

schema/authorization_status The authorization status\

The authorization status of the wallet instrument.

string (The authorization status) [ 1 .. 100 ] characters^[0-9A-Z_]+$

The authorization status of the wallet instrument.

| Enum Value | Description |
| --- | --- |
| AUTHORIZED | The authorization status is authorized. |
| BLOCKED | The authorization status is blocked. |
| FAILED | The authorization status is failed. |
| NOT_APPLICABLE | Authorization not applicable. |
| NOT_SUPPORTED | Authorization not supported. |
| UNAUTHORIZED | The authorization status is unauthorized. |

Copy

"AUTHORIZED"
\

schema/three_d_secure_authentication_response three_d_secure_authentication_response\

Results of 3D Secure Authentication.

| authentication_status | string (pares_status) [ 1 .. 255 ] characters^[0-9A-Z_]+$

The outcome of the issuer's authentication.

| Enum Value | Description |
| --- | --- |
| Y | Successful authentication. |
| N | Failed authentication / account not verified / transaction denied. |
| U | Unable to complete authentication. |
| A | Successful attempts transaction. |
| C | Challenge required for authentication. |
| R | Authentication rejected (merchant must not submit for authorization). |
| D | Challenge required; decoupled authentication confirmed. |
| I | Informational only; 3DS requestor challenge preference acknowledged. | |
| enrollment_status | string (enrolled) [ 1 .. 255 ] characters^[0-9A-Z_]+$

Status of authentication eligibility.

| Enum Value | Description |
| --- | --- |
| Y | Yes. The bank is participating in 3-D Secure protocol and will return the ACSUrl. |
| N | No. The bank is not participating in 3-D Secure protocol. |
| U | Unavailable. The DS or ACS is not available for authentication at the time of the request. |
| B | Bypass. The merchant authentication rule is triggered to bypass authentication. | |
| authentication_id | string[ 1 .. 255 ] characters^[0-9a-zA-Z_-]+$
The externally received 3ds authentication id, to be returned in card detokenization response. |

Copy

{"authentication_status": "Y",\ \ "enrollment_status": "Y",\ \ "authentication_id": "string"\ \ }
\

schema/three_d_secure_authentication_response_v1 three_d_secure_authentication_response\

Results of 3D Secure Authentication.

| authentication_status | string (pares_status) [ 1 .. 255 ] characters^[0-9A-Z_]+$

The outcome of the issuer's authentication.

| Enum Value | Description |
| --- | --- |
| Y | Successful authentication. |
| N | Failed authentication / account not verified / transaction denied. |
| U | Unable to complete authentication. |
| A | Successful attempts transaction. |
| C | Challenge required for authentication. |
| R | Authentication rejected (merchant must not submit for authorization). |
| D | Challenge required; decoupled authentication confirmed. |
| I | Informational only; 3DS requestor challenge preference acknowledged. | |
| enrollment_status | string (enrolled) [ 1 .. 255 ] characters^[0-9A-Z_]+$

Status of authentication eligibility.

| Enum Value | Description |
| --- | --- |
| Y | Yes. The bank is participating in 3-D Secure protocol and will return the ACSUrl. |
| N | No. The bank is not participating in 3-D Secure protocol. |
| U | Unavailable. The DS or ACS is not available for authentication at the time of the request. |
| B | Bypass. The merchant authentication rule is triggered to bypass authentication. | |

Copy

{"authentication_status": "Y",\ \ "enrollment_status": "Y"\ \ }
\

schema/token_id_request token_id_request\

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

| id
required | string[ 1 .. 255 ] characters^[0-9A-Za-z_-]+$
The PayPal-generated ID for the token. |
| type
required | string[ 1 .. 255 ] characters^[0-9A-Z_-]+$

The tokenization method that generated the ID.

| Value | Description |
| --- | --- |
| SETUP_TOKEN | The setup token, which is a temporary reference to payment source. | |

Copy

{"id": "string",\ \ "type": "SETUP_TOKEN"\ \ }
\

schema/payment_token_request token_request\

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

| | |
| --- | --- |
| payment_source
required | object (Payment source request)
The payment method to vault with the instrument details. |
| customer | object (customer)
Customer in merchant's or partner's system of records. |

Copy

Expand allCollapse all

{"payment_source": {"card": {"name": "string",\ \ "number": "stringstrings",\ \ "security_code": "stri",\ \ "expiry": "string",\ \ "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": "SETUP_TOKEN"\ \ }\ \ },\ \ "customer": {"merchant_customer_id": "string",\ \ "id": "string"\ \ }\ \ }
\

schema/universal_product_code universal_product_code\

The Universal Product Code of the item.

| type
required | string (Universal Product Code Type) [ 1 .. 5 ] characters^[0-9A-Z_-]+$

The Universal Product Code type.

| Enum Value | Description |
| --- | --- |
| UPC-A | N/A |
| UPC-B | N/A |
| UPC-C | N/A |
| UPC-D | N/A |
| UPC-E | N/A |
| UPC-2 | N/A |
| UPC-5 | N/A | |
| code
required | string[ 6 .. 17 ] characters^[0-9]{0,17}$
The UPC product code of the item. |

Copy

{"type": "UPC-A",\ \ "code": "string"\ \ }
\

schema/url url\

Describes the URL.

string<uri> (url)

Describes the URL.

Copy

"http://example.com"
\

schema/vault_instruction Vault Instruction\

Vault Instruction on action to be performed after a successful payer approval.

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.

| Enum Value | Description |
| --- | --- |
| ON_CREATE_PAYMENT_TOKENS | Vault the payment method after API caller performs a successful POST on Payment Tokens. |
| ON_PAYER_APPROVAL | Vault the payment method on successful payer authentication and approval. |

Copy

"ON_CREATE_PAYMENT_TOKENS"
\

schema/customer_vault_payment_tokens_response vault 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. |
| payment_tokens | Array of objects (payment_token_response) [ 0 .. 64 ] items |
| links | Array of objects (Link Description) [ 1 .. 32 ] items
An array of related HATEOAS links. |
| customer | object (customer)
This object defines a customer in your system. Use it to manage customer profiles, save payment methods and contact details. |

Copy

Expand allCollapse all

{"total_items": 1,\ \ "total_pages": 1,\ \ "payment_tokens": [{"payment_source": {"card": {"name": "string",\ \ "last_digits": "stri",\ \ "verification": {"network_transaction_id": "string",\ \ "date": "stri",\ \ "network": "VISA",\ \ "time": "string",\ \ "amount": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "processor_response": {"avs_code": "A",\ \ "cvv_code": "E"\ \ },\ \ "three_d_secure": null\ \ },\ \ "network_transaction_reference": {"id": "stringstr",\ \ "date": "stri",\ \ "network": "VISA",\ \ "time": "stringstringstringst"\ \ },\ \ "authentication_result": {"three_d_secure": {"authentication_status": "Y",\ \ "enrollment_status": "Y",\ \ "authentication_id": "string"\ \ }\ \ },\ \ "brand": "VISA",\ \ "expiry": "strings",\ \ "billing_address": {"address_line_1": "string",\ \ "address_line_2": "string",\ \ "admin_area_2": "string",\ \ "admin_area_1": "string",\ \ "postal_code": "string",\ \ "country_code": "st",\ \ "id": "string"\ \ },\ \ "verification_status": "VERIFIED",\ \ "bin_details": {"bin": "string",\ \ "issuing_bank": "string",\ \ "products": ["string"\ \ ],\ \ "bin_country_code": "string"\ \ },\ \ "type": "CREDIT"\ \ },\ \ "paypal": {"description": "string",\ \ "usage_pattern": "IMMEDIATE",\ \ "permit_multiple_payment_tokens": false,\ \ "usage_type": "MERCHANT",\ \ "customer_type": "CONSUMER",\ \ "shipping": {"type": "SHIPPING",\ \ "name": {"full_name": "string"\ \ },\ \ "phone_number": {"country_code": "str",\ \ "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"\ \ }\ \ },\ \ "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"\ \ },\ \ "account_id": "stringstrings",\ \ "phone_number": {"country_code": "str",\ \ "national_number": "string",\ \ "extension_number": "string"\ \ }\ \ },\ \ "venmo": {"description": "string",\ \ "usage_pattern": "IMMEDIATE",\ \ "permit_multiple_payment_tokens": false,\ \ "usage_type": "MERCHANT",\ \ "customer_type": "CONSUMER",\ \ "shipping": {"type": "SHIPPING",\ \ "name": {"full_name": "string"\ \ },\ \ "phone_number": {"country_code": "str",\ \ "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"\ \ }\ \ },\ \ "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"\ \ }\ \ }\ \ }\ \ },\ \ "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"\ \ }\ \ }
\

schema/vault_instruction_base vault_instruction_base\

Basic vault instruction specification that can be extended by specific payment sources that supports vaulting.

| store_in_vault | string (store_in_vault_instruction) [ 1 .. 255 ] characters^[0-9A-Z_]+$

Defines how and when the payment source gets vaulted.

| Value | Description |
| --- | --- |
| ON_SUCCESS | Defines that the payment_source will be vaulted only when at least one authorization or capture using that payment_source is successful. | |

Copy

{"store_in_vault": "ON_SUCCESS"\ \ }
\

schema/vault_sepa_debit_response vault_sepa_debit_response\

An API resource used in the response of securely storing a SEPA Debit.

| | |
| --- | --- |
| iban_last_chars | string (iban_last_chars) [ 4 .. 34 ] characters[a-zA-Z0-9]{4}
The last 4 characters of the SEPA IBAN number. |
| billing_address | object (Portable Postal Address (Medium-Grained))
The billing address for this SEPA bank account. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties. |

Copy

Expand allCollapse all

{"iban_last_chars": "string",\ \ "billing_address": {"address_line_1": "string",\ \ "address_line_2": "string",\ \ "admin_area_2": "string",\ \ "admin_area_1": "string",\ \ "postal_code": "string",\ \ "country_code": "st"\ \ }\ \ }
\

schema/venmo_request venmo_request\

A resource representing a request to vault Venmo.

| description | string[ 1 .. 128 ] characters^.*$
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. |
| usage_pattern | string[ 1 .. 30 ] characters^[0-9A-Z_]+$

Expected business/charge model for the billing agreement.

| Enum Value | Description |
| --- | --- |
| IMMEDIATE | On-demand instant payments - non-recurring, pre-paid, variable amount, variable frequency. |
| DEFERRED | Pay after use, non-recurring post-paid, variable amount, irregular frequency. |
| RECURRING_PREPAID | Pay upfront fixed or variable amount on a fixed date before the goods/service is delivered. |
| RECURRING_POSTPAID | Pay on a fixed date based on usage or consumption after the goods/service is delivered. |
| THRESHOLD_PREPAID | Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, before the goods/service is delivered. |
| THRESHOLD_POSTPAID | Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, after the goods/service is delivered. |
| UNSCHEDULED_POSTPAID | Merchant-managed installment plan when the amount to be paid and the billing frequency are fixed, but there is a defined number of payments with the payment due after the goods/services are delivered. |
| UNSCHEDULED_PREPAID | Unscheduled card on file plan where the merchant can bill buyer upfront based on an agreed logic, but amount due and frequency can vary. Inclusive of automatic reload plans. |
| SUBSCRIPTION_PREPAID | Subscription plan where the amount due and the billing frequency are fixed, and there is no defined duration with the payment due before the good/service is delivered. |
| SUBSCRIPTION_POSTPAID | Subscription plan where the amount due and the billing frequency are fixed, and there is no defined duration with the payment due after the goods/services are delivered. |
| INSTALLMENT_POSTPAID | Merchant-managed installment plan when the amount to be paid and the billing frequency are fixed, but there is a defined number of payments with the payment due after the goods/services are delivered. |
| INSTALLMENT_PREPAID | Merchant-managed installment plan when the amount to be paid and the billing frequency are fixed, but there is a defined number of payments with the payment due before the good/service is delivered. | |
| 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.

| Enum Value | Description |
| --- | --- |
| MERCHANT | The PayPal Payment Token will be used for future transaction directly with a merchant. |
| PLATFORM | The PayPal Payment Token will be used for future transaction on a platform. A platform is typically a marketplace or a channel that a payer can purchase goods and services from multiple merchants. | |
| 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.

| Enum Value | Description |
| --- | --- |
| CONSUMER | The customer vaulting the PayPal payment token is a consumer on the merchant / platform. |
| BUSINESS | The customer vaulting the PayPal payment token is a business on merchant / platform. | |
| shipping | object (shipping_detail)
The shipping address for the Payer. |
| experience_context | object (experience_context)
Customizes the Vault creation flow experience for your customers. |

Copy

Expand allCollapse all

{"description": "string",\ \ "usage_pattern": "IMMEDIATE",\ \ "permit_multiple_payment_tokens": false,\ \ "usage_type": "MERCHANT",\ \ "customer_type": "CONSUMER",\ \ "shipping": {"type": "SHIPPING",\ \ "name": {"full_name": "string"\ \ },\ \ "phone_number": {"country_code": "str",\ \ "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"\ \ }\ \ },\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "vault_instruction": "ON_CREATE_PAYMENT_TOKENS"\ \ }\ \ }
\

schema/venmo_response venmo_response\

Full representation of a Venmo Payment Token.

| description | string[ 1 .. 128 ] characters^.*$
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. |
| usage_pattern | string[ 1 .. 30 ] characters^[0-9A-Z_]+$

Expected business/charge model for the billing agreement.

| Enum Value | Description |
| --- | --- |
| IMMEDIATE | On-demand instant payments - non-recurring, pre-paid, variable amount, variable frequency. |
| DEFERRED | Pay after use, non-recurring post-paid, variable amount, irregular frequency. |
| RECURRING_PREPAID | Pay upfront fixed or variable amount on a fixed date before the goods/service is delivered. |
| RECURRING_POSTPAID | Pay on a fixed date based on usage or consumption after the goods/service is delivered. |
| THRESHOLD_PREPAID | Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, before the goods/service is delivered. |
| THRESHOLD_POSTPAID | Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, after the goods/service is delivered. |
| UNSCHEDULED_POSTPAID | Merchant-managed installment plan when the amount to be paid and the billing frequency are fixed, but there is a defined number of payments with the payment due after the goods/services are delivered. |
| UNSCHEDULED_PREPAID | Unscheduled card on file plan where the merchant can bill buyer upfront based on an agreed logic, but amount due and frequency can vary. Inclusive of automatic reload plans. |
| SUBSCRIPTION_PREPAID | Subscription plan where the amount due and the billing frequency are fixed, and there is no defined duration with the payment due before the good/service is delivered. |
| SUBSCRIPTION_POSTPAID | Subscription plan where the amount due and the billing frequency are fixed, and there is no defined duration with the payment due after the goods/services are delivered. |
| INSTALLMENT_POSTPAID | Merchant-managed installment plan when the amount to be paid and the billing frequency are fixed, but there is a defined number of payments with the payment due after the goods/services are delivered. |
| INSTALLMENT_PREPAID | Merchant-managed installment plan when the amount to be paid and the billing frequency are fixed, but there is a defined number of payments with the payment due before the good/service is delivered. | |
| 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.

| Enum Value | Description |
| --- | --- |
| MERCHANT | The PayPal Payment Token will be used for future transaction directly with a merchant. |
| PLATFORM | The PayPal Payment Token will be used for future transaction on a platform. A platform is typically a marketplace or a channel that a payer can purchase goods and services from multiple merchants. | |
| 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.

| Enum Value | Description |
| --- | --- |
| CONSUMER | The customer vaulting the PayPal payment token is a consumer on the merchant / platform. |
| BUSINESS | The customer vaulting the PayPal payment token is a business on merchant / platform. | |
| shipping | object (shipping_detail)
The shipping address for the Payer. |
| email_address | string<merchant_common_email_address_v2> (email) [ 3 .. 254 ] characters(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-...Show pattern
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. |
| name | object (Name)
The name of the payer. Supports only the given_name and surname properties. |
| phone | 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 phone.phone_number supports only national_number. |
| address | object (Portable Postal Address (Medium-Grained))
The address of the payer. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties. Also referred to as the billing address of the customer. |
| user_name | string[ 1 .. 50 ] characters^[-a-zA-Z0-9_]*$
The Venmo username, as chosen by the user. |

Copy

Expand allCollapse all

{"description": "string",\ \ "usage_pattern": "IMMEDIATE",\ \ "permit_multiple_payment_tokens": false,\ \ "usage_type": "MERCHANT",\ \ "customer_type": "CONSUMER",\ \ "shipping": {"type": "SHIPPING",\ \ "name": {"full_name": "string"\ \ },\ \ "phone_number": {"country_code": "str",\ \ "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"\ \ }\ \ },\ \ "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"\ \ }
\

Payment Method Tokens(3) ​

operation/payment-tokens.create Create payment token for a given payment source ​

header Parameters ​

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json required ​

operation/customer.payment-tokens.get List all payment tokens ​

query Parameters ​

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json ​

operation/payment-tokens.get Retrieve a payment token ​

path Parameters ​

operation/payment-tokens.delete Delete payment token ​

path Parameters ​

operation/setup-tokens.create Create a setup token ​

header Parameters ​

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json required ​

operation/setup-tokens.get Retrieve a setup token ​

path Parameters ​

tag/Errors Errors ​

section/CARD_EXPIRATION_YEAR_IS_INVALID CARD_EXPIRATION_YEAR_IS_INVALID ​

section/CREDIT_CARD_NUMBER_IS_INVALID CREDIT_CARD_NUMBER_IS_INVALID ​

section/EXACTLY_ONE_FIELD_REQUIRED EXACTLY_ONE_FIELD_REQUIRED ​

section/INTERNAL_SERVER_ERROR INTERNAL_SERVER_ERROR ​

section/INVALID_EXPIRY_DATE INVALID_EXPIRY_DATE ​

section/INVALID_INTEGER_MIN_VALUE INVALID_INTEGER_MIN_VALUE ​

section/INVALID_PARAMETER_SYNTAX INVALID_PARAMETER_SYNTAX ​

section/INVALID_SECURITY_CODE INVALID_SECURITY_CODE ​

section/INVALID_STRING_LENGTH INVALID_STRING_LENGTH ​

section/INVALID_STRING_MAX_LENGTH INVALID_STRING_MAX_LENGTH ​

section/MALFORMED_REQUEST_JSON MALFORMED_REQUEST_JSON ​

section/MISSING_REQUIRED_PARAMETER MISSING_REQUIRED_PARAMETER ​

section/NOT_ENABLED_TO_VAULT_PAYMENT_SOURCE NOT_ENABLED_TO_VAULT_PAYMENT_SOURCE ​

section/OPERATION_NOT_SUPPORTED OPERATION_NOT_SUPPORTED ​

section/PAYER_ACTION_REQUIRED PAYER_ACTION_REQUIRED ​

section/PAYPAL_REQUEST_ID_PREVIOUSLY_USED PAYPAL_REQUEST_ID_PREVIOUSLY_USED ​

section/PERMISSION_DENIED PERMISSION_DENIED ​

section/RESOURCE_NOT_FOUND RESOURCE_NOT_FOUND ​

section/SETUP_TOKEN_ALREADY_TOKENIZED SETUP_TOKEN_ALREADY_TOKENIZED ​

section/SETUP_TOKEN_NOT_TOKENIZED SETUP_TOKEN_NOT_TOKENIZED ​

section/TOKEN_NOT_FOUND TOKEN_NOT_FOUND ​

tag/Definitions Definitions ​

schema/customized_3ds_result_1 3ds_result ​

schema/account_registration_type Account Registration Type ​

schema/activity_timestamps activity_timestamps ​

schema/customized_address_entity_1 Address request details. ​

schema/address_entity Address request details. ​

schema/amount_breakdown amount_breakdown ​

schema/customized_apple_pay_card_1 apple_pay_card ​

schema/apple_pay_payment_token_response apple_pay_payment_token_response ​

schema/customized_authentication_response_1 authentication_response ​

schema/customized_authorization_1 Authorization details ​

schema/authorization_id authorization_id ​

schema/customized_bank_authorization_details_1 bank_authorization_details ​

schema/billing_cycle billing_cycle ​

schema/bin_details bin_details ​

schema/customized_card_1 card ​

schema/customized_card_2 card ​

schema/card_verification Card Verification ​

schema/card_attributes card_attributes ​

schema/card_brand card_brand ​

schema/card_customer card_customer ​

schema/customized_card_request_1 card_request\ ​

schema/customized_card_request_2 card_request\ ​

schema/card_response card_response\ ​

schema/customized_card_response_1 card_response\ ​

schema/card_response_entity card_response_entity\ ​

schema/card_supplementary_data card_supplementary_data\ ​

schema/card_type card_type\ ​

schema/card_verification_details card_verification_details\ ​

schema/card_verification_method card_verification_method\ ​

schema/card_verification_status card_verification_status\ ​

schema/country_code country_code\ ​

schema/country_code_v3 country_code\ ​

schema/currency_code currency_code\ ​

schema/customer customer\ ​

schema/customer_v1 customer\ ​

[schema/customized_customer_1 customer\ ​

schema/customized_customer_2 customer\ ​

schema/customized_customer_3 customer\ ​

schema/customized_customer_4 customer\ ​

schema/date_no_time date_no_time\ ​

schema/date_time date_time\ ​

Payment Method Tokens(3)

operation/payment-tokens.create Create payment token for a given payment source

header Parameters

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json required

operation/customer.payment-tokens.get List all payment tokens

query Parameters

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

operation/payment-tokens.get Retrieve a payment token

path Parameters

operation/payment-tokens.delete Delete payment token

path Parameters

operation/setup-tokens.create Create a setup token

header Parameters

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json required

operation/setup-tokens.get Retrieve a setup token

path Parameters

tag/Errors Errors

section/CARD_EXPIRATION_YEAR_IS_INVALID CARD_EXPIRATION_YEAR_IS_INVALID

section/CREDIT_CARD_NUMBER_IS_INVALID CREDIT_CARD_NUMBER_IS_INVALID

section/EXACTLY_ONE_FIELD_REQUIRED EXACTLY_ONE_FIELD_REQUIRED

section/INTERNAL_SERVER_ERROR INTERNAL_SERVER_ERROR

section/INVALID_EXPIRY_DATE INVALID_EXPIRY_DATE

section/INVALID_INTEGER_MIN_VALUE INVALID_INTEGER_MIN_VALUE

section/INVALID_PARAMETER_SYNTAX INVALID_PARAMETER_SYNTAX

section/INVALID_SECURITY_CODE INVALID_SECURITY_CODE

section/INVALID_STRING_LENGTH INVALID_STRING_LENGTH

section/INVALID_STRING_MAX_LENGTH INVALID_STRING_MAX_LENGTH

section/MALFORMED_REQUEST_JSON MALFORMED_REQUEST_JSON

section/MISSING_REQUIRED_PARAMETER MISSING_REQUIRED_PARAMETER

section/NOT_ENABLED_TO_VAULT_PAYMENT_SOURCE NOT_ENABLED_TO_VAULT_PAYMENT_SOURCE

section/OPERATION_NOT_SUPPORTED OPERATION_NOT_SUPPORTED

section/PAYER_ACTION_REQUIRED PAYER_ACTION_REQUIRED

section/PAYPAL_REQUEST_ID_PREVIOUSLY_USED PAYPAL_REQUEST_ID_PREVIOUSLY_USED

section/PERMISSION_DENIED PERMISSION_DENIED

section/RESOURCE_NOT_FOUND RESOURCE_NOT_FOUND

section/SETUP_TOKEN_ALREADY_TOKENIZED SETUP_TOKEN_ALREADY_TOKENIZED

section/SETUP_TOKEN_NOT_TOKENIZED SETUP_TOKEN_NOT_TOKENIZED

section/TOKEN_NOT_FOUND TOKEN_NOT_FOUND

tag/Definitions Definitions

schema/customized_3ds_result_1 3ds_result

schema/account_registration_type Account Registration Type

schema/activity_timestamps activity_timestamps

schema/customized_address_entity_1 Address request details.

schema/address_entity Address request details.

schema/amount_breakdown amount_breakdown

schema/customized_apple_pay_card_1 apple_pay_card

schema/apple_pay_payment_token_response apple_pay_payment_token_response

schema/customized_authentication_response_1 authentication_response

schema/customized_authorization_1 Authorization details

schema/authorization_id authorization_id

schema/customized_bank_authorization_details_1 bank_authorization_details

schema/billing_cycle billing_cycle

schema/bin_details bin_details

schema/customized_card_1 card

schema/customized_card_2 card

schema/card_verification Card Verification

schema/card_attributes card_attributes

schema/card_brand card_brand

schema/card_customer card_customer

schema/customized_card_request_1 card_request\

schema/customized_card_request_2 card_request\

schema/card_response card_response\

schema/customized_card_response_1 card_response\

schema/card_response_entity card_response_entity\

schema/card_supplementary_data card_supplementary_data\

schema/card_type card_type\

schema/card_verification_details card_verification_details\

schema/card_verification_method card_verification_method\

schema/card_verification_status card_verification_status\

schema/country_code country_code\

schema/country_code_v3 country_code\

schema/currency_code currency_code\

schema/customer customer\

schema/customer_v1 customer\

[schema/customized_customer_1 customer\

schema/customized_customer_2 customer\

schema/customized_customer_3 customer\

schema/customized_customer_4 customer\

schema/date_no_time date_no_time\

schema/date_time date_time\