Create refund
Use this method to create an unreferenced refund. An unreferenced refund is a refund that isn’t linked to a payment.
Note: If you have the paymentId of the payment you want to refund, use our Refund Payment method. If you use our Refund Payment method, our gateway sends the refund amount to the customer’s original payment method and links the refund to the payment.
In the request, you must provide the customer’s payment details and the refund amount.
In the response, our gateway returns information about the refund and a refundId, which you need for the following methods:
- Retrieve refund - View the details of the refund.
- Adjust refund - Update the details of the refund.
- Reverse refund - Cancel the refund if it’s in an open batch.
Headers
Bearer authentication of the form Bearer <token>, where token is your auth token.
Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.
Request
Response
Array of operations that you can perform on the transaction.
capture
- Capture the payment.refund
- Refund the payment.fullyReverse
- Fully reverse the transaction.partiallyReverse
- Partially reverse the payment.incrementAuthorization
- Increase the amount of the authorization.adjustTip
- Adjust the tip post-payment.addSignature
- Add a signature to the payment.setAsReady
- Set the transaction’s status toready
.setAsPending
- Set the transaction’s status topending
.setAsDeclined
- Set the transaction’s status todeclined
.