Column.Counterparties (Column v1.0.0)

Copy Markdown View Source

External party management for ACH, wire, and international payments.

Counterparties store routing number, account number, name, and optionally an IBAN for international payments.

Example

{:ok, cpty} = Column.Counterparties.create(%{
  routing_number: "121000248",
  account_number: "000123456789",
  account_type: "checking",
  name: "Jane Smith"
})

{:ok, _} = Column.Counterparties.validate_iban("DE89370400440532013000")

Summary

Types

id()
opts()
params()
result()

Functions

create(params, opts \\ [])

Create a counterparty.

delete(id, opts \\ [])

Delete a counterparty.

get(id, opts \\ [])

Get a counterparty by ID.

get_financial_institution(routing_number, opts \\ [])

Get a financial institution by routing number.

list(opts \\ [])

List all counterparties. Supports cursor pagination.

list_financial_institutions(opts \\ [])

List financial institutions (routing number search).

validate_iban(iban, opts \\ [])

Validate an IBAN.

Types

id()

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

opts()

@type opts() :: keyword()

params()

@type params() :: map()

result()

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

Functions

create(params, opts \\ [])

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

Create a counterparty.

delete(id, opts \\ [])

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

Delete a counterparty.

get(id, opts \\ [])

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

Get a counterparty by ID.

get_financial_institution(routing_number, opts \\ [])

@spec get_financial_institution(String.t(), opts()) :: result()

Get a financial institution by routing number.

list(opts \\ [])

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

List all counterparties. Supports cursor pagination.

list_financial_institutions(opts \\ [])

@spec list_financial_institutions(opts()) :: result()

List financial institutions (routing number search).

validate_iban(iban, opts \\ [])

@spec validate_iban(String.t(), opts()) :: result()

Validate an IBAN.