Represent balance overdrafts and negative balances in your Ledger.
source
is required to have enough funds to execute the transaction. If Blnk detects insufficent funds, the transaction is rejected. However, there are certain transaction workflows that do not fit this default requirement.
Overdrafts is a Blnk feature that lets you successfully record a transaction regardless of the source
’s balance. When overdrafts is enabled, the transaction is processed and the balance (if insufficent) is allowed to go negative.
Learn more about how to work with negative balances
@World
.allow_overdraft
parameter and set its value to true
in your request body:
allow_overdraft
parameter is set to true without additional settings, there is no limit to how negative an account balance can go.
However, in most cases, you’ll want to define a maximum overdraft limit using the overdraft_limit
parameter.
Overdraft fields | Type | Description |
---|---|---|
allow_overdraft | Boolean | Enables overdraft functionality, allowing the account balance to go negative. |
overdraft_limit | Number | Sets the maximum overdraft amount. |
allow_overdraft
is true
:
overdraft_limit
is set to 0 or not provided, the transaction will succeed, and the balance can go negative without restriction.overdraft_limit
is greater than 0, the transaction will only succeed if the resulting negative balance does not exceed the specified limit.