Query Transaction Status

Overview

This endpoint allows you to query the status and details of a specific transaction using either the platform's checkoutId or your original transIndexCode.

Environments

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

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 object contains the current details of the queried transaction.

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 or if the order is not found.
data.mid	String	The merchant ID.
data.paywizardId	String	The unique platform ID for the transaction.
data.checkoutId	String	The unique transaction ID generated by the payment platform.
data.transIndexCode	String	The original third-party order ID from the request.
data.state	Integer	An integer code representing the current status of the transaction. See Transaction States below.
data.amount	String	The transaction amount.
data.tranTime	String	The UTC timestamp of when the transaction was successfully completed. Format: YYYY-MM-DD HH:mm:ss. Returned only on successful transactions.

Transaction States

The state field in the response data indicates the current status of the order.

State Code	Description
1	Not Paid
2	Payment/Operation Complete
3	Canceled
4	Refunded
5	Order Closed
6	Partially Refunded
7	Pre-authorization Complete
8	Pre-authorization Canceled
9	Partially Canceled

Success Response Example

{
    "code": 200,
    "msg": "success",
    "timestamp": "2024-08-12 14:45:54",
    "data": {
        "mid": "10800000003",
        "paywizardId": "1000000011",
        "checkoutId": "768878984749514752",
        "transIndexCode": "202504011341223232135",
        "state": 2,
        "amount": "100.21",
        "tranTime": "2025-06-04 17:03:21"
    }
}