v1

latestOpenAPI 3.0.12026-07-24128351404.9 KB

Card

Create Budget Card

post/open-api/v3/budget-card

Headers

Idempotency-Keystring required

Universally unique identifier idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.

Request body

accountIdstring uuid required

The UUID of the Account.

binIdstring required

The Id of the bin.

cardMode'PHYSICAL_CARD' | 'VIRTUAL_CARD' required

Card mode. Example: VIRTUAL_CARD

useTypestring

Custom use type. Example: Online advertising

labelstring

Custom card label or tag

cardholderIdstring required

cardholder id

physicalCardDesignIdstring

Physical Card Design ID.

ssnstring

If the card type is BB Card and the country is the United States, SSN is a mandatory parameter unless an SSN was already submitted during KYC or cardholder creation.

referenceIdstring required

A unique identifier assigned by you for each card. This value must be unique per card request and will be used later to query or track the corresponding card.

budgetIdstring uuid required

The UUID of the Budget.

Response

codestring

Return code

messagestring

Error message