POST

Authorizations

Authorization
string
header
required

The user's access_token from authentication. The program and environment come from the token.

Headers

Idempotency-Key
string<uuid>

Optional. Makes the request retry-safe: a retry with the same key resolves to the same card instead of creating a duplicate. Must be a UUID, and is scoped to the authenticated customer. Preferred over any idempotencyKey body field (a header value wins if both are sent). Optional today, but will be required in a future release: send one on every create now so a retry can never produce a duplicate.

Path Parameters

customerId
string
required

The customer's id.

accountId
string
required

The account the card belongs to. A customer can have several accounts; cards are issued against one.

Body

application/json
cardType
enum<string>

The card format. Send this or cardName.

Available options:
VIRTUAL,
PHYSICAL
cardName
string

A configured card product. Send this or cardType.

nickName
string

Optional label shown to the user.

limitGroupId
string

Optional. Initial limit group.

prepaid
boolean

Optional. Issue as a prepaid card (where the program supports it).

forCustomerId
string<uuid>

Optional. The cardholder, for corporate cards. For a management/M2M caller ordering on a corporate's account, naming a cardholder of that corporate (invited as an EMPLOYEE, or under a role your program defines) makes it that cardholder's card: embossed with their name and attributed to them, so among cardholders only they see it; what they can do with it is set by the permissions on their role. The cardholder must belong to the path corporate, and — when they were granted specific accounts — the path account must be one of them; otherwise 400.

idempotencyKey
string<uuid>

Optional. Idempotency key for retry-safety. The Idempotency-Key header is preferred and overrides this field. Reusing a key with different core parameters returns 400; a key whose card is still being claimed returns 409.

Response

Card created

success
boolean
Example:

true

data
object