API Reference
  1. Payouts
  2. Payouts

Cancel payout

post
https://api.sandbox.rainforestpay.com/v1/payouts//cancel

Cancel a payout that is in the status of SCHEDULED or IN_REVIEW.

This endpoint requires the platform to be approved for the Payouts integration.

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

The unique payout identifier.

Prefix is "pyo" in production and "sbx_pyo" in sandbox.

Body Params

Request to cancel a payout.

string
length ≤ 255

The reason for the cancellation.

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

Updated 3 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 3 months ago

Did this page help you?