Increase.WireDrawdownRequests (Increase v1.0.0)

Copy Markdown View Source

Wire drawdown requests enable you to request that someone else send you a wire. Because there is nuance to making sure your counterparty's bank processes these correctly, we ask that you reach out to support@increase.com to enable this feature so we can help you plan your integration. For more information, see our [Wire Drawdown Requests documentation].

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

Summary

Functions

Create a Wire Drawdown Request

List Wire Drawdown Requests

Functions

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

Create a Wire Drawdown Request

POST /wire_drawdown_requests

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

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

List Wire Drawdown Requests

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

GET /wire_drawdown_requests

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

Retrieve a Wire Drawdown Request

GET /wire_drawdown_requests/{wire_drawdown_request_id}