Check transfer object

The check transfer object represents the current state of a single check transfer initiated by or received by Column. Check transfers are used to send and receive money over Check 21-Enabled services. The check transfer object exposes all relevant information about the check transfer to developers. Read more about check transfers here.

Object Parameters

account_number_id

string

ID of the account number that is sending the transfer

allow_overdraft

boolean

Allow the account to go negative for the transfer. The bank account needs to have is_overdraftable enabled with an overdraft reserve account linked to it.

attachment_document_id

string

ID of the document attached to this check transfer.

back_image

string

Base 64 encoded TIFF image of the back of the deposited check image. This field is not populated in the check transfer object until after the check is deposited.

bank_account_id

string

ID of the bank account that is sending the transfer

check_number

number

Sequence number of the check

created_at

date-time

Date (format: YYYY-MM-DD ) on which the check was created.

currency_code

string

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

delivered_by_column

boolean

For an issued check, whether this check is also mailed and delivered by Column

delivery_method

string

The delivery method for checks delivered by Column. Can be one of usps_first_class, fedex_two_day, or fedex_overnight. Defaults to usps_first_class.

delivery_status

string

The current delivery status for checks delivered by Column. Possible statuses are created, rendered_pdf, mailed, in_transit, in_local_area, processed_for_delivery, delivered, failed, rerouted, and returned_to_sender

delivery_tracking_number

string

The tracking number for this check, if an expedited delivery_method is used.

delivery_tracking_url

string

A URL to track check delivery, if an expedited delivery_method is used.

deposited_amount

integer

Amount (in cents) of the funds that are deposited. e.g. $1.75 would be represented by 175

deposited_at

date-time

Date (format: YYYY-MM-DD ) on which the check is deposited (applies only to check deposited at Column).

description

string

A description of the transfer visible in account statements

external_routing_number

string

For an issued check, this is the routing number of the bank of first deposit

extracted_payee_name

string

The payee name extracted from the ICL file supplied by the bank of first deposit (for Column issued checks only). This can be compared to the payee name on the issued check to detect fraudulently altered checks. Not guaranteed to be accurate.

first_return_at

date-time

Date (format: YYYY-MM-DD ) on which the check is returned for the first time.

front_image

string

Base 64 encoded TIFF image of the front of the deposited check image. This field is not populated in the check transfer object until after the check is deposited.

id

string

The unique ID of the object

idempotency_key

string

The idempotency key specified in the check transfer

is_preview_pdf_available

boolean

For a check delivered by Column, whether the preview PDF is ready to be downloaded

issued_at

date-time

Date (format: YYYY-MM-DD ) at which the check was issued.

manual_review_at

date-time

Date (format: YYYY-MM-DD ) at which the check transfer went into manual review.

memo

string

Memo on the check. Only available for checks delivered by Column.

message

string

Message to the payee. Only available for checks delivered by Column.

micr_line

object

The MICR line is the sequence of numbers and characters at the bottom of a check

amount_field

string

Amount field (up to 10 characters)

auxiliary_on_us

string

Auxiliary on-us field (up to 15 characters)

external_processing_code

string

External processing code (up to 1 character)

on_us

string

On-us field (up to 20 characters)

payor_bank_routing_number

string

Payor bank ABA routing number (up to 9 characters)

payee_address

object

The receiving address of the check. Only available for checks delivered by Column.

city

string

City name

country_code

string

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

line_1

string

Street address line 1

line_2

string

Street address line 2

postal_code

string

Postal or ZIP code

state

string

State or province

payee_company

string

Company name of the payee. Only available for checks delivered by Column.

payee_name

string

The name of the person who is receiving the check

pending_deposit_at

date-time

Date (format: YYYY-MM-DD ) on which the check was pending deposit.

pending_first_return_at

date-time

Date (format: YYYY-MM-DD ) on which the check was pending first return.

pending_stop_at

date-time

Date (format: YYYY-MM-DD ) on which the check was stopped.

pending_user_initiated_return_at

date-time

Date (format: YYYY-MM-DD ) on which the user initiates the return.

positive_pay_amount

integer

Amount (in cents) of the issued check that will be used in positive pay validation if account number is provided. e.g. $1.75 would be represented by 175.

reclear_at

date-time

Date (format: YYYY-MM-DD ) on which the check was recleared.

rejected_at

date-time

Date (format: YYYY-MM-DD ) on which the check was rejected.

returned_at

date-time

Date (format YYYY-MM-DD) on which the check was returned

returns

array of objects

List of check returns associated with the check transfer

cancelled_at

date-time

Date (format: YYYY-MM-DD ) on which the check return was cancelled.

check_transfer_id

string

ID of the check transfer that has been returned

created_at

date-time

Date (format: YYYY-MM-DD ) on which the check return was created.

id

string

The unique id of the check return object

pending_review_at

date-time

Date (format: YYYY-MM-DD ) on which the check return was flagged for review.

processed_at

date-time

Date (format: YYYY-MM-DD ) on which the check return was processed.

return_reason

string

The reason for which the check was returned

status

string

The current status of the check return. Possible statuses are scheduled and processed

updated_at

date-time

The timestamp at which the check return was last updated

second_return_at

date-time

Date (format: YYYY-MM-DD ) on which the check was returned for the second time.

settled_at

date-time

Date (format: YYYY-MM-DD ) on which the check was settled.

status

string

The current status of the check transfer. Possible statuses are initiated, issued, manual_review, rejected, pending_deposit, pending_stop, deposited, stopped, pending_first_return, pending_second_return, first_return, pending_reclear, recleared, second_return, settled, returned, pending_user_initiated_return, user_initiated_return_submitted, user_initiated_returned, and pending_user_initiated_return_dishonored

stopped_at

date-time

Date (format: YYYY-MM-DD ) on which funds locked for a check in a pending_stop state are made available.

transfer_batch_id

string

ID of the transfer batch this check belongs to.

type

string

Check transfer type. For checks deposited at Column, this is credit. For checks issued by Column and deposited at another FI, this is debit. Learn more here.

updated_at

date-time

The timestamp at which the Check transfer was last updated

user_initiated_return_dishonored_at

date-time

Date (format: YYYY-MM-DD ) on which the user initiated return is dishonored.

user_initiated_return_submitted_at

date-time

Date (format: YYYY-MM-DD ) on which the user initiated return is submitted to the Fed.

user_initiated_returned_at

date-time

Date (format: YYYY-MM-DD ) on which the user initiated return is completed.

void_date

string

Date the check is automatically voided