Page cover

Get Account Balance

Endpoint

GET {{base_url}}/v1/accounts/<account_id>/balance?currency=<currency_code>

Description

This endpoint retrieves the current balance of a specified account.

URL Parameters

account_id (string): The ID of the account you want to retrieve.

Query Parameters

currency_code (string): The currency code of the account you want to retrieve, i.e. EUR or GBP. NB: This parameter is required when making use of this endpoint

Response

On success, the API will return a JSON object containing the status of a single transaction.

{
    "status": true,
    "message": "Account balance fetched",
    "data": {
        "balance": 1021
    },
    "code": 200
}

Last updated