Column.RealtimeTransfers (Column v1.0.0)

Instant payments via RTP (The Clearing House) and FedNow.

Realtime transfers settle in seconds, 24/7/365. Supports Request for Payment (RFP) to pull funds from a counterparty, and return request flows.

Sending a realtime payment

{:ok, transfer} = Column.RealtimeTransfers.create(%{
  bank_account_id: "bacc_123",
  counterparty_id: "cpty_456",
  amount: 25_000,
  currency_code: "USD",
  description: "Rent payment"
})

Request for Payment (RFP)

{:ok, rfp} = Column.RealtimeTransfers.create_rfp(%{
  bank_account_id: "bacc_123",
  counterparty_id: "cpty_456",
  amount: 500_00,
  currency_code: "USD",
  expiration: "2024-06-30T00:00:00Z"
})

# Counterparty accepts or rejects via their bank
Column.RealtimeTransfers.accept_rfp(rfp["id"])

Summary

Types

id()

opts()

params()

result()

Functions

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

Accept a realtime return request.

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

Accept a realtime RFP.

create(params, opts \\ [])

Create a realtime transfer.

create_return_request(params, opts \\ [])

Create a realtime return request.

create_rfp(params, opts \\ [])

Create a realtime Request for Payment.

get(id, opts \\ [])

Get a realtime transfer by ID.

get_return_request(id, opts \\ [])

Get a realtime return request.

get_rfp(id, opts \\ [])

Get a realtime RFP by ID.

list(opts \\ [])

List all realtime transfers.

list_return_requests(opts \\ [])

List all realtime return requests.

list_rfps(opts \\ [])

List all realtime RFPs.

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

Reject a realtime return request.

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

Reject a realtime RFP.

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

Return an incoming realtime transfer.