Column.LoanPayments (Column v1.0.0)

Copy Markdown View Source

Loan payment collection and return handling.

Creating a payment

{:ok, payment} = Column.LoanPayments.create(%{
  loan_id: "loan_123",
  bank_account_id: "bacc_456",
  amount: 15_000,
  currency_code: "USD"
})

Returning a failed payment

{:ok, _} = Column.LoanPayments.return(payment["id"], %{
  return_reason: "R01"
})

Summary

Functions

Create a loan payment.

Get a loan payment by ID.

List all loan payments.

Return a loan payment.

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 loan payment.

get(id, opts \\ [])

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

Get a loan payment by ID.

list(opts \\ [])

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

List all loan payments.

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

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

Return a loan payment.