ACH Transfer

ACH transfer object

The ACH transfer object represents the current state of a single ACH transfer originated by or received by Column. The ACH object will contain all relevant information about the specific transfer, which are described in the parameters below. Read more about ACH transfers here.

Object Parameters

account_number_id

string

ID of the account number that is sending the transfer

acknowledged_at

date-time

The timestamp at which an acknowledgement is received for a CCD or CTX ACH 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.

amount

number

Amount (in cents) of the funds that will be transferred between originator and counterparty accounts. e.g. $1.75 would be represented by 175.

bank_account_id

string

ID of the bank account that is sending the transfer

cancelled_at

date-time

The timestamp at which the transfer is cancelled

company_discretionary_data

string

This optional field allows you to include codes (one or more), of significance only to you, to enable specialized handling of the transfer. There is no standardized interpretation for the value of the field. Maximum length: 20 characters. CIE: This field may contain the Biller's name. CTX: The Originator's bank account number may be placed in this field.

company_entry_description

string

You can use this optional field to provide the Receiver with a description of the purpose of the transfer. For example, "Gas bill", "Reg. Salary", "ins. prem.", "Soc. Sec.", "DTC", "Trade Pay", "PURCHASE", etc. Default value: PAYMENT. Maximum length: 10 characters.

company_id

string

Typically, a 10-digit unique identifier used for identifying entities, called originators, sending or collecting payments via ACH credit or ACH debit. For WEB entries it can be alphanumeric and less than 10 characters. If you would like to use a specific company ID when originating ACH transactions, please contact us.

company_name

string

The name of the originator company that initiated the ACH transfer

completed_at

date-time

The timestamp at which the 60 day return window has passed for this ACH transfer, and it is officially completed

counterparty_id

string

ID of the counterparty that will receive the transfer

created_at

date-time

The timestamp at which the transfer request is created

created_by

object

The identity (API key or dashboard user) that created the ACH transfer.

id

string

ID of the entity or API key that created the resource

name

string

Name of the creator

type

string

Type of creator (e.g. api_key, user)

currency_code

string

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

description

string

Description of the transfer visible only in your platform. Maximum length: 255 characters.

effective_on

date-time

Datetime (00:00AM in Pacific Time zone) on which the transfer is effective. For incoming transfers, this is 00:00AM on the Settlement Date of the transfer in PT timezone.

entry_class_code

string

Standard Entry Class code of the transfer

entry_details

object

ACH entry details containing transaction code information

check_serial_number

string

Check serial number. Used for POP, ARC, BOC, RCK entry class codes

terminal_city

string

Terminal city. Used for POS, MTE entry class codes

terminal_id

string

Terminal identifier. Used for POS, MTE entry class codes

terminal_location

string

Terminal location. Used for POS, MTE entry class codes

terminal_state

string

Terminal state. Used for POS, MTE entry class codes

transaction_code

integer

The 2-digit numeric value from the actual ACH entry record details

transaction_code_name

string

Human-readable name of the transaction code

transaction_serial_number

string

Transaction serial number. Used for POS, MTE entry class codes

iat

object

This field provides additional IAT (International ACH Transfer) addenda information See IAT transfer sub-object.

id

string

The unique id for this object

idempotency_key

string

The idempotency key specified in the ACH transfer

initiated_at

date-time

The timestamp at which Column received your ACH request

intermediary_financial_institutions

array of objects

Applies only to IAT transfers. This is a List of intermediary institutions involved in an IAT transfer.

country_code

string

Two-letter ISO 3166-1 alpha-2 country code of the institution

identifier

string

Identifier of the intermediary financial institution (e.g., routing number or BIC)

identifier_type

string

Type of identifier. Possible values: aba, bic, iban, other

name

string

Name of the intermediary financial institution

is_incoming

boolean

Indicates whether the ACH transfer was incoming ( true ) or outgoing ( false ).

is_on_us

boolean

Indicates whether or not the ACH transfer is coming from a Column bank account. If true the request is processed immediately like a book transfer, and not sent to the Fed.

manual_review_at

date-time

The timestamp at which the ACH transfer went into the manual review state

notification_of_changes

object

