Creating a Refund

Access Endpoint URL: [POST]

Use the CreateRefund method to void a pending preauthorization, or to refund a transaction that has already settled.

Inbound Parameters

Parameters should be passed in a single JSON-body object.

Parameter NameDescriptionOptional/Required
RefundTypeAccepts either “Full” or “Partial”, based on whether the full amount is to be refunded or only a fraction. Full is the default value; Amount field can be left blank if set to full.Required
AmountAmount to be refunded. Only necessary if RefundType set to "Partial".Optional
OrderNumberThe number associated with the order in the Everyware system.

Either the OrderNumber or InvoiceID must be provided in the request.
InvoiceIDThis is the unique value returned from the processor gateway that identifies a transaction in Everyware.

Either the OrderNumber or InvoiceID must be provided in the request.
CaptureTransactionIDSome gateways have one ID that is used when a transaction is initiated and another that is assigned when it is captured. This refers to the latter.Optional

Determines whether the refund is allowed to be a partial refund or not. Default value is set to False.

Gateway-Specific Parameters

Whether the following parameters are required depends on the gateway being used. Ask your Everyware representative for more details.

Parameter NameDescription
AccountTypeThe type of bank account being used.
RoutingNumberThe routing number of the bank account.
AccountNumberThe account number of the bank account.
FirstNameThe first name associated with the bank account.
LastNameThe last name associated with the bank account.
MerchantThe name of the merchant providing the refund.
PaymentType"PaymentType.CreditCard" or "PaymentType.ACH".

Code Sample

  "RefundType": "full",
  "Amount": "1.00",
  "OrderNumber": "",
  "InvoiceID": "ew_3JN25fAawEMtODxF3OEtn7Q1",
  "CaptureTransactionID": "",
  "Parialrefunded": ""
curl --location '' \
--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