Skip to main content

Conditional Transfer

POST /v1/transfers/conditional

A conditional transfer only executes if the debit account has at least a minimum balance after the transfer.

Use this when you need to ensure the sender retains a minimum balance, like a reserve requirement.

Request

{
"debit_account_id": "ba9755d7e835cdeea6bca803721c7eba",
"credit_account_id": "19d64e32e2da3c3dbd1ebaba9860ab9",
"amount": 50000,
"minimum_balance": 10000,
"ledger": 1001,
"code": 100
}
FieldRequiredDescription
minimum_balanceYesDebit account must retain at least this amount after the transfer

How it works

If the debit account has 60,000 and you transfer 50,000 with a minimum balance of 10,000, it succeeds. The account ends with 10,000.

If the debit account has 55,000, it fails. Transferring 50,000 would leave 5,000, which is below the 10,000 minimum.

Response 201

Same as a regular transfer with status: "posted".

Errors

CodeTypeMeaning
422insufficient_fundsBalance after transfer would be below minimum