Skip to main content
POST
Store a card for a merchant

Authorizations

x-api-key
string
header
required

Company API key for authentication

Path Parameters

merchantId
string
required

The merchant ID

Body

application/json

Store a card for later reuse. The number is encrypted ciphertext; metadata that cannot be derived from ciphertext (last_digits, brand, BIN data) is supplied by the caller.

card
object
required

Response

The stored card

A stored card. The encrypted number is never returned.

id
string
required
Example:

"123e4567-e89b-12d3-a456-426614174000"

source
enum<string>
required
Available options:
API,
TRANSACTION
status
enum<string>
required
Available options:
ACTIVE,
REPLACED,
CLOSED,
INVALID
brand
enum<string> | null
required
Available options:
VISA,
MASTERCARD,
AMEX,
ELO,
HIPERCARD,
DINERS,
DISCOVER,
JCB,
AURA,
CABAL,
OTHER
last_digits
string
required
Example:

"4242"

expiry_month
string
required
Example:

"12"

expiry_year
string
required
Example:

"2030"

funding
string | null
required
issuer
string | null
required
country
string | null
required
bin
string | null
required
segment
string | null
required
currency
string | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
cardholder_name
string | null
Example:

"JOHN DOE"