Column.Checks (Column v1.0.0)

Check issuance and remote deposit capture.

Issue a check (Column prints and mails)

{:ok, check} = Column.Checks.issue(%{
  bank_account_id: "bacc_123",
  amount: 50_000,
  currency_code: "USD",
  payee_name: "Jane Smith",
  memo: "Invoice #999",
  mailing_address: %{
    line_1: "456 Oak Ave",
    city: "Austin",
    state: "TX",
    postal_code: "78701"
  }
})

# Preview before issuing
{:ok, pdf_bytes} = Column.Checks.get_preview(check["id"])

Deposit a check (remote deposit capture)

{:ok, deposit} = Column.Checks.deposit(%{
  bank_account_id: "bacc_456",
  amount: 10_000,
  currency_code: "USD"
})
Column.Checks.capture_front(deposit["id"], "/tmp/check_front.jpg")
Column.Checks.capture_back(deposit["id"], "/tmp/check_back.jpg")

Summary

Types

id()

opts()

params()

result()

Functions

capture_back(id, file_path, opts \\ [])

Upload the back image of a check deposit.

capture_front(id, file_path, opts \\ [])

Upload the front image of a check deposit.

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

Create a return for a check transfer.

deposit(params, opts \\ [])

Initiate a check deposit (remote deposit capture).

get(id, opts \\ [])

Get a check transfer by ID.

get_preview(id, opts \\ [])

Get a PDF preview of an issued check.

get_returns(id, opts \\ [])

Get returns for a check transfer.

issue(params, opts \\ [])

Issue a check (Column prints and mails it).

list(opts \\ [])

List all check transfers.

list_returns(opts \\ [])

List all check returns across all check transfers.

stop(id, opts \\ [])

Stop a check transfer.