Create an external card
Create a new external card for a counter party (identified by
counterPartyId in the request body). The card number is tokenized
with the card provider and never stored in plaintext; only the last four
digits are retained and the card number is always returned masked. The
counter party must be active.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Card details to tokenize and associate with the counter party.
Card details to tokenize. The card number is tokenized with the card provider and never stored in plaintext; only the last four digits are retained.
Public ID of the counter party this card belongs to (prefixed with cpty_).
"cpty_7bV1aLcs3Kf9dQ2mNpXwZ"
Cardholder first name.
"John"
Cardholder last name.
"Doe"
Full card number (PAN).
"4111111111111111"
Card expiry month (2 digits).
2"09"
Card expiry year (2 digits).
2"28"
Card verification value.
"123"
Client-supplied nickname for the external card.
1 - 100"Jane's virtual card"
Response
External card created successfully.
An external card.
Public ID of the external card (prefixed with extcrd_).
"extcrd_2mNpXwZ7bV1aLcs3Kf9dQ"
Public ID of the user this card belongs to (prefixed with usr_).
"usr_3Kf9dQ2mNpXwZ7bV1aLcs"
Public ID of the counter party this card belongs to (prefixed with cpty_).
"cpty_7bV1aLcs3Kf9dQ2mNpXwZ"
Cardholder first name.
"John"
Cardholder last name.
"Doe"
Masked card number, exposing only the last four digits.
"************1111"
Card expiry month (2 digits).
"09"
Card expiry year (2 digits).
"28"
Client-supplied nickname for the external card.
"Jane's virtual card"
ACTIVE, INACTIVE "ACTIVE"
"2026-07-01T10:30:00.000Z"
"2026-07-01T10:30:00.000Z"