Increase.Simulations.InboundCheckDeposits (Increase v1.0.0)

Copy Markdown View Source

Sandbox-only simulations related to Inbound Check Deposit.

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

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

Simulates an adjustment on an Inbound Check Deposit. The Inbound Check Deposit must have a status of accepted.

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

Simulates an Inbound Check Deposit against your account. This imitates someone depositing a check at their bank that was issued from your account. It may or may not be associated with a Check Transfer. Increase will evaluate the Inbound Check Deposit as we would in production and either create a Transaction or a Declined Transaction as a result. You can inspect the resulting Inbound Check Deposit object to see the result.

Functions

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

@spec adjustment(
  Increase.Client.t() | keyword() | nil,
  String.t(),
  map() | keyword(),
  keyword()
) ::
  {:ok, Increase.InboundCheckDeposits.InboundCheckDeposit.t()}
  | {:error, Increase.Error.t()}

Simulates an adjustment on an Inbound Check Deposit. The Inbound Check Deposit must have a status of accepted.

POST /simulations/inbound_check_deposits/{inbound_check_deposit_id}/adjustment

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

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

Simulates an Inbound Check Deposit against your account. This imitates someone depositing a check at their bank that was issued from your account. It may or may not be associated with a Check Transfer. Increase will evaluate the Inbound Check Deposit as we would in production and either create a Transaction or a Declined Transaction as a result. You can inspect the resulting Inbound Check Deposit object to see the result.

POST /simulations/inbound_check_deposits