Edit or cancel a payout
How to edit or cancel a scheduled payout via API or Components
Early PreviewThis feature is currently in Beta. Please contact Rainforest support or your Platform Success Manager for more information on Payouts.
A payout can be edited or canceled while it is Scheduled, before it processes on its scheduled date. Once a payout is Processing, it can no longer be edited or canceled.
Edit a payout
While a payout is Scheduled, you can change:
- Amount: When the amount increases, Rainforest checks that the merchant's available balance covers the difference and sets it aside. When the amount decreases, the difference goes back to the available balance.
- Requested payout date: The scheduled date is recalculated with the same rules as a new payout. See payout timing.
You can update the payout's metadata at any time, because metadata does not affect the balance.
The payout receiver and bank account cannot be changed on an existing payout. To send the funds somewhere else, cancel the payout and create a new one.
To edit a payout via API, call the Update payout endpoint with the fields to change.
{
"amount": 100000,
"requested_payout_date": "2026-11-04"
}Cancel a payout
A payout can be canceled while it is Scheduled or In Review. Canceling a payout moves it to the status of Canceled, and the amount goes back to the merchant's available balance. The payout fee is not charged on a canceled payout.
Once a payout is canceled, its payout config can be used to create a new payout.
Cancel via API
Call the Cancel payout endpoint. You can include an optional cancel_reason of up to 255 characters, which is returned on the payout.
{
"cancel_reason": "Job canceled by the merchant"
}Cancel via Components
Merchants can cancel a scheduled payout from the payout details in the Payout Report Component, or the Merchant Account Component. Include cancel-payout in the component's allowed-actions to show the option.
Webhooks
When a payout is canceled, Rainforest sends the payout.canceled webhook. See payout webhooks.
Updated about 7 hours ago