Issue a check

POST/transfers/checks/issue

Issue a check to a specific payee for a given amount. If mail_check_request is included, the check will be delivered by Column too.

Body Parameters

account_number_id

stringOptional

Optional. If omitted, defaults to the default account number ID for the provided bank account. Exactly one of bank_account_id or account_number_id must be provided.

allow_overdraft

booleanRequired

Allow the account to go negative for the transfer.

bank_account_id

stringOptional

bank account ID to debit funds from. Exactly one of bank_account_id or account_number_id must be provided.

currency_code

stringRequired

The three-letter currency code defined in ISO 4217. e.g. USD.

customized_check_number

numberOptional

Custom check number to use instead of the auto-generated one.

description

stringRequired

A description of the check transfer.

mail_check_request

objectOptional

Request details for mailing the check to a recipient address.

attachment_document_id

stringRequired

ID of a document to include as an attachment with the mailed check.

courtesy_of

stringRequired

Name of the person or organization sending the check on behalf of the payor.

delivery_method

stringOptional

Delivery method for the check. Possible values: usps_first_class, usps_priority, ups_next_day

memo

stringRequired

Memo line text to print on the check.

message

stringRequired

Message to the payee

payee_address

objectRequired

The mailing address of the payee where the check will be sent.

city

stringRequired

City name

country_code

stringRequired

Two-letter ISO 3166-1 alpha-2 country code (e.g. US)

line_1

stringRequired

Street address line 1

line_2

stringOptional

Street address line 2

postal_code

stringOptional

Postal or ZIP code

state

stringOptional

State or province

payee_company

stringRequired

Company name of the payee, if applicable.

payor_address

objectRequired

The return address of the payor to print on the check envelope.

city

stringRequired

City name

country_code

stringRequired

Two-letter ISO 3166-1 alpha-2 country code (e.g. US)

line_1

stringRequired

Street address line 1

line_2

stringOptional

Street address line 2

postal_code

stringOptional

Postal or ZIP code

state

stringOptional

State or province

payor_name

stringRequired

Name of the payor to print on the check.

signatory

stringRequired

Name of the signatory to print on the check.

payee_name

stringRequired

Name of the person or entity the check is payable to.

positive_pay_amount

integerRequired

Optional. If provided, Column will perform positive-pay validation.

void_date

stringOptional

Date the check is automatically voided. Must be a future date. Interpreted as Pacific Time.