Increase.Simulations.PendingTransactions (Increase v1.0.0)

Copy Markdown View Source

Sandbox-only simulations related to Pending Transaction.

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

This endpoint simulates immediately releasing an Inbound Funds Hold, which might be created as a result of, for example, an ACH debit.

Functions

release_inbound_funds_hold(client, pending_transaction_id, opts \\ [])

@spec release_inbound_funds_hold(
  Increase.Client.t() | keyword() | nil,
  String.t(),
  keyword()
) ::
  {:ok, Increase.PendingTransactions.PendingTransaction.t()}
  | {:error, Increase.Error.t()}

This endpoint simulates immediately releasing an Inbound Funds Hold, which might be created as a result of, for example, an ACH debit.

POST /simulations/pending_transactions/{pending_transaction_id}/release_inbound_funds_hold