Request a reversal of a successful payment.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Requests a reversal of a successful payment. Vendy debits the payment from your wallet straight away, creates a reversal with status pending and begins processing it. The money is returned to the customer's bank account or payment card within 7 to 14 business days, depending on the payment method used to complete the payment. See Reversals for the full flow.
Permission: reversals:create or reversals:manage on the business.
What happens to your wallet
- The payment
amountis debited from the wallet it was paid into. - Any fee you paid on the payment is returned to that wallet, so the net debit is
amountminus your fee. - Any commission earned on the payment is debited from your commission wallet.
The wallet's available balance (minus locked funds) must cover the net debit, or the request fails with 252. Each movement appears in wallet history with TRAN-<tranRef> REV-<refid>.
Approval workflowIf your business requires approval for create-reversal, a request made from a dashboard session returns
202with anapprovalId, and the reversal is created only once it's approved. Requests made with API keys skip approval.
Vendy sends a reversal_created webhook when the reversal is created.
Errors
| HTTP | Code | Message | When |
|---|---|---|---|
400 | 204 | Input is invalid | tranRef or businessId is missing |
400 | 327 | Transaction not found | No payment with this tranRef belongs to you |
400 | 340 | Only successful transactions can be reversed | The payment didn't succeed |
400 | 252 | Your balance is insufficient | The wallet can't cover the net debit |
400 | 339 | Transaction cannot be reversed | The payment couldn't be marked as reversing |
400 | 367 | Reversal already placed for this transaction | A reversal for this payment is pending |
400 | 368 | Reversal currently being processed for this transaction | A reversal for this payment is active or processing |
400 | 346 | Reversal already processed | This payment has already been reversed |
400 | 369 | Reversal cannot be placed for this transaction at this time | Reversals are blocked for this payment |
403 | 342 | You do not have permission to take that action | The keys lack the required permission |
