Getting Balances

Retrieve the available balances of network accounts across all jurisdictions.

Sign the request

curl -X POST "https://signing.api.example.com/v1/sign" \
  -H "Content-Type: application/json" \
  -d '{"SignFor":"RTGS:G:BL12345678","Method":"GET","PathAndQuery":"/v2/Balances"}'

Retrieve balances

curl -X GET "https://api.example.com/v2/Balances" \
  -H "rtgs-global-sig: {signature}"

Response

{
  "GrpHdr": {
    "MsgId": "2b4cf98fc94c4520a845433aa2600bfb",
    "CreDtTm": "2024-01-22T16:37:25.205Z"
  },
  "Rpt": [
    {
      "Id": "cd893b00154e467ca100d843542a1f8b",
      "CreDtTm": "2024-01-22T16:37:25.205Z",
      "Acct": { "Id": { "IBAN": "GB33BUKB20201555555555" } },
      "Bal": [
        {
          "Tp": { "CdOrPrtry": { "Cd": "ITAV" } },
          "Amt": { "Ccy": "GBP", "Value": "9.99" },
          "CdtDbtInd": "CRDT"
        }
      ]
    }
  ]
}