Column.Wires (Column v1.0.0)

Copy Markdown View Source

Domestic wire transfers via Fedwire.

Same-day settlement if submitted before the daily cutoff. Supports drawdown requests (pull funds from a third party) and return request flows with approve/reject by the receiving bank.

Originating a wire

{:ok, wire} = Column.Wires.create(%{
  bank_account_id: "bacc_123",
  counterparty_id: "cpty_456",
  amount: 100_000,
  currency_code: "USD",
  message_to_beneficiary: "Invoice #1234"
})

Wire drawdown (pull funds from counterparty)

{:ok, req} = Column.Wires.create_drawdown_request(%{
  bank_account_id: "bacc_123",
  counterparty_id: "cpty_456",
  amount: 50_000,
  currency_code: "USD"
})

Summary

Functions

Approve a wire drawdown request.

Approve a wire return request.

Create a domestic wire transfer.

Create a wire drawdown request.

Create a wire return request.

Get a domestic wire transfer by ID.

Get a wire drawdown request.

Get a wire return request.

List all domestic wire transfers.

List all wire drawdown requests.

List all wire return requests.

Reverse an incoming domestic wire transfer.

Types

id()

@type id() :: String.t()

opts()

@type opts() :: keyword()

params()

@type params() :: map()

result()

@type result() :: {:ok, map()} | {:error, Column.Error.t()}

Functions

approve_drawdown_request(id, opts \\ [])

@spec approve_drawdown_request(id(), opts()) :: result()

Approve a wire drawdown request.

approve_return_request(id, opts \\ [])

@spec approve_return_request(id(), opts()) :: result()

Approve a wire return request.

create(params, opts \\ [])

@spec create(params(), opts()) :: result()

Create a domestic wire transfer.

create_drawdown_request(params, opts \\ [])

@spec create_drawdown_request(params(), opts()) :: result()

Create a wire drawdown request.

create_return_request(params, opts \\ [])

@spec create_return_request(params(), opts()) :: result()

Create a wire return request.

get(id, opts \\ [])

@spec get(id(), opts()) :: result()

Get a domestic wire transfer by ID.

get_drawdown_request(id, opts \\ [])

@spec get_drawdown_request(id(), opts()) :: result()

Get a wire drawdown request.

get_return_request(id, opts \\ [])

@spec get_return_request(id(), opts()) :: result()

Get a wire return request.

list(opts \\ [])

@spec list(opts()) :: result()

List all domestic wire transfers.

list_drawdown_requests(opts \\ [])

@spec list_drawdown_requests(opts()) :: result()

List all wire drawdown requests.

list_return_requests(opts \\ [])

@spec list_return_requests(opts()) :: result()

List all wire return requests.

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

@spec reject_return_request(id(), params(), opts()) :: result()

Reject a wire return request.

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

@spec reverse(id(), params(), opts()) :: result()

Reverse an incoming domestic wire transfer.