Query status of an order

Sandbox

https://sb-openapi.hitechpay.vn/v2

POST

/query

Last modified:2025-12-03 12:09:00

When a user successfully completes a payment, HiTechPay will send a callback (notification) to the Merchant. Upon receiving this, the Merchant should update the order status to "Success" in their system.
In practice, the callback might be missed due to issues such as network timeouts, Merchant service unavailability, or internal errors. Therefore, the Merchant should proactively implement an API call to query the order status.
Recommended timing for querying order status:

Use a cron job or scheduled task to periodically query the order status until a callback is received or 15 minutes (the default order expiration time) have passed since the order was created.

Perform a one-time query 15 minutes after the order is created if no callback has been received.

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://sb-openapi.hitechpay.vn/v2/query' \
--header 'Content-Type: application/json' \
--data-raw '{
  "app_id": 0,
  "app_trans_id": "string",
  "mac": "string"
}'

Response Example

{
  "return_code": 0,
  "return_message": "string",
  "sub_return_code": 0,
  "sub_return_message": "string",
  "is_processing": true,
  "amount": 0,
  "zp_trans_id": 0,
  "server_time": 0,
  "discount_amount": 0
}

Modified at 2025-12-03 12:09:00

Create a new order

Refund for a transaction