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:

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

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

Check posting request body

Request body for posting a check transaction.

string
required
length between 1 and 60
^[a-zA-Z0-9-]+$

Check ID.

check_amount
object
required

Total check amount.

string
enum
required

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

Allowed:
date

Specifying a business_date value impacts the account balance history.
Notes:

  • 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.
string
length ≤ 100

A brief description about a check posting transaction.

settlements
array of objects
required

List of check settlements. Each settlement represents a portion of the check amount to be settled on a specific date, with an associated type and tracking identifier.

settlements*
Responses

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