Skip to main content
POST
Create card

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.

Headers

X-Idempotency-Key
string

Body

application/json;charset=UTF-8
balanceAccountId
string<uuid>

ID of the card balance account to associate with this card.

ownerId
string<uuid>

ID of the user who will own/manage this card.

metadata
object

Card type metadata. Use type 'VENDOR' with vendorId for vendor cards, or type 'EMPLOYEE' with employeeId for employee cards.

description
string | null

Optional description or memo for this card.

authentication
object

3D Secure authentication details for the card.

limits
(object | null)[] | null

Optional spending limits for this card.

Optional spending limits for this card.

formFactor
enum<string> | null

Card form factor. Defaults to VIRTUAL when omitted. PHYSICAL ships a plastic card and requires deliveryContact to be set. VIRTUAL must be sent with deliveryContact left null. Mismatches are rejected with PHYSICAL_CARD_DELIVERY_CONTACT_REQUIRED or VIRTUAL_CARD_DELIVERY_CONTACT_NOT_ALLOWED.

⚠️ This enum is not exhaustive; new values may be added in the future.

Available options:
PHYSICAL,
VIRTUAL
deliveryContact
object | null

Recipient and address used by the card issuer to ship the physical card. Only address and name are required.

Response

default - application/json;charset=UTF-8

default response

id
string<uuid>
companyEntityId
string<uuid>
companyId
string<uuid>
ownerId
string<uuid>
cardBalanceAccountId
string<uuid>
form
enum<string>

⚠️ This enum is not exhaustive; new values may be added in the future.

Available options:
PHYSICAL,
VIRTUAL
status
enum<string>

⚠️ This enum is not exhaustive; new values may be added in the future.

Available options:
ACTIVE,
FROZEN,
CLOSED,
UPDATE_IN_PROGRESS
metadata
object
threeDs
object
description
string
bin
string
lastFour
string
cardholderName
string
limits
object[]
createdAt
string<date-time>
updatedAt
string<date-time>
type
enum<string>

⚠️ This enum is not exhaustive; new values may be added in the future.

Available options:
VENDOR,
EMPLOYEE