API ReferenceMerchant API
List all currency balances for the authenticated merchant.
Returns one balance row per currency for the merchant tied to the authenticating API key. The environment is resolved from the API key that authenticated the request.
X-API-Key<token>
API key issued by the merchant dashboard. The key's environment (live/test) determines which data the caller can access. Permissions on the key control which endpoints are reachable.
In: header
Query Parameters
environment?string
Reserved for forward compatibility with JWT-authenticated dashboard callers. For API-key callers the environment is determined by the key itself and this parameter is ignored.
Value in
"live" | "test"limit?integer
Reserved for forward compatibility.
Range
1 <= value <= 100offset?integer
Reserved for forward compatibility.
Range
0 <= valueResponse Body
fetch("https://api.halfin.xyz/api/v1/balances?environment=live&limit=1&offset=0", { method: "GET"}){
"data": [
{
"currency": "BTC",
"network": "bitcoin",
"environment": "live",
"available": "string",
"pending": "string",
"total_received": "string",
"total_fees": "string",
"total_paid_out": "string",
"total_in_base_currency": "string"
}
],
"meta": {
"request_id": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
]
},
"meta": {
"request_id": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
]
},
"meta": {
"request_id": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
]
},
"meta": {
"request_id": "string"
}
}