API Reference
  1. Payouts
  2. Payout Receivers

Simulate payout receiver status change

post
https://api.sandbox.rainforestpay.com/v1/merchants//payout_receivers//simulate

Only available in the Rainforest sandbox environment. Simulate a payout receiver status change from VERIFYING to ACTIVE, NEEDS_METHOD, or DECLINED. The expected webhooks will be sent for the payout receiver on each status change.

Simulating to NEEDS_METHOD deactivates the payout receiver's payment methods.

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

The unique merchant identifier.

Prefix is "mid" in production and "sbx_mid" in sandbox.

string
required

The unique payout receiver identifier.

Prefix is "rcv" in production and "sbx_rcv" in sandbox.

Body Params

Simulation request for transitioning payout receiver status.

string
enum
required

Status to transition the VERIFYING payout receiver to.

  • ACTIVE verifies any CREATED payout receiver payment methods and activates the payout receiver. Returns a 400 if it has no usable payout method.
  • NEEDS_METHOD deactivates the payout receiver's payout receiver payment methods, so a new one must be added and verified.
  • DECLINED declines the payout receiver, with an optional reason.
Allowed:
string
length ≤ 255

The reason the payout receiver was declined. Only valid when status is DECLINED.

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

Updated about 16 hours 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 about 16 hours ago

Did this page help you?