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 HMAC 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 Name | Required | Type | Description |
|---|---|---|---|
| amount | no | integer | If 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. |
| transactionId | no | string | Pass the transactionId received from the ORDER_PAYMENT_SUCCEEDED webhook event. This can be passed in all cases. It is required in a split-payment scenario, when multiple transactions are tied to one orderId. |
Request Body Example
{
"amount": 1523, // Represents $15.23
"transactionId": "string"
}
API Response
Response Body Parameters
| Parameter Name | Type | Description |
|---|---|---|
| orderId | string | The Skipify order id |
| merchantId | string | The Skipify Merchant identifier |
| amount | integer | The amount captured |
| transactionId | string | The Skipify transaction identifier |
| status | string | Allowed Values = Refunded, Failed |
| pspTransactionId | string | The transactionId from the PSP |
| message | string, nullable | This 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",
"pspTransactionId": "string",
"message": "string"
}
Updated 6 months ago
What’s Next