Skip to navigation

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

ParameterTypeRequiredDescription
account_idUUIDYesTreasury account identifier

Success Responses

Status CodeDescription
200OK — balance snapshot returned

Error Responses

Status CodeError CodeDescription
401AUTHENTICATION_ERRORAuthentication credentials are invalid or missing
403AUTHORIZATION_ERRORYou do not have permission to perform this action
404NOT_FOUNDTreasury 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 nullOptional