Checks

Parameters

This page describes required and optional parameters for check print. To submit a successful request, include all required fields. Conditional fields provide additional functionality but are not necessary to initiate a request.

Required fields

Use the following table to help achieve a successful check print request:

Requiered fields
Field	Description	Minimum	Maximum	Notes
`id`	Unique identifier for the check print item.	1	99
`printType`	Specifies the template used to print checks.			Allowed values: CASHIERS ACCOUNTS_PAYABLE_6_COLUMN Default: CASHIERS
`formCode`	Form or document template code.	1	8
`checkApprovalStatus`	Approval status of the check print request.			Allowed values: SUCCESS REJECTED ERROR PENDING_CONFIRMATION PENDING_APPROVAL
`checkPrintValidationStatus`	Validation status from the export process.			Allowed values ERROR PENDING_INVESTIGATION PENDING_FUNDING SUCCESS
`checkPrintValidationErrors`	Details on validation errors.	0 items	99 items
`exportStatus`	Indicates whether the check print request is exported to the printing system.
`debtor.accountNumber`	Debtors account number.	2	17
`debtor.financialInstitutionId.id`	Debtor bank or institution ID.	1	11
`debtor.financialInstitutionId.idType`	Debtors bank or institution ID type.			Allowed values: USABA BIC SORT_CODE CLEARING_SYSTEM_ID
`debtor.financialInstitutionId.branchNumber`	Branch number of the debtor’s bank or financial institution.	1	99
`checkAmount.amount`	Check amount as a positive decimal number (string).	1	11
`checkAmount.currency`	Three‑letter ISO 4217 currency code for the check amount.	3	3
`payees.name`	Payee name.	1	40
`payees.priority`	Payee priority.	1	2
`address`	Representation of an address.			Refer to Address field details for definitions and constraints.
`delivery.courier`	Courier service used for delivery.			Allowed values: FEDEX, UPS, USPS. If USPS is selected, remaining delivery instruction fields are ignored. FedEx and UPS do not deliver to PO boxes.
`delivery.courierBillingAccountNumber`	Billing account number for the courier.	2	17
`delivery.contactPhone`	Contact phone number for delivery.	9	12
`delivery.specialHandling.deliveryAddress`	Special‑delivery address (required when `specialHandling` is present).			Refer to Address details for field definitions and constraints.
`delivery.specialHandling.companyName`	Company name for special delivery.	1	35
`delivery.specialHandling.attention`	Attention line printed above the recipient name.	0	35
`vendorId`	Vendor identification.	1	19
`clientReference`	Client‑provided reference identifier associated with the check.	1	50
`remittance.documents.description`	Descriptive lines for the remittance document.	0 items	2 items
`remittance.documents.documentDate`	Date of the remittance document (for example, the invoice date).			Must be formatted as YYYY-MM-DD.
`remittance.documents.amounts.value.value.amount`	String representation of a positive decimal number.	1	11
`remittance.documents.amounts.value.currency`	ISO 4217 alpha-3 currency code.	3	3
`remittance.documents.amounts.type`	Remittance amount type.			Allowed value: NET_AMOUNT
`remittance.remitter`	Name of the person or entity sending the payment. The name appears on remittance materials for identification.	1	40

Address fields details

The following table defines each address sub‑parameter and its required format, limits, and examples.

Address details
Field	Description	Minmum	Maximum	Notes
`addressLines`	Unstructured address lines.	1 line	3 lines	Max 3 lines; each line up to 40 characters.
`city`	City	1	35
`postalCode`	Postal or ZIP code.	1	20
`countrySubDivision`	ISO 3166‑2 subdivision code.	1	3	Use the ISO 3166‑2 code for the destination country’s first‑level administrative division (e.g., state, province, or region).
`country`	ISO 3166‑1 alpha‑2 country code.	2	2

Next steps

Learn more about the available resources for check print request.