Tokens

Table of Contents

Request a token #

Exchange card details for a reference token that can be used later to request a card payment. Tokens are single use and expire after 15 minutes.

Authorizations

bearer

HTTP Authorization Scheme: bearer

Bearer format: JWT

Authorizationrequired

stringBearer token (API Public Key).

Request body for creating a card token.

type required	stringThe type of card details to be tokenized.
number required	stringThe card number.
expiry_month required	number [ 1 .. 12 ] The expiry month of the card.
expiry_year required	numberThe expiry year of the card (4 digits).
name	stringThe cardholder’s name.
cvv	stringThe card verification value/code. 3 digits, except for American Express (4 digits).
billing_address	objectThe payment source owner’s billing address.
phone	objectThe payment source owner’s phone number.

201 Reference token created successfully

expiry_month required	numberThe expiry month.
expiry_year required	numberThe expiry year.
last4 required	stringThe last four digits of the card number.
bin required	stringThe card issuer BIN.
type required	stringThe type of card details to be tokenized.
token required	stringThe reference token.
expires_onrequired	string <date-time> The date/time the token will expire.
scheme	stringThe card scheme.
scheme_local	stringThe local co-branded card scheme.
card_type	string Enum:”CREDIT””DEBIT””PREPAID””CHARGE””DEFERRED DEBIT”The card type.
card_category	string Enum:”CONSUMER””COMMERCIAL”The card category.
issuer	stringThe name of the card issuer.
issuer_country	string = 2 characters The card issuer country ISO-2 code.
product_id	stringThe issuer/card scheme product identifier.
product_type	stringThe issuer/card scheme product type.
billing_address	objectThe payment source owner’s billing address.
phone	objectThe payment source owner’s phone number.
name	stringThe cardholder’s name.

401 Unauthorized

422 Invalid data was sent.

request_id required	stringThe unique request identifier.
error_type required	stringThe error type.
error_codes required	Array of stringsThe error codes.

Updated on June 8, 2025