v1

latestOpenAPI 3.1.02026-07-261520561.4 KB

Check Issuing

Update an Issued Check

patch/check/{id}

Path parameters

idstring required

Unique identifier for object

Request body

statusstring

New status of check, one of: canceled, stop_payment

Response

The check updated

account_idstring

ID of the Account issuing the check. Filterable.

amountstring

Amount of money to transfer, with two decimal precision

bank_idstring

ID of the bank with which the object is associated

check_datestring

Date on which the check was issued

check_numberstring

The number printed on the issued check. Check numbers are automatically generated after check object creation

delivery_methodstring

Delivery options for sending the check with the default being standard USPS shipping. For USPS First Class, Overnight, Two Day, and USPS Certified delivery options please contact support to ensure your account is properly configured for sending through those methods.

errorstring

An error message of why the check is in error status.

idstring

Unique identifier for object

memostring

Optional text to include on the memo line of the check (max of 40 characters)

messagestring

Optional text to include on the bottom of the check page (maximum of 400 characters)

org_idstring

ID of the organization with which the object is associated. Filterable.

signatory_namestring

The name of the person or entity being used as the signatory on this check

statusstring

Status of check. Filterable.

userdataobject

Arbitrary data the user can attach to the object