GET
Retrieve a financial account balance
ENDPOINT/v1/financial-accounts/{financial_account_id}/balances
Returns the available, pending, and total position for this financial account. Amounts are money objects in integer minor units. Pass as_of
for a historical snapshot; omit it for the current position. This
operation is program-scoped.
Authentication & Headers
| Header | Type | Requirement | Description |
|---|---|---|---|
| Authorization | string | REQUIRED | API key passed as an HTTP Bearer token: Bearer rk_live_... |
| X-Program-ID | UUID | PROGRAM-SCOPED | Program boundary UUID that scopes the issuing card, wallet, or transfer. |
Path Parameters
| Parameter | Type | Requirement | Description |
|---|---|---|---|
| financial_account_id | string | REQUIRED | Unique identifier of the financial account. |
Query Parameters
| Parameter | Type | Requirement | Description |
|---|---|---|---|
| as_of | string(date-time) | OPTIONAL | Instant to read the position at (inclusive), RFC 3339 in UTC. Omit to
return the current position.
|
Response Codes & Schemas
200Balance snapshot for the financial account.
application/json{
"id": "4f9d2e61-7a13-4c58-b3e7-8c1f5d0a7809",
"object": "balance",
"financial_account_id": "9b3e1c70-4d2a-4f86-8c1b-5e7a2d9f0c14",
"wallet_id": "4d8f2a10-6c3e-4b91-9e5a-2f7c8d1e0b44",
"kind": "CREDIT",
"purpose": "ISSUING",
"available": {
"amount": 125000,
"currency": "USD"
},
"pending": {
"amount": 4280,
"currency": "USD"
},
"total": {
"amount": 129280,
"currency": "USD"
},
"currency": "USD",
"last_transaction_id": "7e2c9a15-4b68-4f47-ae90-3d6f1c8b6798",
"as_of": "2026-08-27T15:04:05Z",
"updated_at": "2026-08-27T15:04:05Z"
}400Bad Request: malformed JSON, failed schema validation, or conflicting parameters.
application/json{
"error": {
"type": "invalid_request_error",
"code": "invalid_request",
"message": "invalid order by: foo. Valid options are: [created_at updated_at]",
"param": "order_by",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"doc_url": "https://docs.rookpayments.com/errors/invalid_request"
}
}401Unauthorized: missing, malformed, or unknown API key.
application/json{
"error": {
"type": "authentication_error",
"code": "authentication_error",
"message": "A valid API key is required.",
"param": null,
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"doc_url": "https://docs.rookpayments.com/errors/authentication_error"
}
}403Forbidden: the API key is denied by RBAC, or it cannot access this
program. A resource that exists on another program or organization
returns `404 not_found`, not `403`.
application/json{
"error": {
"type": "permission_error",
"code": "permission_denied",
"message": "The API key cannot access this program.",
"param": "X-Program-ID",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"doc_url": "https://docs.rookpayments.com/errors/permission_denied"
}
}404Not Found: unknown id, or the resource is not visible to this API key.
application/json{
"error": {
"type": "not_found_error",
"code": "not_found",
"message": "No card found for the given id.",
"param": "card_id",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"doc_url": "https://docs.rookpayments.com/errors/not_found"
}
}429Too Many Requests: the API key exceeded its rate limit.
application/json{
"error": {
"type": "rate_limit_error",
"code": "rate_limited",
"message": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
"param": null,
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"doc_url": "https://docs.rookpayments.com/errors/rate_limited"
}
}500Internal Server Error: unexpected failure. Retry with the same Idempotency-Key.
application/json{
"error": {
"type": "api_error",
"code": "internal_error",
"message": "An unexpected error occurred. Retry with the same Idempotency-Key.",
"param": null,
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"doc_url": "https://docs.rookpayments.com/errors/internal_error"
}
}