Pay-Out · Pakistan
Less than 1 minute
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
Response fields match other countries' pay-out APIs.
