Request bulk settlement

This endpoint triggers the clearing of future value-dated payments and check-release operations in bulk.
A future value dated payment is a banking transaction that is scheduled to occur on a future date, such as a prepayment or normal payment. The bank is instructed to send the payment on a specific date, which can be the next day or later. When a payment is scheduled for a future date, the funds remain in the payer's account, continuing to accrue interest until the payment is settled on the scheduled date.

A check release is the process that moves funds from an uncleared or held state into the customer’s available balance. After a check is deposited, some or all of its amount remains pending until a scheduled release. When the check is released, the pending funds are applied, and the account balances are updated so that the amount becomes fully available for use.

NOTE: You can call this endpoint once with the same parameters, per division, settlement date, and operation type. If the process fails, you can retry up to 9 times per division, per business day.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Bulk settlement request body

string
enum
required

Operation type.
The maximum number of times you can call the Request bulk settlement endpoint per division per business day is 10, regardless of the operation type. For example, you can retry up to 9 times if the first call fails.

Allowed:
date
required

Future date on which the float_amount is settled. Corresponds to the cycle closing date relative to the payment date.
Notes:

  • The settlement date is in ISO 8601 format.
  • It's similar to the business_date attribute for regular payment operations.
string
required
≤ 36

Division code registered in the Create division endpoint.

string
required
≤ 60

Bulk settlement request ID provided by the requester.

Responses
202

Accepted

401

Access token is missing or invalid

403

The request has been lost

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json