GET
/
balances
/
{balance_id}
curl --request GET \
  --url http://localhost:5001/balances/{balance_id} \
  --header 'Authorization: Basic <encoded-value>'

{
    "balance": 0,
    "inflight_balance": 0,
    "credit_balance": 0,
    "inflight_credit_balance": 0,
    "debit_balance": 0,
    "inflight_debit_balance": 0,
    "queued_credit_balance": 0,
    "queued_debit_balance": 0,
    "ledger_id": "ldg_049495c6-356e-4ebc-a45e-60d1e1e16afb",
    "identity_id": "",
    "balance_id": "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
    "currency": "USD",
    "created_at": "2024-11-26T08:36:36.238244338Z",
    "meta_data": null
}

​
Authorization

Basic authentication header of the form — Basic <encoded-value>, where <encoded-value> is the base64-encoded string of your username:password.

​
Path

​
balance_id
string

Specifies the unique ID of the balance being retrieved. Leave empty to view all balances in your Blnk Ledger.

​
with_queued
boolean
default:"false"

Indicates whether to include the queued balance in the response.

/balances/{balance_id}?with_queued=true

curl --request GET \
  --url http://localhost:5001/balances/{balance_id} \
  --header 'Authorization: Basic <encoded-value>'

{
    "balance": 0,
    "inflight_balance": 0,
    "credit_balance": 0,
    "inflight_credit_balance": 0,
    "debit_balance": 0,
    "inflight_debit_balance": 0,
    "queued_credit_balance": 0,
    "queued_debit_balance": 0,
    "ledger_id": "ldg_049495c6-356e-4ebc-a45e-60d1e1e16afb",
    "identity_id": "",
    "balance_id": "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
    "currency": "USD",
    "created_at": "2024-11-26T08:36:36.238244338Z",
    "meta_data": null
}

​
Need help?

We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool.

To ask questions or discuss issues, please contact us or join our Discord community.

Love building with Blnk? We’d love to hear your feedback. Tell us here.

Was this page helpful?

Suggest edits