Skip to main content
POST
If you’re using the auto-provisioned Enterprise Core instance included with your Production License deployment, set the base URL to: https://ENTERPRISE_PUBLIC_URL/core.If you’re connecting to a different Core instance, use the publicly accessible base URL for that instance instead.

​
Authorization

If set, the API uses an API key for authentication. Include the following header in your requests: X-blnk-key: <api-key>. Replace <api-key> with your secret API key. Ensure the key is kept secure and not exposed in public repositories or client-side code. See also: Scoped API keys and Secure your Blnk server.

​
Body

​
string
required
Unique id of the ledger the balance is created in.
​
string
required
The currency/asset class of this balance. See the following: Currencies
​
string
Unique id of identity (if any) to be linked to the balance. Can be left out from the request body if there’s no identity to be linked.
​
boolean
default:"false"
Enables fund lineage tracking on this balance.
Fund lineage requires identity_id.
​
string
default:"FIFO"
Controls how Blnk allocates tagged provider funds when spending from this balance.Supported values: FIFO, LIFO, PROPORTIONAL.
​
object
Additional metadata for the request body.

​
Response

​
integer
required
The net amount being stored in the balance.
​
integer
required
The net amount waiting to be moved into or out of the balance.
​
integer
required
Total amount moved into the balance
​
integer
required
Total amount waiting to be moved into the balance.
​
integer
required
Total amount moved out of the balance.
​
integer
required
Total amount waiting to be moved out of the balance.
​
string
required
Unique id of the ledger the balance is created in.
​
string
Unique id of the identity (if any) linked to this balance.
​
string
required
Unique id of the created balance.
​
string
required
The currency/asset class of the balance.
​
string
required
Indicates the date & time of creation.
​
User Object
Additional metadata of the balance.
​
boolean
Indicates whether fund lineage tracking is enabled for this balance.
​
string
The allocation strategy used for fund lineage spending when track_fund_lineage is enabled.

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