Increase.Simulations.WireTransfers (Increase v1.0.0)

Copy Markdown View Source

Sandbox-only simulations related to Wire Transfer.

These endpoints only work against the sandbox environment and let you fast-forward events that would otherwise take hours or days in production (settlement, acknowledgement, returns, and so on). See https://increase.com/documentation/api/overview#sandbox for details.

Summary

Functions

Simulates the reversal of a Wire Transfer by the Federal Reserve due to error conditions. This will also create a Transaction to account for the returned funds. This Wire Transfer must first have a status of complete.

Simulates the submission of a Wire Transfer to the Federal Reserve. This transfer must first have a status of pending_approval or pending_creating.

Functions

reverse(client, wire_transfer_id, opts \\ [])

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

Simulates the reversal of a Wire Transfer by the Federal Reserve due to error conditions. This will also create a Transaction to account for the returned funds. This Wire Transfer must first have a status of complete.

POST /simulations/wire_transfers/{wire_transfer_id}/reverse

submit(client, wire_transfer_id, opts \\ [])

@spec submit(Increase.Client.t() | keyword() | nil, String.t(), keyword()) ::
  {:ok, Increase.WireTransfers.WireTransfer.t()} | {:error, Increase.Error.t()}

Simulates the submission of a Wire Transfer to the Federal Reserve. This transfer must first have a status of pending_approval or pending_creating.

POST /simulations/wire_transfers/{wire_transfer_id}/submit