Create Reversal

Request a reversal of a successful payment.

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

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 amount is 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 amount minus 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 workflow

If your business requires approval for create-reversal, a request made from a dashboard session returns 202 with an approvalId, 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

HTTPCodeMessageWhen
400204Input is invalidtranRef or businessId is missing
400327Transaction not foundNo payment with this tranRef belongs to you
400340Only successful transactions can be reversedThe payment didn't succeed
400252Your balance is insufficientThe wallet can't cover the net debit
400339Transaction cannot be reversedThe payment couldn't be marked as reversing
400367Reversal already placed for this transactionA reversal for this payment is pending
400368Reversal currently being processed for this transactionA reversal for this payment is active or processing
400346Reversal already processedThis payment has already been reversed
400369Reversal cannot be placed for this transaction at this timeReversals are blocked for this payment
403342You do not have permission to take that actionThe keys lack the required permission
Body Params
integer
required

Your business ID

string
required

refid of the successful payment to reverse

string

Why the customer wants their money back

string

Your reason for the reversal. Saved as the reversal's reason

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json