Developer Platform
Check card balance
Read what a card can spend now, and the balance it shares with the cardholder's other cards.
Get card balance returns what a card can spend and the balance of the group it belongs to.
A money example. Ada's card holds 131.25 USD. You freeze it. balance then reads 0, while group_balance still reads 131.25. You unfreeze it, and balance is 131.25 again.
curl --request GET \
--url https://api.gravv.xyz/v1/cards/a14ec356-f33d-4384-ba68-4d9bfa19765b/balance \
--header 'Api-Key: <API_KEY>'
{
"data": {
"balance": 131.25,
"group_balance": 131.25,
"currency": "USD",
"shared": false,
"card_group_id": "3f1d0c5e-2a8b-4b7e-9f3a-6c1e2d4b5a70"
},
"error": null
}
| Field | Meaning |
|---|---|
balance |
What this card can spend now, in US dollars (a JSON number). It is 0 unless the card is active |
group_balance |
The balance of the card's group, which is the money this card shares with the cardholder's other cards in the same group |
shared |
true when more than one card is in the group (a blocked card still counts). Money taken from a shared group is money the other cards can no longer spend |
card_group_id |
The group. Send it as funding.card_group_id with mode shared to put a new card in the same group |
A card issued with funding.mode own has a group of its own. In sandbox, balance follows the card's wallet, so a funding shows once its transfer is completed.
Read the balance after a funding completes, before a large payment, and before you block a card.
Was this page helpful?