CHECK STATUS API

The Check Transaction Status API allows merchants to query the current status of a transaction and its refunds (if any) using its unique identifier. This is particularly useful for:

Reconciliation – Verifying whether a payment was successful, failed, or is still pending.
Post-payment tracking – Monitoring refunds and partial refunds.
Dispute resolution – Retrieving detailed transaction data when handling customer queries.

Purpose : This API can be used to check the status of a transaction including all refunds.

Request Type : POST

Endpoint : /api/payments/v1/status

Request Attributes

These are the Request Attributes of Zaakpay Check Status API.

Field	Datatype	Mandatory	Description
merchantIdentifier	String	Y	Unique identifier assigned to the merchant by Zaakpay.
orderId	String	Y	Unique order ID generated by the merchant to identify a specific transaction.

Response Attributes

These are the Response Attributes of Zaakpay Check Status API.

Field	Type	Description
status	Boolean	Indicates the overall result of the API request.
message	Object	Contains response code and description.
data	Object	Contains transaction-related information (if applicable).

Checksum Calculation

Calculate the checksum using the HMAC SHA-256 algorithm using the data json as string and your generated secret key.

Sample Request & Response

Below is a sample Check Status API request with all required attributes and their values, arranged in the order they are sent to the API. Calculate the checksum using your secret key and include it in the API request header along with the other required attributes.

cURL

curl -X POST https://api.zaakpay.com/api/payments/v1/status \
-H "Content-Type: application/json" \
-H "checksum: <calculated-checksum-here>" \
-d '{
"merchantIdentifier": "02efXXXXXXXXXXXXXXXXX060c35f",
"orderId": "ORDER98765"
}'

Sample Request

{
    "merchantIdentifier": "02efXXXXXXXXXXXXXXXXX060c35f",
    "orderId": "ORDER98765",
    "version": 13
}

Sample Response

{
"status": true,
"message": {
"code": 100,
"text": "The transaction was completed successfully."
},
data:{
"success": true,
"merchantIdentifier": "02efXXXXXXXXXXXXXXXXX060c35f",
"orders": [
{
"orderDetail": {
"orderId": "ORDER98765",
"txnId": "ZP6XXXXXXX781",
"amount": "22300",
"productDescription": "Zaakpay subscription fee",
"createDate": "2020-10-12 16:32:47",
},
"paymentInstrument": {
"paymentMode": "Credit Card",
"card": {
"cardToken": "XXXX XXXX XXXX 1112",
"cardId": "2515XXXX448XXX57XXd57170fXX~27"
}
},
"txnDate": "2020-10-12 16:44:43",
"txnStatus": "3",
"responseCode": "245",
"responseDescription": "Partial Refund Initiated",
"refundDetails":[
{
"merchantRefId": "REFXXXXXXX33b",
"amount": "100",
"rrn": "60370",
"refundStatus": "PENDING"
},
{
"merchantRefId": "REFXXXXXXX33b",
"amount": "100",
"rrn": "5765",
"refundStatus": "SUCCESS"
}
]
}
],
"version": "13"
}

Refund Status	Refund Response
1	SUCCESS
2	PENDING
3	FAILED

Transaction Status Code

Status	Description
0	Success
1	Failure
2	Pending
3	Refund
4	Partial Refund
5	Chargeback Reverted
6	Chargeback
7	Partial Chargeback Reverted
8	Partial Chargeback