Increase.SwiftTransfers (Increase v1.0.0)

Copy Markdown View Source

Swift Transfers send funds internationally.

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

Summary

Functions

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

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

Approve a Swift Transfer

POST /swift_transfers/{swift_transfer_id}/approve

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

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

Cancel a pending Swift Transfer

POST /swift_transfers/{swift_transfer_id}/cancel

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

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

Create a Swift Transfer

POST /swift_transfers

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

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

List Swift Transfers

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

GET /swift_transfers

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

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

Retrieve a Swift Transfer

GET /swift_transfers/{swift_transfer_id}