Close Order

Overview

This endpoint is used to close an order that has been created but has not yet been paid. This action prevents the customer from completing the payment for the specified transaction.

Environments

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

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

Parameter	Type	Required	Description
clientId	String	Yes	Your unique developer ID.
checkoutId	String	No	The unique transaction ID generated by the payment platform.
transIndexCode	String	No	The unique order ID that was generated by your system.

Note: At least one of checkoutId or transIndexCode must be provided. If both are sent, checkoutId will take precedence.

Request Example

{
    "clientId": "825429536610058240",
    "checkoutId": "202504011341223232135",
    "transIndexCode": "20250401123534801"
}

---

Response Body

The response acknowledges that the request to close the transaction has been received and processed.

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.

Success Response Example

{
    "code": 200,
    "msg": "success",
    "timestamp": "2024-08-12 14:45:54"
}