Column.InternationalWires (Column v1.0.0)

Cross-border SWIFT wire transfers in 100+ currencies.

FX quote lifecycle

When sending in a foreign currency, you must first obtain and book an FX quote:

# 1. Request a quote
{:ok, quote} = Column.InternationalWires.request_fx_quote(%{
  buy_currency: "EUR",
  sell_currency: "USD",
  buy_amount: 10_000
})

# 2. Book the quote (locks the rate)
{:ok, booked} = Column.InternationalWires.book_fx_quote(quote["id"])

# 3. Create the transfer referencing the booked quote
{:ok, wire} = Column.InternationalWires.create(%{
  bank_account_id: "bacc_123",
  counterparty_id: "cpty_456",
  fx_quote_id: booked["id"],
  beneficiary_name: "Acme GmbH",
  beneficiary_iban: "DE89370400440532013000",
  beneficiary_address: %{...}
})

Tracking

Use track/2 to get SWIFT gpi status updates on outgoing transfers.

Summary

Types

id()

opts()

params()

result()

Functions

book_fx_quote(id, opts \\ [])

Book (lock) a foreign exchange quote.

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

Cancel an outgoing international wire.

cancel_fx_quote(id, opts \\ [])

Cancel a foreign exchange quote.

create(params, opts \\ [])

Create an international wire transfer.

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

Submit an amendment to an international wire.

get(id, opts \\ [])

Get an international wire transfer by ID.

get_fx_quote(id, opts \\ [])

Get a foreign exchange quote by ID.

get_fx_rate_sheet(opts \\ [])

Get the current FX rate sheet.

list(opts \\ [])

List all international wire transfers.

request_fx_quote(params, opts \\ [])

Request a foreign exchange quote.

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

Return an incoming international wire.

track(id, opts \\ [])

Track an international wire transfer via SWIFT gpi.