POST
/api/v2/cardsCreate a new card
Authentication
Send your API key in the x-api-key header on every request.
Request body
application/json
| Field | Type | Required | Description |
|---|---|---|---|
| UserId | unknown | Yes | |
| CardTypeId | unknown | Yes | |
| ExternalCardId | string | No | Optional external identifier. The card provider assigns its own identifier when this value is omitted. |
| Nickname | string | No | |
| Currency | string | No | |
| CardName | string | No | |
| BudgetId | string | No | Required when the selected card type uses EqualsMoney; optional for card types. |
| BillingAddress | object | No | |
| DeliveryAddress | object | No | |
| DeliveryAddressId | string | No | |
| Phone | string | Yes | |
| PhoneCode | string | No | Optional when Phone is supplied in E.164 format. Otherwise provide the country calling code. |
| DesignId | string | No | |
| PhysicalCardDesignId | string | No | |
| DiscountCode | string | No | |
| AutoLockEnabled | boolean | No |
Responses
201 — Created
| Field | Type | Required | Description |
|---|---|---|---|
| Id | unknown | No | |
| UserId | unknown | No | |
| ExternalCardId | string | No | |
| DeliveryAddressId | string | No | |
| Nickname | string | No | |
| CardType | string | No | |
| CardNumber | string | No | |
| ExpiryDate | string | No | |
| Status | CardStatusV2 | No | |
| Balance | CardBalanceV2 | No | |
| Currency | string | No | |
| VelocityControl | object | No | |
| CreatedAt | string | No | |
| UpdatedAt | string | No | |
| CardTypeId | unknown | No | |
| CardTypeTierId | unknown | No | |
| TierId | unknown | No | |
| AutoLockEnabled | boolean | No | |
| AutoLockActiveUntil | string (date-time) | No | |
| TransakOrder | string | No | |
| RequiredAmount | string | No | |
| AvailableAmount | string | No | |
| Shortfall | string | No | |
| Message | string | No | |
| Errors | array of InterLaceCheck | No |
400 — Bad Request
| Field | Type | Required | Description |
|---|---|---|---|
| Message | string | No | |
| Code | string | No | |
| Status | unknown | No | |
| ValidationErrors | object | No | |
| Details | string | No |
404 — Not Found
| Field | Type | Required | Description |
|---|---|---|---|
| Message | string | No | |
| Code | string | No | |
| Status | unknown | No | |
| ValidationErrors | object | No | |
| Details | string | No |
500 — Internal Server Error
| Field | Type | Required | Description |
|---|---|---|---|
| Message | string | No | |
| Code | string | No | |
| Status | unknown | No | |
| ValidationErrors | object | No | |
| Details | string | No |
Example request
curl -X POST "https://{base_url}/api/v2/cards" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"UserId":"…","CardTypeId":"…","Phone":"…"}'This page is generated from the live OpenAPI specification and always matches the current API.