Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Check posting

Release check

Releases a check using the provided payload.

NOTES:

  • This endpoint requires an account token - an access token encoded with an external account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message.

This endpoint generates the following events:

See Data and reporting for more information about events and setting up event notifications.

post/corporate/v1/checks/release

Request body

check_idstring required

Check ID.

tracking_idstring

Tracking ID associated with the check release transaction.

settlement_datestring date

The settlement date defined in the settlement to be released.

<b>Notes</b>:

  • The settlement date must follow the ISO 8601 format (yyyy-mm-dd).
  • If you don't specify a date, the full check amount is released.
  • If provided, it must match the settlement date of one of the check's settlements.

Example request

{
  "check_id": "c462b2f3-55cc-42b4-ae9a-7614df3e8e72",
  "tracking_id": "1624db2e-ee81-4294-bc5e-c753b2cc5eb9",
  "settlement_date": "2025-01-06"
}

Response

Check release accepted

check_idstring required

Check ID.

Example response

{
  "check_id": "c462b2f3-55cc-42b4-ae9a-7614df3e8e72"
}