Check return object

The check return object represents the current state of a single check return initiated by or received by Column. The check return object exposes all relevant information about the check return to developers. Read more about check returns here.

Object Parameters

ach_transfer_id

string

The id of the ACH transfer that is being returned

created_at

date-time

The timestamp at which the return was created

details

array of objects

Includes an object containing detailed information about the return

addenda

string

Optional information provided about the ACH return

created_at

date-time

The timestamp at which the ACH return is created

description

string

Description of the ACH return

return_code

string

Reason for the ACH return

status

string

Status of the ACH return

updated_at

date-time

The timestamp at which the ACH return is updated

is_incoming

boolean

Indicates if the return was initiated by an RDFI ( true ) or by Column ( false ).

status

string

The current state of the ACH return. The possible states are INITIATED, SENT, DISHONORED, CONTESTED, COMPLETED, and REJECTED

updated_at

date-time

The timestamp at which the return was updated (typically a status update)