Skip to Content
BusinessChecks

Check Object

business_idstring<biz_string>required

The ID of the Business that wrote the check

Example:"biz_Pk2fNFDd8wj7EFeLWJywc7"
external_account_idstring<eac_string>required

The ID of the bank account the check was drawn on

Example:"eac_ApaM9xeQtNyVk5qpaHJbNj"
payeestringrequired

The name of the payee as written on the check

Maximum string length:255
Example:"ABC Plumbing"
amountnumberrequired

The amount of the check

Example:500
issued_atstring<date-time>required

The date the check was written and released

idstring<chk_string>required

The ID of the check

Example:"chk_WQMDNUHpBThYSNh4AprDBo"
transaction_idstring<txn_string>required

The ID of the Transaction the check posts through

Example:"txn_oiL7THC5RDi2PVUbVyyoJ"
statusenum<string>required

The status of the check

Available options:issuedclearedvoided
vendor_idstring<ven_string>

The ID of the Vendor the check was written to

Example:"ven_WQMDNUHpBThYSNh4AprDBo"
currencystring

ISO 4217 currency code of the check, the currency of its bank account

Maximum string length:3
Default:"USD"
check_numberstring

The check number, unique per bank account among checks that are not voided

Maximum string length:32
Example:"1042"
memostring

The memo written on the check

Maximum string length:512
Example:"Invoice 2231"
voided_atstring<date-time>

The date the check was voided

created_bystring

The entity that created the check

Maximum string length:255
void_transaction_idstring<txn_string>

The ID of the Transaction that reverses the check when it is voided

Example:"txn_WQMDNUHpBThYSNh4AprDBo"
cleared_atstring<date-time>

The date the bank reported the check as paid