Increase.Simulations.CheckTransfers (Increase v1.0.0)

Copy Markdown View Source

Sandbox-only simulations related to Check 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 mailing of a Check Transfer, which happens periodically throughout the day in production but can be sped up in sandbox. This transfer must first have a status of pending_approval or pending_submission.

Functions

mail(client, check_transfer_id, opts \\ [])

@spec mail(Increase.Client.t() | keyword() | nil, String.t(), keyword()) ::
  {:ok, Increase.CheckTransfers.CheckTransfer.t()}
  | {:error, Increase.Error.t()}

Simulates the mailing of a Check Transfer, which happens periodically throughout the day in production but can be sped up in sandbox. This transfer must first have a status of pending_approval or pending_submission.

POST /simulations/check_transfers/{check_transfer_id}/mail