RIrillet
Bank accounts

Retrieves a bank account balance

Changed on

Returns the latest stored bank balance on or before the requested date in the bank account's native currency. The response includes the stored balance date so consumers can identify when the latest available balance predates the requested date.

get/bank-accounts/{bank_account_id}/balance

Request

  • Base URL
    https://api.rillet.com
  • Auth
    HTTP bearer

Path parameters

bank_account_idstring uuid required

UUID of the bank account.

Query parameters

as_of_datestring date required

Date on or before which to retrieve the latest stored bank balance (ISO-8601 format).

Response

OK

bank_account_idstring uuid required
as_of_datestring date required

The requested as-of date.

balance_datestring date required

The date of the stored balance returned, which may precede the requested as-of date.

Example response

{
  "balance": {
    "amount": "1.01",
    "currency": "USD"
  }
}

Changes