Initiates a batch of internal fund transfers arranged in a waterfall sequence.
Each payment in the batch is executed in priority order defined by its paymentIndex
,
where funds flow from the debtor to the creditor specified in each payment. The waterfall design
allows funds to cascade through multiple accounts sequentially within the bank.
Note: This API is restricted to use by authorized financial institutions only.
Waterfall transfers Request fields
Waterfall transfers processed successfully
Bad Request
Unauthorized
Forbidden
Not Found – The requested resource could not be located. Verify the endpoint or resource identifier.
Method Not Allowed – HTTP method used is not supported by the requested resource.
Conflict
Internal Server
Service Unavailable – The server is temporarily unable.
{- "externalReferenceId": "wf-20250716-279514",
- "payments": [
- {
- "paymentIndex": 1,
- "paymentAmount": 10000,
- "paymentNotes": "First waterfall payment",
- "debtorAccount": {
- "accountNumber": "123452334",
- "accountType": "Deposit",
- "accountSubType": "Checking",
- "routingNumber": "022300173"
}, - "creditorAccount": {
- "accountNumber": "123452334",
- "accountType": "Deposit",
- "accountSubType": "Checking",
- "routingNumber": "022300173"
}
}
]
}
{- "waterfallId": "8f4eb852-972b-4568-9613-2a45f184d791"
}