Balances Explained

This page contains information about realtime balance APIs

Realtime Balance

You can read realtime account balances using the following API. This API works both Primary and Virtual accounts.

Balance breakdown

All amounts including account balances returned in hundreds to preserve floating point precision and reduce errors on JSON serialize/deserialize steps.

ie. £1.92 represented as 192 Similarly. £27.01 would be shown as 2791

Real-time balance

{
  "currency": "GBP",
  "availableBalance": 400,
  "ledgerBalance": 500,
  "pendingCredits": 0
}

Currency code on balance is always the same currency as the account involved.

PreviousGetting Accounts NextPayments

Last updated 1 month ago

Was this helpful?

Get account balance

GETapi-url/v1/partner/accounts/{accountId}/balance

Path parameters

accountId*string

Header parameters

Response

Returns account real-time balance positions

Body

currency*enum

Example: "GBP"

AFNEURALLDZDUSDAOAXCDARSAMDAWGAUDAZNBSDBHDBDTBBDBYNBZDXOFBMDINRBTNBOBBOVBAMBWPNOKBRLBNDBGNBIFCVEKHRXAFCADKYDCLPCLFCNYCOPCOUKMFCDFNZDCRCHRKCUPCUCANGCZKDKKDJFDOPEGPSVCERNSZLETBFKPFJDXPFGMDGELGHSGIPGTQGBPGNFGYDHTGHNLHKDHUFISKIDRXDRIRRIQDILSJMDJPYJODKZTKESKPWKRWKWDKGSLAKLBPLSLZARLRDLYDCHFMOPMKDMGAMWKMYRMVRMRUMURXUAMXNMXVMDLMNTMADMZNMMKNADNPRNIONGNOMRPKRPABPGKPYGPENPHPPLNQARRONRUBRWFWSTSTNSARRSDSCRSLLSGDXSUSBDSOSSSPLKRSDGSRDSEKCHECHWSYPTWDTJSTHBTOPTTDTNDTRYTMTUGXUAHAEDUSNUYUUYIUYWUZSVUVVESVNDYERZMWZWLXBAXBBXBCXBDXTSXXXXAUXPDXPTXAGAFAFIMADPESPFRFAOKAORRURATSAYMAZMBYBBYRBECBEFBELBADBRBBRRBGJCYPCSKECSECVGQEEEKXEUGEKDDMDEMGHCGHPGRDGWEITLIEPLVLZALLTLLUCLUFLULMGFMLFMTLMROMZENLGPLZPTEROKSTDCSDSKKSITRHDESAESBSDDSRGTJRTPETRLTMMUAKUSSVEBVEFYUDZRNZMKZWNZWR

availableBalance*number

ledgerBalance*number

pendingCredits*number

Request

const response = await fetch('api-url/v1/partner/accounts/{accountId}/balance', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "currency": "GBP",
  "availableBalance": 1,
  "ledgerBalance": 1,
  "pendingCredits": 1
}