API Reference
  1. Deposits
  2. Deposits

Simulate deposit status change

post
https://api.sandbox.rainforestpay.com/v1/deposits//simulate

Only available in the Rainforest sandbox environment.

Simulate a deposit status change. To simulate an on-demand deposit to PROCESSING, the deposit must currently be SCHEDULED. To simulate to SUCCEEDED or FAILED, the deposit must currently be PROCESSING. The expected webhooks will be sent for the deposit on status change.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique deposit identifier.

Prefix is "dep" in production and "sbx_dep" in sandbox.

Body Params

Simulation request for transitioning deposit status.

string
enum
required

Status to transition the deposit to.

In order to perform this transition, the deposit must be in status PROCESSING.

Transitioning a deposit into a FAILED status simulates an ACH return with return code R04.

Allowed:
Headers
string
enum
Defaults to 2024-10-16
Allowed:
Responses

Updated 7 months ago

Did this page help you?
Language
Credentials
Bearer
APIKey
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago

Did this page help you?