Increase.RealTimePaymentsTransfers (Increase v1.0.0)

Real-Time Payments transfers move funds, within seconds, between your Increase account and any other account on the Real-Time Payments network.

See https://increase.com/documentation/api/real-time-payments-transfers for the full API reference for this resource.

Summary

Functions

approve(client, real_time_payments_transfer_id, opts \\ [])

Approves a Real-Time Payments Transfer in a pending_approval state.

cancel(client, real_time_payments_transfer_id, opts \\ [])

Cancels a Real-Time Payments Transfer in a pending_approval state.

create(client, params \\ %{}, opts \\ [])

Create a Real-Time Payments Transfer

list(client, params \\ %{}, opts \\ [])

List Real-Time Payments Transfers

retrieve(client, real_time_payments_transfer_id, opts \\ [])

Retrieve a Real-Time Payments Transfer

Functions

approve(client, real_time_payments_transfer_id, opts \\ [])

@spec approve(Increase.Client.t() | keyword() | nil, String.t(), keyword()) ::
  {:ok, Increase.RealTimePaymentsTransfers.RealTimePaymentsTransfer.t()}
  | {:error, Increase.Error.t()}

Approves a Real-Time Payments Transfer in a pending_approval state.

POST /real_time_payments_transfers/{real_time_payments_transfer_id}/approve

cancel(client, real_time_payments_transfer_id, opts \\ [])

@spec cancel(Increase.Client.t() | keyword() | nil, String.t(), keyword()) ::
  {:ok, Increase.RealTimePaymentsTransfers.RealTimePaymentsTransfer.t()}
  | {:error, Increase.Error.t()}

Cancels a Real-Time Payments Transfer in a pending_approval state.

POST /real_time_payments_transfers/{real_time_payments_transfer_id}/cancel

create(client, params \\ %{}, opts \\ [])

@spec create(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) ::
  {:ok, Increase.RealTimePaymentsTransfers.RealTimePaymentsTransfer.t()}
  | {:error, Increase.Error.t()}

Create a Real-Time Payments Transfer

POST /real_time_payments_transfers

list(client, params \\ %{}, opts \\ [])

@spec list(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) ::
  {:ok, Increase.Page.t()} | {:error, Increase.Error.t()}

List Real-Time Payments Transfers

Returns a %Increase.Page{} whose data is a list of %__MODULE__. RealTimePaymentsTransfer{} structs. Page through results with Increase.Page.auto_paging_stream/1 or Increase.Page.auto_paging_each/2.

GET /real_time_payments_transfers

retrieve(client, real_time_payments_transfer_id, opts \\ [])

@spec retrieve(Increase.Client.t() | keyword() | nil, String.t(), keyword()) ::
  {:ok, Increase.RealTimePaymentsTransfers.RealTimePaymentsTransfer.t()}
  | {:error, Increase.Error.t()}

Retrieve a Real-Time Payments Transfer

GET /real_time_payments_transfers/{real_time_payments_transfer_id}