Details of Notifications of Change (NOCs) with the latest information of the counterparty. Available only with ach.outgoing_transfer.noc events.

account_number

string

Latest account number of the counterparty

receiver_id

string

Latest accounting reference number by which the beneficiary should be referred by the originator

routing_number

string

Latest routing number of the counterparty

nsf_deadline

date-time

For incoming ACH Debits and available only with ach.incoming_transfer.nsf events. This is the deadline by which the receiver account must be funded to complete the incoming debit. Column will file an NSF return for this ACH transfer if the account is not funded by the nsf_deadline.

odfi_routing_number

string

The externally facing routing number for the ODFI that initiated the ACH Transfer

payment_related_info

string

Provides additional information on the ACH transfer. Limited to 80 characters for most transfer types, but CTX transfers can include up to 799,920 characters (9,999 addenda records x 80 characters each). ENR and TRX transfers may also support extended lengths.

pre_review_at

date-time

The timestamp at which the ACH transfer entered a pre-review state.

receiver_id

string

This field contains the accounting reference number by which the Receiver is known to the Originator. It is included for further identification and for descriptive purposes. For example, it may be the number shown on an invoice, statement, billhead, notice, or other communication as the reference for the Receiver to update account receivable records.

receiver_name

string

The name of the receiver, usually the name on the bank account of the Receiver. Default value: beneficiary name of the counterparty. Maximum length: 22 characters.

return_contested_at

date-time

The timestamp at which the dishonored return for this transfer was contested by the RDFI

return_details

array of objects

Details of the return processing history (e.g., initiated, dishonored, dishonor contested, manual review, etc.). Available only with ach..returned , ach..return_dishonored or ach.*.return_contested events.

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

return_dishonored_at

date-time

The timestamp at which the return for this transfer was dishonored by the ODFI

return_dishonored_funds_unlocked_at

date-time

The timestamp at which the dishonored return funds are unlocked

returned_at

date-time

The timestamp at which the ACH transfer is returned by the RDFI

reversal_pair_transfer_id

string

If the transfer is the original transfer of an ACH Reversal, this field is the unique ID of the reversal transfer. If the transfer is the reversal transfer of an ACH Reversal, this field is the unique ID of the original transfer.

reviews

array of objects

List of compliance reviews associated with the ACH transfer.

comment

string

Comment provided by the reviewer

created_at

string

Timestamp of when the review was created

decision

string

Review decision. Possible values: approved, rejected

id

string

Unique identifier of the review

reviewed_by

object

Identity of the reviewer (API key or dashboard user)

id

string

ID of the entity or API key that created the resource

name

string

Name of the creator

type

string

Type of creator (e.g. api_key, user)

updated_at

string

Timestamp of when the review was last updated

same_day

boolean

Specify if the transfer is a same-day ACH transfer. If it is set as true, it takes precedence over effective_date and overrides it.

settled_at

date-time

The timestamp at which the ACH was settled

status

string

The current state of the ACH transfer. Possible values: INITIATED, PENDING_SUBMISSION, SUBMITTED, SETTLED, RETURNED, COMPLETED, CANCELED, SCHEDULED, PENDING_RETURN, RETURN_DISHONORED, RETURN_DISHONORED_FUNDS_UNLOCKED, RETURN_CONTESTED, MANUAL_REVIEW, and MANUAL_REVIEW_APPROVED

submitted_at

date-time

The timestamp at which the ACH transfer was submitted to the Fed

trace_number

string

The unique number assigned to every ACH entry by an ODFI which identifies that entry within a specific ACH file

transaction_type_code

string

This is a required code on IAT transfers used to identify reason for payment. Possible values: ANN, BUS, DEP, LOA, MIS, MOR, PEN, REM, RLS, SAL, TAX

type

string

ACH transfer type: CREDIT or DEBIT. Learn more.

ultimate_beneficiary_counterparty_id

string

ID of the ultimate beneficiary counterparty that will receive the transfer. This is only required on outgoing IAT debits.

ultimate_originator_counterparty_id

string

ID of the ultimate originating counterparty that sent the transfer. This is only required on outgoing IAT credits.

updated_at

date-time

The timestamp at which the ACH transfer was last updated