Increase.InboundWireTransfers (Increase v1.0.0)

Copy Markdown View Source

An Inbound Wire Transfer is a wire transfer initiated outside of Increase to your account.

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

Summary

Functions

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

List Inbound Wire Transfers

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

Retrieve an Inbound Wire Transfer

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

Reverse an Inbound Wire 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 Wire Transfers

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

GET /inbound_wire_transfers

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

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

Retrieve an Inbound Wire Transfer

GET /inbound_wire_transfers/{inbound_wire_transfer_id}

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

@spec reverse(
  Increase.Client.t() | keyword() | nil,
  String.t(),
  map() | keyword(),
  keyword()
) ::
  {:ok, Increase.InboundWireTransfers.InboundWireTransfer.t()}
  | {:error, Increase.Error.t()}

Reverse an Inbound Wire Transfer

POST /inbound_wire_transfers/{inbound_wire_transfer_id}/reverse