Pay-Out · Pakistan
About 2 min
Request
Pay-Out API for sending funds to recipients in Pakistan (country code pk).
- Amounts are whole PKR (no decimals), 50 – 50,000 per transaction.
documentNo(recipient 13-digit CNIC) is required.bankCode— see Regional Payment Guide — Pakistan.
Request URL
Domain: Prefer unified host
openapi.toppayment.com(path unchanged); legacy country domain (e.g.global-pk-openapi.toppayment.com) remains available.
| Environment | URL |
|---|---|
| Sandbox | https://openapi.toppayment.com/sandbox/pk/disbursement/cash |
| Production | https://openapi.toppayment.com/pk/disbursement/cash |
Request header
| Field | Required | Type | Description |
|---|---|---|---|
| Content-Type | M | String | Fixed value: application/json |
Request body
| Field | Required | Type | Description |
|---|---|---|---|
| mchNo | M | String(32) | Merchant number |
| orderNum | M | String(50) | Merchant order number |
| amount | M | Number | Amount in whole PKR (50–50000) |
| bankCode | M | String(32) | Bank / wallet code — see Pakistan guide |
| bankCard | M | String(50) | Recipient account number |
| accountName | M | String(50) | Recipient name |
| documentNo | M | String(100) | Recipient 13-digit CNIC |
| feeType | M | Number (0 or 1) | Fee type: 0 deducted from amount, 1 charged separately |
| downNotifyUrl | M | String(164) | Async notification URL |
| timestamp | M | String(13) | Timestamp (milliseconds) |
| sign | M | String | Signature — see Signature |
Request example (IBFT)
Content-type: application/json
{
"mchNo": "{{mchNo}}",
"orderNum": "PKO1234561",
"amount": 1000,
"bankCode": "49",
"bankCard": "1234567890123456",
"accountName": "Ali Khan",
"documentNo": "3520212345671",
"feeType": 1,
"downNotifyUrl": "https://example.com/notify",
"timestamp": "1749451858772",
"sign": "Generate per signature rules and replace"
}
Response Fields
| Field | Required | Type | Description |
|---|---|---|---|
| success | M | Boolean | Success flag |
| code | M | String | 9999 = accepted; check order status for other results |
| msg | O | String | Message |
| timeStamp | M | Number | Server time (ms) |
| data | M | Object | Payload |
| orderNum | M | String | Merchant order number |
| platOrderNum | M | String | Platform order number |
| amount | M | Number | Amount (integer PKR) |
| fee | M | Number | Fee |
| feeType | M | Number | Fee type: 0 deducted from amount, 1 charged separately |
| status | M | Number | Status — Transaction Status Codes |
| statusMsg | M | String | Status message |
| bankCode | M | String | Bank or wallet code — Pakistan payout codes |
| bankCard | M | String | Beneficiary account |
| accountName | M | String | Beneficiary name |
| description | O | String | Description |
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
| Field | Required | Type | Description |
|---|---|---|---|
| Content-Type | M | String | Fixed value: application/json |
Notification Body
| Field | Required | Type | Description |
|---|---|---|---|
| platOrderNum | M | String | Platform order number |
| version | M | String | Version, fixed to v1 |
| orderNum | M | String | Merchant order number, same as orderNum at order placement |
| amount | M | Number | Amount in whole PKR |
| fee | M | Number | Fee |
| feeType | M | Number | Fee type: 0 deducted from amount, 1 charged separately |
| status | M | Number | Transaction status See Transaction Status Codes |
| statusMsg | M | String | Status message |
| bankCode | M | String | Bank / wallet code — see Pakistan guide |
| bankCard | M | String | Recipient account number |
| accountName | M | String | Recipient name |
| description | O | String | Description |
| sign | M | String | Callback 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"
}
