SHshinkansen
Balances

Returns the latest balances for the account

Returns the latest balance (available balance and book balance) for the given account.

get/accounts/{fin_id}/{account}/balances/latest

Request

  • Base URL
    https://api.treasury.shinkansen.finance/v1
  • URL
    https://api.treasury.shinkansen.finance/v1/accounts/{fin_id}/{account}/balances/latest
  • Auth
    API key in header Shinkansen-Treasury-Api-Key

Response

The balances array holds the latest snapshot balance for the account, which works in real(ish)-time but can be slightly inaccurate under some situations for some financial institutions. The array is empty when no balance has been captured for the account yet.

accountstring required

Account number

currencystring required

Currency ISO 4217 code (e.g: "CLP")

Example response

{
  "account": 123456789012,
  "financial_institution": {
    "fin_id_schema": "SHINKANSEN",
    "fin_id": "BANCO_BICE_CL"
  },
  "currency": "CLP",
  "balances": [
    {
      "balance_type": "snapshot",
      "book_balance": 123.5,
      "available_balance": 123.5,
      "timestamp": "2019-06-04T00:00:00.000Z",
      "source": {
        "source_type": "account_report",
        "source_id": "ab1def2g-7e98-4e13-8b03-0b3b2e6d5a3c"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.