Get Balances

Provide access to balance information across various currencies.

GET /v1/balances

Request

HTTP Headers

To use this endpoint, you must include the following headers for authentication and authorization:

Header	Type	Required	Description
x-api-key	String	Yes	API key assigned to your account for service access.
Authorization	String	Yes	Bearer token to authenticate the API request.

Query Parameters

Include the following parameters in the query string to filter balance information:

Parameter	Type	Required	Default Value	Description
currency	String	No	None	Optional filter for balance information by 3-letter currency code (ISO-4217).

Example Request

GET /v1/balances?currency=USD HTTP/1.1
Host: api.example.com
Content-Type: application/json
x-api-key: <API_KEY>
Authorization: Bearer <BEARER_ACCESS_TOKEN>

Responses

HTTP Status Codes

Status Code	Description
200	OK
400	Bad Request
500	Internal Server Error

Schema

Property	Type	Nullable	Description
requestId	String	No	Unique identifier assigned to each request for tracking purposes.
data	BalanceResponse[]	No	List of balance response.

BalanceResponse

Property	Type	Nullable	Description
balance	String	No	The balance amount.
currency	String	No	The 3-letter currency code (ISO-4217).

Example 200 OK Response

{
  "requestId": "c4c7b997-79a5-4bde-9f17-47ad7eac9ed4",
  "data": [
    {
      "balance": "10000.00",
      "currency": "USD"
    },
    {
      "balance": "5000.00",
      "currency": "CAD"
    }
  ]
}