Skip to main content

Inquire Payment

Fetch the status of a wallet transaction when postback notifications are not received or a postback URL has not been configured.

Applies to: Mobile wallets (Easypaisa · JazzCash · HBL Konnect · Alfa)


Endpoint

MethodPOST
Path/v2/inquire/wallet/transaction/inquiry
Sandboxhttps://sandbox.simpaisa.com/v2/inquire/wallet/transaction/inquiry
Productionhttps://payin.simpaisa.com/v2/inquire/wallet/transaction/inquiry

Headers

HeaderRequiredDescription
AcceptYestext/plain, application/json, application/*+json
Content-TypeYesapplication/json
modeYespayin
regionYesPK
operatorIdYesWallet operator code
versionYes3.0
Request-IdNo (recommended)Unique request identifier for idempotency
warning

Avoid frequent polling. Use postbacks for final decisioning when possible.


Request Body

Identify the transaction by userKey or transactionId (provide one).

ParameterTypeRequiredLengthDescription
merchantIdIntYes7Simpaisa-assigned merchant ID
userKeyStringYes*Your order reference from Initiate/Verify
transactionIdStringYes*Simpaisa transaction ID from Initiate/Verify

* Provide userKey or transactionId.


Response Body

ParameterDescription
merchantIdYour merchant ID
transactionIdSimpaisa transaction ID
userKeyYour order reference
transactionNested object with full transaction details

transaction Object

ParameterDescription
statusFinal status code — 0000 = Success
messageHuman-readable status
msisdnCustomer mobile number
operatorIdPayment channel ID
merchantIdMerchant ID
transactionIdTransaction ID
amountTransaction amount
userKeyOrder reference
transactionType0 = one-time payment
createdTimestampTransaction creation time
updatedTimestampLast status update time

When To Use

  • Postback URL is not configured
  • Postback was not received (network timeout, server downtime)
  • Non-OTP or async Verify returned Transaction-Pending
info

At present, this Inquire API works for mobile wallets only.


CURL

curl -X POST "https://sandbox.simpaisa.com/v2/inquire/wallet/transaction/inquiry" \
-H "Content-Type: application/json" \
-H "operatorID: 100008" \
-H "Request-Id: 341324134" \
-H "mode: payin" \
-H "region: PK" \
-H "version: 3.0" \
-d '{
"merchantId": "xxxxxxx",
"userKey": "xxxxx"
}'

Samples

{
"merchantId": "xxxxxxx",
"userKey": "xxxxx"
}