Inquiry QRIS Status
The Inquiry QRIS Status API is used to check the status of a previously generated QRIS (Quick Response Code Indonesian Standard) transaction. This allows the merchant to verify if the QRIS is still active, the amount associated with it, and other relevant details.
Endpoint URL
https://api.zipay.co.id/payment/qr/inquiry
Request
- URL:
https://api.zipay.co.id/payment/qr/inquiry
- Method:
POST
- Headers:
Content-Type
:application/json
Authorization
:Bearer <YOUR_BEARER_TOKEN>
Request Body
Example Request
{
"uuid": "686c6ab1-9a3a-469a-a271-4bf171e34ca0",
"merchantId": "3",
"signature": "fc79b33e9ea3c654b5203497395b82984799a10bf36fa63f69be1d1b09899d49"
}
You need to provide the uuid
of the QRIS transaction, which was returned during the creation of the QRIS, along with the merchantId
. The request also requires a signature
to ensure the security and authenticity of the inquiry.
Field | Mandatory | Description |
---|---|---|
uuid | Yes | The unique identifier of the QRIS transaction that was generated earlier. |
merchantId | Yes | The unique identifier of the merchant associated with the QRIS transaction. |
signature | Yes | A hashed string generated based on secret information known by both the client and the server, ensuring the request is authorized and tamper-proof. Click here to view the category IDs |
Response
If the inquiry is successful, the API will return a response containing the details of the QRIS transaction, including its status, amount, and expiration time.
Example Response
{
"status": 200,
"success": true,
"data": {
"uuid": "686c6ab1-9a3a-469a-a271-4bf171e34ca0",
"amount": 10000,
"externalId": "INIEXTERNALID1234",
"status": "ACTIVE",
"merchantId": "3",
"merchantName": "ZHX GUITAR STORE3",
"expired_at": "2024-08-02 14:22:59"
}
}
Field | Description |
---|---|
status | The HTTP status code of the response. A value of 200 indicates that the request was successful. |
success | Indicates whether the API call was successful (true or false). |
uuid | The unique identifier for the QRIS transaction, as provided in the request. |
amount | The amount of money to be paid by the customer (in Indonesian Rupiah) associated with the QRIS transaction. |
externalId | The unique identifier for the transaction, provided in the original QRIS creation request. |
status | The status of the QRIS transaction. Typically, ACTIVE means the QR code is still valid for scanning and payment. |
merchantId | The unique identifier of the merchant that was passed in the request. |
merchantName | The name of the merchant associated with the merchantId. |
expired_at | The expiration timestamp of the generated QR code. After this time, the QR code is no longer valid for payment. |