Documentation Payment Operations/query Payment

Payment Operations - Query Payment

Retrieve payment status and details with our payment API endpoints

Overview

Use this endpoint to query the current status and details of a payment using the ZenPay payment reference identifier.

This endpoint requires Signature Authentication, IP Whitelisting, and is subject to Rate Limiting.

Request

Http Method & URL

POST /v1/payments/status

Headers

Header	Type	Required	Description
Content-Type	string	Yes	application/json
X-Signature	string	Yes	HMAC-SHA256 signature for request authentication

Signature Generation: Refer to the Signature Generation section for detailed steps on generating the X-Signature header value.

Parameters

Parameter	Type	Required	Description
biller_code	string	Yes	Merchant identifier code
payref_id	string	Yes	Unique payment reference identifier from ZenPay

Request Body Example

{
  "biller_code": "200040022",
  "payref_id": "ZNY241129037532"
}

Response

Success Response (200)

{
    "success": true,
    "message": "Payment status retrieved successfully",
    "data": {
        "biller_code": "202500039",
        "payref_id": "ZNN250706038024",
        "amount": "37.00",
        "status_code": "1C",
        "status": "UNSUCCESSFUL",
        "bank_code": "UOB0226",
        "bank_type": "01",
        "bank_branch": "UNITED+OVE",
        "datetime": "20250706053405"
    }
}

Error Response (404)

{
    "success": false,
    "message": "Failed to get payment status",
    "errors": [
        {
            "field": "system",
            "message": "failed to get payment order: record not found"
        }
    ]
}

Was this helpful?

Hosted Payment Page

Redirect Handling