Refund Order

Use this endpoint to refund orders with funds that have already been settled

Overview

The request body has an amount field. If this field is not passed with a value, the API will refund the full amount of the order. If you specify an amount in the request body, then that amount will be refunded.

👍

This endpoint uses MAC with SHA-256

Check out our API Authentication section to learn more


To refund an order, send an API call to:

Staging: POST https://stage-oms.skipify.com/{orderId}/refund

Production: POST https://oms.skipify.com/{orderId}/refund

Request Body Parameters

Parameter NameRequiredTypeDescription
amountnointegerIf no value is provided for this field, the API will refund the entire amount from the previous transaction.

If you specify an amount, it will be refunded only if it is less than or equal to the total amount of the captured funds.

Request Body Example

{
  "amount": 1523 // Represents $15.23
}

API Response

Response Body Parameters

Parameter NameTypeDescription
orderIdstringThe Skipify order id
merchantIdstringThe Skipify Merchant identifier
amountintegerThe amount captured
transactionIdstringThe Skipify transaction identifier
statusstringAllowed Values = Refunded, Failed
messagestring, nullableThis message will be populated if there was an error processing the capture

Response Body Example

{
  "orderId": "string",
  "merchantId": "string",
  "amount": integer,
  "transactionId": "string",
  "status": "Refunded",
  "message": "string"
}


Skipify baner with link to contact us form

What’s Next