Reverse completed payouts or cancel pending/verified payouts.Reverse Recipient Payout#
Reverse a completed payout or cancel a pending/verified payout.Endpoint: POST /v1/payouts/recipients/payouts/{payout_id}/reverse| Field | Type | Required | Description |
|---|
reason | string | No | Optional reason for the reversal |
Pending/Verified payouts: Can be cancelled (funds returned immediately)
Completed payouts: Can be reversed within 48 hours of completion
Processing payouts: Cannot be reversed (wait for completion or failure)
Failed payouts: Cannot be reversed
{
"data": {
"id": "rp_abc123",
"status": "reversed",
"reversal_reason": "Payment error",
"reversed_at": "2024-01-15T12:00:00Z"
}
}
48-Hour Window: Completed payouts can only be reversed within 48 hours of completion. After this window, reversals are not possible. The reversal window is calculated from the completed_at timestamp.
