Overview
Entities
Legal Entity
Virtual Account
Transaction
Card
Card Group
List account balances
Retrieve a list of balances for an account. The balances are returned in an array, with each item representing a balance for that account.
For charge_card accounts, there will be two balances returned: “cash” and “credit”. For debit accounts, there will only be one balance returned: “debit”.
curl --request GET \
--url https://api.joinslash.com/account/{accountId}/balance \
--header 'X-API-Key: <api-key>'{
"balances": [
{
"accountId": "<string>",
"type": "cash",
"available": {
"amountCents": 123
},
"posted": {
"amountCents": 123
},
"timestamp": "2023-11-07T05:31:56Z"
}
]
}Authorizations
Authentication from public API requests
Path Parameters
Response
The ID of the account associated with the balance.
The type of balance.
- "cash" represents the excess balance not used as collateral for the charge card. Not applicable to debit accounts.
- "credit" represents the balance that can be spent on the charge card. Not applicable to debit accounts.
- "debit" represents the balance that can be spent or withdrawn. Not applicable to charge card accounts.
cash, credit, debit The amount of money that is immediately available to use.
- For "credit" balances, this is the immediately available amount that can be spent on the charge card.
- For "cash" balances, this value represents the immediately available excess cash that is not being used as collateral for the charge card. You can choose to transfer more than these funds to your bank account, but any amount not coverable by the available balance will be removed from the charge card's collateral balance (the "credit" balance).
- For "debit" balances, this is the amount of money available that can be spent or withdrawn immediately.
The amount in cents
The amount of money that has been posted to the account. This value does not include any pending transactions and instead represents the amount of money that has been posted to the balance.
The amount in cents
The UTC timestamp associated with the balance. Since the balance can change rapidly, the timestamp is included to indicate the time when the balance was computed.
curl --request GET \
--url https://api.joinslash.com/account/{accountId}/balance \
--header 'X-API-Key: <api-key>'{
"balances": [
{
"accountId": "<string>",
"type": "cash",
"available": {
"amountCents": 123
},
"posted": {
"amountCents": 123
},
"timestamp": "2023-11-07T05:31:56Z"
}
]
}