Sign in

v1

latestOpenAPI 3.0.02026-07-248834.9 KB
Card

Get card

Get card configuration such as spend limit and state.

get/cards/{card_token}

Path parameters

card_tokenstring uuid required

Response

OK

createdstring date-time required

An ISO 8601 timestamp for when the card was created. UTC time zone.

exp_monthstring

Two digit (MM) expiry month.

exp_yearstring

Four digit (yyyy) expiry year.

hostnamestring

Hostname of card's locked merchant (will be empty if not applicable).

last_fourstring required

Last four digits of the card number.

memostring

Friendly name to identify the card.

spend_limitinteger required

Amount (in cents) to limit approved authorizations. Transaction requests above the spend limit will be declined.

spend_limit_duration'ANNUALLY' | 'FOREVER' | 'MONTHLY' | 'TRANSACTION' required

Spend limit duration values:

  • ANNUALLY - Card will authorize transactions up to spend limit in a calendar year.
  • FOREVER - Card will authorize only up to spend limit for the entire lifetime of the card.
  • MONTHLY - Card will authorize transactions up to spend limit for the trailing month. Month is calculated as this calendar date one month prior.
  • TRANSACTION - Card will authorizate multiple transactions if each individual transaction is under the spend limit.
state'CLOSED' | 'OPEN' | 'PAUSED' required

Card state values:

  • CLOSED - Card will no longer approve authorizations. Closing a card cannot be undone.
  • OPEN - Card will approve authorizations (if they match card and account parameters).
  • PAUSED - Card will decline authorizations, but can be resumed at a later time.
tokenstring uuid required

Globally unique identifier.

type'DIGITAL_WALLET' | 'MERCHANT_LOCKED' | 'SINGLE_USE' | 'UNLOCKED' required

Card types:

  • DIGITAL_WALLET - Cards that can be provisioned to a digital wallet like Google Pay or Apple Wallet.
  • MERCHANT_LOCKED - Card is locked to first merchant that successfully authorizes the card.
  • SINGLE_USE - Card will close shortly after the first transaction.
  • UNLOCKED - Card will authorize at any merchant. Creating these cards requires additional privileges.
cvvstring

Three digit cvv printed on the back of the card.

panstring

Primary Account Number (PAN) (i.e. the card number).

Example response

{
  "created": "2021-06-28T22:53:15Z",
  "exp_month": "06",
  "exp_year": "2027",
  "memo": "New Card",
  "spend_limit": 1000,
  "token": "7ef7d65c-9023-4da3-b113-3b8583fd7951",
  "cvv": "776",
  "pan": "4111111289144142"
}