API Reference

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. The deposit status must be in 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…
Query Params
string

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.

At this time, you may only transition a deposit into a SUCCEEDED status.

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

Updated 16 days ago

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 16 days ago