Increase.InboundRealTimePaymentsTransfers (Increase v1.0.0)

Copy Markdown View Source

An Inbound Real-Time Payments Transfer is a Real-Time Payments transfer initiated outside of Increase to your account.

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

Summary

Functions

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

List Inbound Real-Time Payments Transfers

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

Retrieve an Inbound Real-Time Payments Transfer

Functions

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

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

List Inbound Real-Time Payments Transfers

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

GET /inbound_real_time_payments_transfers

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

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

Retrieve an Inbound Real-Time Payments Transfer

GET /inbound_real_time_payments_transfers/{inbound_real_time_payments_transfer_id}