v1

latestSwagger 2.02026-07-1491526.0 KB
Accounts

Get a customers account balance

This method can be used to retrieve the customer’s account balance in UK Sterling.

get/account/balance

Query parameters

fieldsstring[]

Specify an absolute field list to return (Comma-Separated List)

includestring[]

Specify fields in addition to the default to return (Comma-Separated List)

excludestring[]

Specify fields from the default to exclude (Comma-Separated List)

languageAsPerTerritorystring

Defines response field name language, true (default) returns in language defined by territory, false returns in English

Headers

apiKeystring required

A unique identifier of your application that is generated by the API portal.

apiSecretstring required

Another unique identifier for your application.

apiTicketstring required

Ticket Granting Ticket obtained from a previous request

territorystring

Territory from which request originates

Response

Success

availableFundsnumber

Current available funds in this account

balancenumber required

Current balance of account

currencyCodestring required

A three-character ISO4217 currency code. This will be the currency that the user registered in

withdrawableFundsnumber

Current withdrawable balance of this account