Sandbox-only simulations related to 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
Simulates the creation of a Check Deposit
Adjustment on a Check
Deposit. This Check Deposit must first have a status of
submitted.
Simulates the rejection of a Check Deposit by Increase
due to factors like poor image quality. This Check Deposit must first have a
status of pending.
Simulates the return of a Check Deposit. This Check
Deposit must first have a status of submitted.
Simulates the submission of a Check Deposit to the
Federal Reserve. This Check Deposit must first have a status of pending.
Functions
@spec adjustment( Increase.Client.t() | keyword() | nil, String.t(), map() | keyword(), keyword() ) :: {:ok, Increase.CheckDeposits.CheckDeposit.t()} | {:error, Increase.Error.t()}
Simulates the creation of a Check Deposit
Adjustment on a Check
Deposit. This Check Deposit must first have a status of
submitted.
POST /simulations/check_deposits/{check_deposit_id}/adjustment
@spec reject(Increase.Client.t() | keyword() | nil, String.t(), keyword()) :: {:ok, Increase.CheckDeposits.CheckDeposit.t()} | {:error, Increase.Error.t()}
Simulates the rejection of a Check Deposit by Increase
due to factors like poor image quality. This Check Deposit must first have a
status of pending.
POST /simulations/check_deposits/{check_deposit_id}/reject
@spec return(Increase.Client.t() | keyword() | nil, String.t(), keyword()) :: {:ok, Increase.CheckDeposits.CheckDeposit.t()} | {:error, Increase.Error.t()}
Simulates the return of a Check Deposit. This Check
Deposit must first have a status of submitted.
POST /simulations/check_deposits/{check_deposit_id}/return
@spec submit( Increase.Client.t() | keyword() | nil, String.t(), map() | keyword(), keyword() ) :: {:ok, Increase.CheckDeposits.CheckDeposit.t()} | {:error, Increase.Error.t()}
Simulates the submission of a Check Deposit to the
Federal Reserve. This Check Deposit must first have a status of pending.
POST /simulations/check_deposits/{check_deposit_id}/submit