Skip to main content

Query status of an order​

  1. When the payment is successful, Zaloay will call the callback (notify) to the Merchant, then the Merchant updates the status of Successful orders on the Merchant's system. But in reality, the callback may be missed due to Network Timeout / Merchant Service Unavailable / Internal Error,... so Merchant needs to make the call of the API to query the order status.

  2. App Server send request to Zalopay Server to get the transaction's payment status.

Note:
When return_code = 3 (Unpaid order or transaction in progress), the API call needs to be repeated within the order's payment period to get the final result.
Request Body required
  • app_id integer required

    The unique ID of the application will be provided after the merchant registered successfully with Zalopay.

  • app_trans_id string required

    The transaction ID that is used for querying.

  • mac string required

    It is signature of order. It's calculated by following input: hmacinput = appid + | + apptransid + | + key1 and use sha256 with app's hmac key as sign key.

    Please refer to secure data transmission for detailed information.

Responses

OK

Schema
  • return_code integer

    Status code of this operation. Please refer to status code for possible values

  • return_message string
  • sub_return_code integer

    The detailed reason explains if the operation has failed. Please refer to sub status code for possible values

  • sub_return_message string
  • is_processing boolean
  • amount int64
  • zp_trans_id int64
Loading...