Creating a Refund
Endpoint Access URL: https://rest.everyware.com/api/Default/CreateRefund [POST]
Use the CreateRefund method to void a pending preauthorization, or to refund a transaction that has already settled.
Inbound Parameters
Parameter Name | Description | Required/Not |
---|---|---|
RefundType | Accepts either “Full” or “Partial”, based on whether the full amount is to be refunded or only a fraction. **Full is default value, and Amount is ignored | REQUIRED |
Amount | Amount to be refunded (if you choose Full you can leave this blank, as it will automatically refund whatever the total price was originally charged) | Optional |
InvoiceID | This is the unique value returned from the processor gateway that identifies a transaction in Everyware. | REQUIRED |
Code Sample
{
"RefundType": "full",
"Amount": "1.00",
"OrderNumber": "",
"InvoiceID": "ew_3JN25fAawEMtODxF3OEtn7Q1"
}
curl --location 'https://rest.everyware.com/api/Default/CreateRefund' \
--header 'Authorization: Basic [xxx]' \
--header 'Content-Type: application/json' \
--data-raw ' {
"RefundType": "full",
"Amount": "1.00",
"OrderNumber": "",
"InvoiceID": "ew_3JN25fAawEMtODxF3OEtn7Q1"
}
{
"IsSuccess": true,
"Message": "The refund has been processed.",
"Data": null,
"OrderNumber": null
}
Updated 3 months ago