Skip to main content
POST
/
balances
Create new balance
curl --request POST \
  --url http://localhost:5001/balances \
  --header 'X-blnk-key: <api-key>'
Use blnk.LedgerBalances.create to create a balance on an existing ledger.
blnk.LedgerBalances.create
const response = await blnk.LedgerBalances.create({
  ledger_id: 'ldg_049495c6-356e-4ebc-a45e-60d1e1e16afb',
  currency: 'USD',
});
FieldDescription
ledger_idLedger the balance belongs to.
currencyCurrency or asset class for the balance.
identity_idIdentity to link to the balance. Required when track_fund_lineage is true.
track_fund_lineageEnable fund lineage tracking on this balance.
allocation_strategyHow tagged provider funds are allocated on spend: FIFO, LIFO, or PROPORTIONAL.
meta_dataOptional metadata for extra context.

​
Response shape

201 Created
{
  "balance": 0,
  "inflight_balance": 0,
  "credit_balance": 0,
  "inflight_credit_balance": 0,
  "debit_balance": 0,
  "inflight_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
}
FieldDescription
balance_idUnique ID for the balance. Use as source or destination on transactions.
ledger_idLedger ID you passed in the request.
currencyCurrency you passed in the request.
balanceCurrent net amount in the balance.
created_atDate and time the balance was created.

View balance docs

Balance concepts and setup.

Create new balance

HTTP request and response schema.

​
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.