API Reference
  1. Payouts
  2. Payout Receivers

Deactivate payout receiver

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

Permanently deactivate a payout receiver. A deactivated receiver cannot receive payouts. The payout receiver status must be NEEDS_INFORMATION, NEEDS_METHOD, or ACTIVE to be deactivated.

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
string

Why the payout receiver is being deactivated.

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?