TransferACH

Create an ACH transfer

Creates an ACH transfer between an account and a counterparty.

post/transfers/ach

Request

  • Base URL: https://api.column.com
  • URL: https://api.column.com/transfers/ach
  • Auth: HTTP basic

Headers

Idempotency-Keystring

Idempotency keys can be up to 255 characters long and are case sensitive. Column reserves the right to expire idempotency keys after 30 days. Only ASCII printable characters (code 32 - 126) are allowed for idempotency keys.

Request body

account_number_idstring

ID of the account number from which the transfer is sent. If no account_number_id is specified, the default account number on a provided bank_account_id is used. account_number_id or bank_account_id is required.

allow_overdraftboolean

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.

amountinteger

Amount (in cents) of the funds that will be transferred between originator and counterparty accounts. e.g. $1.75 would be represented by 175. A 0 amount creates a non-monetary entry: with payment_related_info on a CCD/CTX credit it is a zero-dollar remittance (transaction code 24/34); without payment_related_info it is a prenotification (prenote, transaction codes 23/28/33/38) used to validate the counterparty account before live entries. Both require the corresponding feature to be enabled for your platform, and prenotes are not supported for IAT. A non-monetary entry requires an explicit 0; omitting the field is invalid.

bank_account_idstring

ID of the bank account from which the transfer is sent. If no account_number_id is specified, the default account number on the bank_account_id is used. account_number_id or bank_account_id is required.

company_discretionary_datastring

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.

company_entry_descriptionstring

You can use this optional field to provide the Receiver with a description of the purpose of the transfer. Default value: PAYMENT. Maximum length: 10 characters.

company_namestring

This optional field identifies the source of the transfer and is used for descriptive purposes for the Receiver. Default value: the root entity name of your platform, or "COLUMN NA" if no root entity exists. Maximum length: 16 characters.

counterparty_idstring

ID of the counterparty that will receive the transfer. Either counterparty or counterparty_id is required.

currency_codestring required

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

descriptionstring

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

effective_datestring

Date (format: YYYY-MM-DD ) on which the transfer will be effective

entry_class_codestring required

Standard Entry Class code of the transfer. Valid values: CCD, CTX, CIE, PPD, TEL, WEB.

holdboolean

Create the transfer held instead of submitting it. Nothing is batched or sent until it is cleared; the effective date and same-day eligibility are decided when the transfer is cleared. For credits the amount is locked out of the available balance while held; a held debit locks nothing, since an outgoing debit pulls funds in at settlement.

intermediate_financial_institutionsobject[]

List of intermediary financial institutions involved in an IAT (International ACH Transaction) transfer.

payment_related_infostring

Provides an additional 80 characters to give details on the ACH transaction for outgoing transfers. This information will be surfaced to the RDFI.

receiver_idstring

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. Maximum length: 15 characters.

receiver_namestring

The name of the receiver, usually the name on the bank account of the Receiver. If omitted, counterparty.name will be automatically used. Default value: beneficiary name of the counterparty. Maximum length: 22 characters for all entry class codes except CIE it is 15 characters.

same_dayboolean

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.

transaction_type_codestring

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.

typestring required

ACH transfer type: CREDIT or DEBIT. Learn more.

ultimate_beneficiary_counterparty_idstring

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

ultimate_originator_counterparty_idstring

ID of the ultimate originating counterparty that will sent the transfer. This is only required on outgoing IAT credits. Either ultimate_originator_counterparty or ultimate_originator_counterparty_id is required.

Response

Successful response

account_number_idstring required

ID of the account number that is sending the transfer

ach_transfer_batch_idstring nullable

ID of the ACH transfer batch this transfer belongs to.

acknowledged_atstring date-time nullable required

The timestamp at which an acknowledgement is received for a CCD or CTX ACH transfer.

allow_overdraftboolean required

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.

amountinteger required

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_idstring required

ID of the bank account that is sending the transfer

