v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Check posting

Create check posting

Allow clients to post a check for a specified external account, with the option to settle the amount either immediately or in the future.

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:
- Platform authorization created
- Check posting status change

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

post/corporate/v1/checks

Request body

check_idstring required

Check ID.

settlement_type'BEGINNING' | 'END' required

Indicates when funds become available to the bank: BEGINNING or END.

business_datestring date

Specifying a business_date value impacts the account balance history.<br> <b>Notes</b>:

The business date is in ISO 8601 format.
The business date allows users to designate the balance history cycle in which a payment is posted.
You can specify a business_date within the current working day or up to one working day before or after.

descriptionstring

A brief description about a check posting transaction.

Example request

{
  "check_id": "c462b2f3-55cc-42b4-ae9a-7614df3e8e72",
  "check_amount": {
    "value": 1000.52,
    "currency": "USD"
  },
  "settlement_type": "END",
  "business_date": "2023-03-09",
  "description": "Check posting",
  "settlements": [
    {
      "type": "HOLD",
      "tracking_id": "3368328d-e4c6-4c75-99a9-9d59f3501d8c",
      "settlement_date": "2025-01-06",
      "amount": 100
    }
  ]
}

Response

Accepted. Returns the created check posting.

check_idstring required

Check ID.

Example response

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