Sign in

v2

latestOpenAPI 3.1.0raw.githubusercontent.com2026-03-067997411.3 KB

Create a card

post/card

Request body

accountIdstring

The ID of the account to create the card under. You can get this by calling GET /account. This field is required unless you are authenticating via API key, in which case it will default to your first commercial account. We recommend supplying this even if you are authenticating via API key.

virtualAccountIdstring

The ID of the virtual account to create the card under. Virtual accounts can be retrieved by calling GET /virtual-account.

type'virtual' required

Specify the type of card you'd like to create. At the moment, only virtual cards are supported.

namestring required
isSingleUseboolean

Defaults to false. When set to true, the card will be automatically closed after a single authorization attempt. Note that the card will be closed even if the authorization declines or drops

userDataobject

Arbitrary information that can be attached to the card. This should be a JSON object and cannot exceed 4kb.

cardGroupIdstring
cardProductIdstring

The ID of the card product to use when creating this card, if not specified a random card product will be chosen.

Response

OK

idstring required
accountIdstring required

The account that this card is associated with

virtualAccountIdstring

The virtual account that this card is associated with

last4string required

The last 4 digits of the card number

namestring required

The name assigned to the card that appears on the user dashboard

expiryMonthstring required

The month the card expires formatted as MM (01, 02, ..., 12)

expiryYearstring required

The year the card expires formatted as YYYY (2024, 2025, ...)

status'active' | 'paused' | 'inactive' | 'closed' required

The status of the card

isPhysicalboolean required

When true, a physical card has been issued. Otherwise, this is a virtual card.

isSingleUseboolean

When true, the card will be automatically closed after a single authorization attempt. Note that the card will be closed even if the authorization declines or drops

panstring

This field contains the full PAN which will only be sent on a request for a single card when you set the query param "include_pan" to "true"

cvvstring

This field will contain full CVV which will only be sent on a request for a single card when you set the query param "include_pan" to "true"

cardGroupIdstring

The card group the card belongs to.

cardGroupNamestring

The name of the card group the card belongs to.

createdAtstring date-time
userDataobject

Arbitrary information that can be attached to the card. See the PATCH /card/{cardId} endpoint for more details on how to add user data.

cardProductIdstring

The ID of the card product this card was created with.