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
stringID of the account number that is sending the transfer
acknowledged_at
date-timeThe timestamp at which an acknowledgement is received for a CCD or CTX ACH transfer.
allow_overdraft
booleanAllow 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
numberAmount (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
stringID of the bank account that is sending the transfer
cancelled_at
date-timeThe timestamp at which the transfer is cancelled
company_discretionary_data
stringThis 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
stringYou 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
stringTypically, 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
stringThe name of the originator company that initiated the ACH transfer
completed_at
date-timeThe timestamp at which the 60 day return window has passed for this ACH transfer, and it is officially completed
counterparty_id
stringID of the counterparty that will receive the transfer
created_at
date-timeThe timestamp at which the transfer request is created
created_by
objectThe identity (API key or dashboard user) that created the ACH transfer.
id
stringID of the entity or API key that created the resource
name
stringName of the creator
type
stringType of creator (e.g. api_key, user)
currency_code
stringThe three-letter currency code defined in ISO 4217. e.g. USD.
description
stringDescription of the transfer visible only in your platform. Maximum length: 255 characters.
effective_on
date-timeDatetime (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
stringStandard Entry Class code of the transfer
entry_details
objectACH entry details containing transaction code information
check_serial_number
stringCheck serial number. Used for POP, ARC, BOC, RCK entry class codes
terminal_city
stringTerminal city. Used for POS, MTE entry class codes
terminal_id
stringTerminal identifier. Used for POS, MTE entry class codes
terminal_location
stringTerminal location. Used for POS, MTE entry class codes
terminal_state
stringTerminal state. Used for POS, MTE entry class codes
transaction_code
integerThe 2-digit numeric value from the actual ACH entry record details
transaction_code_name
stringHuman-readable name of the transaction code
transaction_serial_number
stringTransaction serial number. Used for POS, MTE entry class codes
iat
objectThis field provides additional IAT (International ACH Transfer) addenda information See IAT transfer sub-object.
id
stringThe unique id for this object
idempotency_key
stringThe idempotency key specified in the ACH transfer
initiated_at
date-timeThe timestamp at which Column received your ACH request
intermediary_financial_institutions
array of objectsApplies only to IAT transfers. This is a List of intermediary institutions involved in an IAT transfer.
country_code
stringTwo-letter ISO 3166-1 alpha-2 country code of the institution
identifier
stringIdentifier of the intermediary financial institution (e.g., routing number or BIC)
identifier_type
stringType of identifier. Possible values: aba, bic, iban, other
name
stringName of the intermediary financial institution
is_incoming
booleanIndicates whether the ACH transfer was incoming ( true ) or outgoing ( false ).
is_on_us
booleanIndicates 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-timeThe timestamp at which the ACH transfer went into the manual review state
notification_of_changes
objectDetails of Notifications of Change (NOCs) with the latest information of the counterparty. Available only with ach.outgoing_transfer.noc events.
account_number
stringLatest account number of the counterparty
receiver_id
stringLatest accounting reference number by which the beneficiary should be referred by the originator
routing_number
stringLatest routing number of the counterparty
nsf_deadline
date-timeFor 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
stringThe externally facing routing number for the ODFI that initiated the ACH Transfer
payment_related_info
stringProvides 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-timeThe timestamp at which the ACH transfer entered a pre-review state.
receiver_id
stringThis 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
stringThe 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-timeThe timestamp at which the dishonored return for this transfer was contested by the RDFI
return_details
array of objectsDetails 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
stringOptional information provided about the ACH return
created_at
date-timeThe timestamp at which the ACH return is created
description
stringDescription of the ACH return
return_code
stringReason for the ACH return
status
stringStatus of the ACH return
updated_at
date-timeThe timestamp at which the ACH return is updated
return_dishonored_at
date-timeThe timestamp at which the return for this transfer was dishonored by the ODFI
return_dishonored_funds_unlocked_at
date-timeThe timestamp at which the dishonored return funds are unlocked
returned_at
date-timeThe timestamp at which the ACH transfer is returned by the RDFI
reversal_pair_transfer_id
stringIf 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 objectsList of compliance reviews associated with the ACH transfer.
comment
stringComment provided by the reviewer
created_at
stringTimestamp of when the review was created
decision
stringReview decision. Possible values: approved, rejected
id
stringUnique identifier of the review
reviewed_by
objectIdentity of the reviewer (API key or dashboard user)
id
stringID of the entity or API key that created the resource
name
stringName of the creator
type
stringType of creator (e.g. api_key, user)
updated_at
stringTimestamp of when the review was last updated
same_day
booleanSpecify 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-timeThe timestamp at which the ACH was settled
status
stringThe 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-timeThe timestamp at which the ACH transfer was submitted to the Fed
trace_number
stringThe unique number assigned to every ACH entry by an ODFI which identifies that entry within a specific ACH file
transaction_type_code
stringThis 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
stringACH transfer type: CREDIT or DEBIT. Learn more.
ultimate_beneficiary_counterparty_id
stringID of the ultimate beneficiary counterparty that will receive the transfer. This is only required on outgoing IAT debits.
ultimate_originator_counterparty_id
stringID of the ultimate originating counterparty that sent the transfer. This is only required on outgoing IAT credits.
updated_at
date-timeThe timestamp at which the ACH transfer was last updated