Column.ACH (Column v1.0.0)

ACH transfer origination and receipt.

Supports CREDIT and DEBIT, standard and same-day settlement. Entry class codes: PPD, CCD, WEB, TEL, POP, IAT.

Creating a credit

{:ok, transfer} = Column.ACH.create(%{
  bank_account_id: "bacc_123",
  counterparty_id: "cpty_456",
  amount: 10_000,          # in cents
  currency_code: "USD",
  type: "CREDIT",
  entry_class_code: "PPD",
  company_entry_description: "PAYROLL",
  effective_date: "2024-06-15"
})

Same-day ACH

Column.ACH.create(%{..., same_day: true})

Returns

Use create_return/2 when you receive an inbound ACH you need to reject (e.g. account frozen). reverse/2 is for reversing an ACH you originated within 5 business days.

Summary

Types

id()

opts()

params()

result()

Functions

cancel(id, opts \\ [])

Cancel an ACH transfer (only possible before it has been submitted to the network).

create(params, opts \\ [])

Create an ACH transfer (CREDIT or DEBIT).

create_positive_pay_rule(params, opts \\ [])

Create an ACH positive pay rule to block unauthorized debits.

create_return(id, params, opts \\ [])

Create an ACH return for an inbound transfer.

delete_positive_pay_rule(id, opts \\ [])

Delete an ACH positive pay rule.

get(id, opts \\ [])

Get an ACH transfer by ID.

get_positive_pay_rule(id, opts \\ [])

Get an ACH positive pay rule.

get_return(return_id, opts \\ [])

Get a specific ACH return.

list(opts \\ [])

List all ACH transfers. Supports cursor pagination and optional filters.

list_positive_pay_rules(opts \\ [])

List ACH positive pay rules.

list_returns(id, opts \\ [])

List all ACH returns for a transfer.

reverse(id, params \\ %{}, opts \\ [])

Reverse an ACH transfer you originated. Must be within 5 business days of settlement. Full amount only.