banking.v1.UsersService

GetBalance

The calling user's live balance, read straight from TigerBeetle (Read-First). No Postgres-stored amount exists; the response is authoritative as of as_of.

post/banking.v1.UsersService/GetBalance

Request

  • The document declares no server URL.
  • Auth: none required

Headers

Connect-Protocol-Version1 required

Define the version of the Connect protocol

Connect-Timeout-Msnumber

Define the timeout, in ms

Request body

BankingV1GetUserBalanceRequest required

Response

Success

amountstring
pendingstring
authoritativeboolean

Changes

No recorded changes to this operation across all 50 revisions of this API.