Get treasury account balance

View as Markdown
Returns the latest balance snapshot for a treasury account. The response includes available and ledger amounts (when reported by the bank), currency, and the time the balance was last reported. **Path parameters** | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `account_id` | UUID | Yes | Treasury account identifier | **Success Responses** | Status Code | Description | |-------------|-------------| | 200 | OK — balance snapshot returned | **Error Responses** | Status Code | Error Code | Description | |-------------|------------|-------------| | 401 | AUTHENTICATION_ERROR | Authentication credentials are invalid or missing | | 403 | AUTHORIZATION_ERROR | You do not have permission to perform this action | | 404 | NOT_FOUND | Treasury account not found, or no balance snapshot is available yet |

Authentication

x-api-keystring

RootPay API key sent in the x-api-key header. Keys are environment-scoped: live_* for production, test_* for sandbox.

Path parameters

account_idstringRequiredformat: "uuid"
Main operating account ID.

Response

Successful Response
dataobject

Latest balance snapshot for a main treasury account (TreasuryAccountBalance).

warningstring or null