Refund Order
Overview
Use the Refund Order endpoint to send a refund to the card that was processed during the initial transaction.
Important!
A refund cannot be processed until after funds have settled!
API Request
This endpoint uses HMAC with SHA-256
Check out our API Authentication section to learn more
The request body has a RefundAmount field. If this field is not passed with a value, the API will refund the full amount of the order. If you specify a RefundAmount, then that amount will be refunded.
Example
An order of $100 has settled. You initiate the API call with the RefundAmount field of $10. This will create a refund of $10.
To Refund an order, send an API call to:
POST {{baseUrl}}/orders/{{orderId}}/refund
Request Body Parameters
| Parameter | Required? | Type | Description |
|---|---|---|---|
| refundAmount | No | Integer | If this field is not passed with a value, the API will refund the total of the order. However, if the refundAmount is specified, then that amount that will be refunded. If the refund performed is not for the entire total amount, a new authorization will be performed for the remaining amount on the order after the refund has been completed. Note: the refund amount cannot exceed the total amount of funds that have been captured. |
Request Body Example
{
"refundAmount": 1523 // Represents $15.23
}
API Response
Response Body Parameters
| Response Parameter | Type | Description |
|---|---|---|
| refundTransactionId | string | The Transaction ID received from the payment gateway |
| status | string | "success" or "failure" |
| errorCode | string, nullable | Error code from the payment gateway if failure occurs |
| transactionIds | array | List of all the transactionIds from the payment gateway that are relevant to this refund |
| gatewayResponse | string | Raw response from the payment gateway. We share this with you in case you need to contact the gateway directly |
Response Body Example
{
"refundTransactionId": "1115245",
"status": "Success",
"errorCode": null,
"transactionIds": [
"1115245",
],
"gatewayResponse": "string"
}
API Reference
Check out our API Reference to learn more
Updated 5 months ago