Payment Inquiry

Check the payment status of a voucher you created via insertPPMVoucher. Call this from your system after a reasonable interval to update your payment records.

1Insert Voucher

→

2Customer Pays

→

3Payment Inquiry

Authentication

X-API-KEYYour API key from the Business Portal

IN-IDYour Institution Initiator ID

Request Parameters

Parameter	Type	Required	Description
`consumer_number`	string	required	The consumer/voucher number used when creating the invoice.
`reserved`	string	optional	Optional metadata. Pass empty string if unused.

Response

{
  "response_Code": "00",
  "response_description": "Success",
  "consumer_detail": "John Doe",
  "bill_status": "Paid",
  "due_date": "2025-06-30",
  "amount_within_due_date": "250000",
  "amount_after_due_date": "265000",
  "billing_month": "2506",
  "date_paid": "2025-06-15",
  "amount_paid": "250000",
  "tran_auth_id": "TXN202506151234",
  "reserved": ""
}

Response Codes

Code	Meaning
00	Bill found successfully.
01	Consumer number not found.
02	Voucher is blocked or inactive.
03	Unknown error or bad request.
04	Invalid data — wrong credentials or malformed request.
05	Server error — API or ERP system failed internally.
06	Bill already paid.
401	Authentication failed — check X-API-KEY / IN-ID / IP.

Check multiple bills at once

Bulk Inquiry →

Payment Inquiry — Request

curl -X POST https://uat-adminapi.kuickpay.com/api/PaymentInquiry \
  -H "X-API-KEY: your_api_key" \
  -H "IN-ID: your_initiator_id" \
  -H "Content-Type: application/json" \
  -d '{
    "consumer_number": "XXXXX0000001",
    "reserved": ""
  }'