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.

Get account balance

get

/v1/partner/accounts/{accountId}/balance

Path parameters

accountIdstringrequired

Header parameters

authorizationstring

Authorization header containing your API Token

x-alg-noncestring

Nonce used to generate the payload signature

x-alg-signaturestring

Payload signature

datestring

Date of the request un UTC/GMT

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'api-url/v1/partner/accounts/{accountId}/balance'

200

400

403

404

422

200

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

Returns account real-time balance positions

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​
​}

Balance

Available Balance

Description

Balance on account ledger minus pending debits.

Balance

Ledger Balance

Description

Balance on account ledger including pending debits, excluding pending credits.

Balance

Pending Credits

Description

Total pending funds on account ledger.

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