Card Tokens

Card Tokens represent a tokenized card number that can be used for Card Push Transfers and Card Validations.

The Card Token object

{
  "created_at": "2020-01-31T23:59:59Z",
  "expiration_date": "2020-01-31",
  "id": "outbound_card_token_zlt0ml6youq3q7vcdlg0",
  "last4": "1234",
  "length": 16,
  "prefix": "46637100",
  "type": "card_token"
}

Attributes

created_at

string

The ISO 8601 date and time at which the card token was created.

expiration_date

string

The ISO 8601 date when the card expires.

string

The Card Token’s identifier.

last4

string

The last 4 digits of the card number.

length

integer

The length of the card number.

prefix

string

The prefix of the card number, usually 8 digits.

type

string

A constant representing the object’s type. For this resource it will always be card_token.

List Card Tokens

curl \
  --url "${INCREASE_URL}/card_tokens" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Returns a list response :

{
  "data": [
    { /* Card Token object */ },
    { /* Card Token object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

cursor

string

limit

integer

created_at.after

string

created_at.before

string

created_at.on_or_after

string

created_at.on_or_before

string

Retrieve a Card Token

curl \
  --url "${INCREASE_URL}/card_tokens/outbound_card_token_zlt0ml6youq3q7vcdlg0" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

card_token_id

string

Required

The identifier of the Card Token.

More about Card Tokens.

Retrieve the capabilities of a Card Token

The capabilities of a Card Token describe whether the card can be used for specific operations, such as Card Push Transfers. The capabilities can change over time based on the issuing bank’s configuration of the card range.

curl \
  --url "${INCREASE_URL}/card_tokens/outbound_card_token_zlt0ml6youq3q7vcdlg0/capabilities" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Returns a Card Token Capabilities object:

{
  "routes": [
    {
      "cross_border_push_transfers": "not_supported",
      "domestic_push_transfers": "supported",
      "issuer_country": "US",
      "route": "visa"
    }
  ],
  "type": "card_token_capabilities"
}

Parameters

card_token_id

string

Required

The identifier of the Card Token.

More about Card Tokens.

Sandbox: Create a Card Token

Simulates tokenizing a card in the sandbox environment.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/card_tokens" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "capabilities": [
      {
        "cross_border_push_transfers": "supported",
        "domestic_push_transfers": "supported",
        "route": "visa"
      }
    ],
    "expiration": "2020-01-31T23:59:59Z",
    "last4": "1234",
    "prefix": "41234567",
    "primary_account_number_length": 16
  }'

Parameters

capabilities

array

The capabilities of the outbound card token.

expiration

string

The expiration date of the card.

last4

string

The last 4 digits of the card number.

Exactly 4 characters

outcome

dictionary

The outcome to simulate for card push transfers using this token.

prefix

string

The prefix of the card number, usually the first 8 digits.

Between 1 and 8 characters

primary_account_number_length

integer

The total length of the card number, including prefix and last4.