cancelled_atstring date-time nullable required

The timestamp at which the transfer is cancelled

company_discretionary_datastring required

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_descriptionstring required

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_idstring required

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_namestring required

The name of the originator company that initiated the ACH transfer

completed_atstring date-time nullable required

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

counterparty_idstring required

ID of the counterparty that will receive the transfer

created_atstring date-time required

The timestamp at which the transfer request is created

currency_codestring required

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

descriptionstring required

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

effective_onstring date-time required

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_codestring required

Standard Entry Class code of the transfer

entry_detailsobject nullable required

ACH entry details containing transaction code information

hold_atstring date-time nullable

The timestamp at which the ACH transfer was placed on hold.

idstring required

The unique id for this object

idempotency_keystring required

The idempotency key specified in the ACH transfer

initiated_atstring date-time nullable required

The timestamp at which Column received your ACH request

intermediary_financial_institutionsobject[] required

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

is_incomingboolean required

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

is_on_usboolean required

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_atstring date-time nullable required

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

nsf_deadlinestring date-time nullable required

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_numberstring required

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

payment_related_infostring required

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_atstring date-time

The timestamp at which transfer approval became required for the ACH transfer.

receiver_idstring required

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_namestring required

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_atstring date-time nullable required

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

return_dishonored_atstring date-time nullable required

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

return_dishonored_funds_unlocked_atstring date-time nullable required

The timestamp at which the dishonored return funds are unlocked

returned_atstring date-time nullable required

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

reversal_pair_transfer_idstring required

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.

same_dayboolean required

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_atstring date-time nullable required

The timestamp at which the ACH was settled

status'INITIATED' | 'PRE_REVIEW' | 'HOLD' | 'PENDING_SUBMISSION' | 'SUBMITTED' | 'SETTLED' | 'RETURNED' | 'COMPLETED' | 'CANCELED' | 'SCHEDULED' | 'PENDING_RETURN' | 'RETURN_DISHONORED' | 'RETURN_DISHONORED_FUNDS_UNLOCKED' | 'RETURN_CONTESTED' | 'MANUAL_REVIEW' | 'MANUAL_REVIEW_APPROVED' required

The current state of the ACH transfer. Possible values: PRE_REVIEW, INITIATED, HOLD, 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_atstring date-time nullable required

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

trace_numberstring required

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

transaction_type_codestring required

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.

typestring required

ACH transfer type: CREDIT or DEBIT. Learn more.

ultimate_beneficiary_counterparty_idstring required

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

ultimate_originator_counterparty_idstring required

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

updated_atstring date-time required

The timestamp at which the ACH transfer was last updated

Example response

{
  "iat": {
    "foreign_correspondent_bank_info": [
      {
        "branch_country_code": "branch_country_code",
        "identification_number": "identification_number",
        "identification_number_qualifier": "identification_number_qualifier",
        "name": "name"
      }
    ],
    "foreign_payment_amount": 11500,
    "foreign_trace_number": "",
    "odfi_branch_country_code": "IE",
    "odfi_identification": "02800008",
    "odfi_identification_number_qualifier": "01",
    "odfi_name": "CITIBANK EUROPE PLC",
    "originator_city_state_province": "LONDON*GB\\",
    "originator_country_postal_code": "REDACTED",
    "originator_name": "REDACTED",
    "originator_street_address": "REDACTED",
    "payment_related_info": [],
    "rdfi_branch_country_code": "US",
    "rdfi_identification": "REDACTED",
    "rdfi_identification_number_qualifier": "01",
    "rdfi_name": "COLUMN N.A.",
    "receiver_city_state_province": "x\\",
    "receiver_country_postal_code": "US*74110\\",
    "receiver_identification_number": "REDACTED",
    "receiver_street_address": "REDACTED",
    "receiving_company_or_individual_name": "REDACTED",
    "transaction_type_code": "BUS"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.