API Reference
Get a card balance
Returns what the card can spend and the balance of its card group, in USD as JSON numbers. balance is 0 unless the card is active.
Path Parameters
ID of the card
Responses
| Status | Description |
|---|---|
200 |
The balance |
400 |
The request failed. Every card error is a 400, including not-found. Read error. |
200 response
Balance shared by the cards in the group
True when several cards share the group
{
"data": {
"balance": 22.5,
"group_balance": 22.5,
"currency": "USD",
"shared": false,
"card_group_id": "3f1d0c5e-2a8b-4b7e-9f3a-6c1e2d4b5a70"
},
"error": null
}
400 response
What went wrong
{
"data": null,
"error": "card does not exist"
}
Authorization
- ApiKeyAuth
Was this page helpful?