Refund

Overview

This endpoint is used to issue a full or partial refund for a previously completed transaction.

Note: Partial refunds are not supported by all payment channels. Please check the documentation for your specific channel.

Environments

Environment	Protocol	HTTP Method	URL
Sandbox	HTTPS	POST	https://uat.paywizard.biz/ovstrade/openPay/refundOrder
Production	HTTPS	POST	https://portal.paywizard.biz/ovstrade/openPay/refundOrder

Headers

Key	Type	Required	Description
Content-Type	String	Yes	Must be application/json.
jwt-token	String	Yes	The transaction token obtained using your developer credentials.
sign	String	Yes	The request signature. See Signature Generation Guide.

Request Body Parameters

To identify the transaction to be refunded, you must provide either the oriCheckoutId or the oriTransIndexCode.

Parameter	Type	Required	Description
clientId	String	Yes	Your unique developer ID.
transIndexCode	String	Yes	A new, unique order ID for this specific refund request, generated by your system.
oriCheckoutId	String	Conditionally Required	The original checkoutId of the transaction you want to refund.
oriTransIndexCode	String	Conditionally Required	The original transIndexCode of the transaction you want to refund.
amount	String	Yes	The amount to be refunded. Example: "1.50".
notifyUrl	String	No	The callback URL where you will receive the final refund result notification.

Note: You must provide at least one of the original identifiers (oriCheckoutId or oriTransIndexCode). If both are sent, oriCheckoutId will take precedence.

Request Example

{
    "clientId": "825429536610058240",
    "transIndexCode": "202506091432000000013",
    "oriCheckoutId": "917121926164512768",
    "amount": "0.01"
}

---

Response Body

The response object contains the immediate status of the refund request.

Parameter	Type	Description
code	Integer	The HTTP status code. 200 indicates a successful request. Any other value indicates an error.
msg	String	A human-readable message describing the result. "success" on successful requests.
timestamp	String	The UTC timestamp of the response. Format: YYYY-MM-DD HH:mm:ss.
data	Object	A container for the successful response data. Null on error.
data.mid	String	The merchant ID.
data.paywizardId	String	The unique platform ID for the transaction.
data.checkoutId	String	The new, unique transaction ID for this refund, generated by the payment platform.
data.transIndexCode	String	The unique refund order ID that you provided in the request.
data.result	Integer	An integer code representing the status of the refund. See Refund Status Codes below.
data.amount	String	The refunded amount.
data.oriCheckoutId	String	The checkoutId of the original transaction that was refunded.
data.oriTransIndexCode	String	The transIndexCode of the original transaction that was refunded.

Refund Status Codes

The result field indicates the immediate outcome of the refund request. The final status may be delivered via the notifyUrl.

Result Code	Description
0	Success
1	Failure
2	Pending / In Progress

Success Response Example

JSON

{
    "code": 200,
    "msg": "success",
    "timestamp": "2025-06-09 15:32:00",
    "data": {
        "mid": "007889-3-006",
        "paywizardId": "10280000002",
        "checkoutId": "917122074735149056",
        "transIndexCode": "202506091432000000015",
        "amount": "0.01",
        "result": 0,
        "oriCheckoutId": "917121926164512768",
        "oriTransIndexCode": "202506091432000000012"
    }
}