Skip to main content

Pay-Out · Pakistan

TOPPAY TeamAbout 2 min

Request

Pay-Out API for sending funds to recipients in Pakistan (country code pk).

Request URL

Domain: Prefer unified host openapi.toppayment.com (path unchanged); legacy country domain (e.g. global-pk-openapi.toppayment.com) remains available.

EnvironmentURL
Sandboxhttps://openapi.toppayment.com/sandbox/pk/disbursement/cash
Productionhttps://openapi.toppayment.com/pk/disbursement/cash

Request header

FieldRequiredTypeDescription
Content-TypeMStringFixed value: application/json

Request body

FieldRequiredTypeDescription
mchNoMString(32)Merchant number
orderNumMString(50)Merchant order number
amountMNumberAmount in whole PKR (50–50000)
bankCodeMString(32)Bank / wallet code — see Pakistan guide
bankCardMString(50)Recipient account number
accountNameMString(50)Recipient name
documentNoMString(100)Recipient 13-digit CNIC
feeTypeMNumber (0 or 1)Fee type: 0 deducted from amount, 1 charged separately
downNotifyUrlMString(164)Async notification URL
timestampMString(13)Timestamp (milliseconds)
signMStringSignature — see Signature

Request example (IBFT)

Content-type: application/json

Response Fields

FieldRequiredTypeDescription
successMBooleanSuccess flag
codeMString9999 = accepted; check order status for other results
msgOStringMessage
timeStampMNumberServer time (ms)
dataMObjectPayload
orderNumMStringMerchant order number
platOrderNumMStringPlatform order number
amountMNumberAmount (integer PKR)
feeMNumberFee
feeTypeMNumberFee type: 0 deducted from amount, 1 charged separately
statusMNumberStatus — Transaction Status Codes
statusMsgMStringStatus message
bankCodeMStringBank or wallet code — Pakistan payout codes
bankCardMStringBeneficiary account
accountNameMStringBeneficiary name
descriptionOStringDescription

Response Example

{
  "success": true,
  "code": "9999",
  "msg": "SUCCESS",
  "timeStamp": 1767772957433,
  "data": {
    "orderNum": "PKO1234561",
    "platOrderNum": "TRANS2008811496544403456",
    "amount": 1000,
    "fee": 20,
    "feeType": 1,
    "status": 1,
    "statusMsg": "ORDER_RECEIVED_PROCESSING",
    "bankCode": "49",
    "bankCard": "1234567890123456",
    "accountName": "Ali Khan",
    "description": "test"
  }
}

Notification

Pakistan uses the default callback. version is fixed to v1.

HTTP Request

FieldRequiredTypeDescription
Content-TypeMStringFixed value: application/json

Notification Body

FieldRequiredTypeDescription
platOrderNumMStringPlatform order number
versionMStringVersion, fixed to v1
orderNumMStringMerchant order number, same as orderNum at order placement
amountMNumberAmount in whole PKR
feeMNumberFee
feeTypeMNumberFee type: 0 deducted from amount, 1 charged separately
statusMNumberTransaction status
See Transaction Status Codes
statusMsgMStringStatus message
bankCodeMStringBank / wallet code — see Pakistan guide
bankCardMStringRecipient account number
accountNameMStringRecipient name
descriptionOStringDescription
signMStringCallback signature — see Signature

Response

Verify the signature, then return the plain string SUCCESS only.

SUCCESS

Notification Example

{
    "platOrderNum": "TRANS2008812168572567552",
    "version": "v1",
    "orderNum": "PKO1234561",
    "amount": 1000,
    "fee": 20,
    "feeType": 1,
    "status": 2,
    "statusMsg": "SUCCESS",
    "bankCode": "49",
    "bankCard": "1234567890123456",
    "accountName": "Ali Khan",
    "description": "test",
    "sign": "Verify per signature rules"
}