Get Balances

The Get Balances endpoint allows you to retrieve a list of all your account balances. This endpoint returns only active balances, providing you with an overview of all operational currency balances in your account.

Each balance in the response includes the available balance, ledger balance, and currency information, enabling you to track your funds across different currencies.

Request

GEThttps://api.harpfi.com/v1/balances

Response

JSON

{
    "success": true,
    "message": "Balances retrieved successfully",
    "data": [
        {
            "reference": "TBW_FTLjX6paaK81",
            "currency": "USD",
            "availableBalance": "1000.00",
            "ledgerBalance": "1000.00"
        },
        {
            "reference": "TBW_D5OQyFXRTmYt",
            "currency": "GBP",
            "availableBalance": "500.50",
            "ledgerBalance": "500.50"
        },
        {
            "reference": "TBW_EkoK3pzk2n22",
            "currency": "EUR",
            "availableBalance": "250.75",
            "ledgerBalance": "250.75"
        },
        {
            "reference": "TBW_rZ1ENarb46IK",
            "currency": "XOF",
            "availableBalance": "200000",
            "ledgerBalance": "200000"
        }
    ]
}

Response Fields

The response returns an array of balance objects, each containing:

Field	Type	Description
`reference`	string	A unique reference to identify the balance
`currency`	string	The currency code for the balance (e.g. USD, GBP, EUR)
`availableBalance`	string	The amount of funds immediately available for use
`ledgerBalance`	string	The total amount of funds in the balance. This includes both locked and available funds

Note: This endpoint returns only active balances. Inactive balances are excluded from the response.

Note: Balance values follow the decimal point specification of the respective currency. For example, currencies like USD, GBP, and EUR use 2 decimal places, while some currencies may use different decimal precision.