Create Withdrawal Order (Pakistan)
API for creating Pakistani Rupee (PKR) withdrawal orders.
Request Information
- Request URL:
/gateway/api/v2/payouts - Method:
POST - Content-Type:
application/json;charset=utf-8
Request Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| platform_id | Yes | String(6) | Merchant ID |
| service_id | Yes | String(7) | Service ID |
| payout_cl_id | Yes | String(64) | Merchant Order ID |
| amount | Yes | Integer(10) | Amount (in cents) |
| notify_url | No | String(256) | Callback URL for transaction results |
| bank_name | Yes | String(16) | Bank code, Bank List |
| name | Yes | String(16) | Beneficiary name |
| number | Yes | String(34) | Beneficiary account number. For wallet withdrawals, the mobile number; for bank card withdrawals, the bank account number or IBAN (24 characters), letters and digits only, no spaces or - |
| currency | Yes | String(3) | Fixed value: pkr |
| identity_no | No | String(15) | Beneficiary national ID (CNIC), 13 digits, - allowed, e.g. 35202-1234567-1. Required by some channels, see Remarks |
| phone_number | No | String(11) | Beneficiary mobile number, 11 digits starting with 03, e.g. 03001234567. Required by some channels for bank card withdrawals, see Remarks; for wallet withdrawals number is used as the mobile number |
| request_time | Yes | Integer(10) | Request time (seconds) |
| sign_type | No | String(16) | Signature type, fixed value HMAC-SHA256 |
| sign | Yes | String(32|64) | Order Signature |
Service ID
SVC0004Bank Card WithdrawalSVC0074JAZZCASH WithdrawalSVC0075EASYPAISA Withdrawal
Response Example
{
"error_code": "0000",
"data": { "payout_id": "POT00000001" }
}
Remarks
Important
In case of timeout or HTTP 500 errors, please use the order query API to check the status. Do not treat the order as failed directly.
- Transaction amount is in Pakistani Rupee (cents)
- A response of "0000" only indicates the API call was successful. Please use the query API to confirm the result
- Bank card withdrawal (
SVC0004): setbank_nameto a bank code from the Bank List andnumberto the beneficiary's bank account number or IBAN - Some channels require beneficiary identity information:
identity_nois required for withdrawals, and some channels additionally requirephone_numberfor bank card withdrawals. If missing, invalid, or the bank is not supported, the API still returns "0000", but the order will fail and the balance will be refunded (within about 15 minutes). Please rely on the query API or callback notification