Waterfall transfers

Initiates a batch of internal fund transfers arranged in a waterfall sequence. Each payment in the batch is executed in priority order, 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.

SecurityoAuth2
Request
header Parameters
Idempotent-Key
required
string <uuid>

Idempotency key to ensure the payment is processed only once.

Example: 123e4567-e89b-12d3-a456-426614174000
Request Body schema: application/json
required

Waterfall transfers Request fields

externalReferenceId
string <= 200 characters ^[a-zA-Z0-9 ]+$

Unique reference id from a system outside of finzly.

deliveryDate
required
string <date>

Requested date for transfer processing

required
Array of objects (WaterfallTransferRequest_payments)

List of individual payments in the batch

Responses
200

Waterfall Transfers processed successfully

400

Invalid request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

503

Service unavailable

post/waterfall-payments/api/v1/transfers
Request samples
application/json
{
  • "externalReferenceId": "wf-20250716-279514",
  • "deliveryDate": "0015-02-15",
  • "payments": [
    ]
}
Response samples
application/json
{
  • "batchId": "string"
}