Sign in

v1

latestOpenAPI 3.0.02026-07-2640301.0 MB
Virtual Account Endpoints

virtual-account/balance

Retrieve the balance for a specific virtual account.

get/virtual-account/balance

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

VirtualAccountIDstring

The ID of the virtual account to retrieve the balance for

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Contains a description of the error if the request failed

Example response

{
  "VirtualAccountBalance": [
    {
      "Balance": "1000.00",
      "ShortForm": "GBP"
    }
  ]
}