Bulk settlement

Request bulk settlement

This endpoint triggers the clearing of future value-dated payments and check-release operations in bulk.<br> 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.

<b>NOTE</b>: 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.

post/corporate/v1/bulk-settlement

Request

  • Base URL
    https://sandbox.pismolabs.io
  • URL
    https://sandbox.pismolabs.io/corporate/v1/bulk-settlement
  • Auth
    HTTP bearer

Request body

operation_type'future-dated' | 'check-release' required

Operation type.<br> 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.

settlement_datestring date required

Future date on which the float_amount is settled. Corresponds to the cycle closing date relative to the payment date.<br> <b>Notes</b>:

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

Division code registered in the Create division endpoint.

bulk_idstring required

Bulk settlement request ID provided by the requester.

Example request

{
  "operation_type": "check-release",
  "settlement_date": "2023-03-09",
  "division_code": "US",
  "bulk_id": "0a50c88a-ade8-4bcc-a639-9a0b0f11e244"
}

Response

Accepted

Changes

No recorded changes to this operation across all 1 revision of this API.