Get Balance

Fetch balance details for a merchant or sub-merchant across supported currencies.

Endpoint

GET /v1/public/balance

Sandbox Base URL

https://sandbox-api.aparatech.io

Query Parameters

Parameter	Type	Required	Description
`page`	Integer	No	Page number. Default: `1`
`limit`	Integer	No	Number of records per page.
`currency`	String	No	Filter balances by currency (e.g. `USDC`, `USD`, `EUR`).

Balance Fields

Each balance object contains the following values:

Field	Description
`totalCollectionsAmount`	Total amount collected from fiat pay-in orders.
`totalPayoutAmount`	Total amount paid out for fiat payout orders.
`totalPayoutInTransitBalance`	Total payout amount currently in transit or locked by Apara.
`totalSettledAmount`	Total amount settled to the customer from the account.
`totalUnsettledAmount`	Total amount pending settlement in the account.
`totalAvailablePrefundingBalance`	Total available prefunding balance.

Example Request

curl --location 'https://sandbox-api.aparatech.io/v1/public/balance?page=1&limit=5&currency=USDC' \
  --header 'Authorization: Basic <base64-credentials>' \
  --header 'mid: SAH1N3_NA_NA'

Example Response

{
  "success": true,
  "message": "Balance fetched successfully",
  "data": {
    "page": 1,
    "limit": 5,
    "total": 1,
    "balances": [
      {
        "currency": "USDC",
        "totalCollectionsAmount": "25000.00",
        "totalPayoutAmount": "15000.00",
        "totalPayoutInTransitBalance": "500.00",
        "totalSettledAmount": "8000.00",
        "totalUnsettledAmount": "2000.00",
        "totalAvailablePrefundingBalance": "12500.00"
      }
    ]
  }
}

Response Fields

Field	Type	Description
`success`	Boolean	Indicates whether the request was successful.
`message`	String	API response message.
`data.page`	Integer	Current page number.
`data.limit`	Integer	Number of records returned per page.
`data.total`	Integer	Total number of balance records.
`data.balances`	Array	List of balances grouped by currency.

Notes

Omitting the mid header returns aggregated balances across all supported merchants/entities.
Use the currency query parameter to retrieve balances for a specific currency.
Pagination is supported using the page and limit query parameters.
All monetary values are returned as strings to preserve decimal precision.

Was this page helpful?