Skip to main content
GET
/
balances
/
{id}
Get Balance
curl --request GET \
  --url http://localhost:5001/balances/{id} \
  --header 'X-blnk-key: <api-key>'
{
  "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0",
  "balance": 300,
  "credit_balance": 300,
  "debit_balance": 0,
  "currency": "NGN",
  "currency_multiplier": 1,
  "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
  "identity_id": "",
  "ledger": {
    "id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
    "name": "Customer wallets Ledger",
    "created_at": "2024-02-20T05:28:03.563132Z"
  },
  "created_at": "2024-02-20T05:33:01.3116Z",
  "meta_data": null
}

Authorizations

​
X-blnk-key
string
header
required

Path Parameters

​
id
string
required
Example:

"bln_0be360ca-86fe-457d-be43-daa3f966d8f0"

Query Parameters

​
include
string
required
Example:

"ledger"

Response

200 - application/json; charset=utf-8

OK

​
balance_id
string
required
​
balance
integer<int32>
required
​
credit_balance
integer<int32>
required
​
debit_balance
integer<int32>
required
​
currency
string
required
​
currency_multiplier
integer<int32>
required
​
ledger_id
string
required
​
identity_id
string
required
​
ledger
Ledger · object
required
Example:
{
  "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
  "name": "Customer wallets Ledger",
  "created_at": "2024-02-20T05:28:03.563132Z",
  "meta_data": { "project_owner": "Blnk Tech" }
}
​
created_at
string
required
​
meta_data
string | null
required