Skip to main content
GET
/
v1
/
accounts
/
{account_number}
/
balance
Fetch Balance
curl --request GET \
  --url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/accounts/{account_number}/balance \
  --header 'apikey: <api-key>' \
  --header 'x-carbon-key: <x-carbon-key>'
{
  "status": "success",
  "message": "balance fetched successfully",
  "data": {
    "account_number": "0000000000",
    "balance": 0,
    "available_balance": 0,
    "business_account": true,
    "locked": false
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.getcarbon.co/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

This endpoint retrieves the balance of a specific account identified by the account number.

​
Request

Method: GET
URL: /v1/accounts/{account_number}/balance

​
Parameters

NameInTypeRequiredDescription
x-carbon-keyHeaderstringYesAPI key for authentication.
account_numberPathintegerYesThe account number to retrieve.

​
Response

Status Code: 200 OK
Content-Type: application/json

​
Example Response

{
  "status": "success",
  "message": "Balance fetched successfully",
  "data": {
    "account_number": "0000000000",
    "balance": 0,
    "available_balance": 0,
    "business_account": true,
    "locked": false
  }
}

Authorizations

​
apikey
string
header
required

Provide your API key in the 'apikey' header.

Headers

​
x-carbon-key
string
required

Path Parameters

​
account_number
integer
required

Response

200 - application/json

OK

The response is of type object.