Create Payout

WARNING

Note: if the response times out or returns a non-200 HTTP status code, confirm the order status with operations before resubmitting

WARNING

Important: name + phone + email + amount are used to identify distinct customers. Follow these notes to avoid incorrect risk-control decisions.

1. Do not hard-code name, phone, and email together
2. Use the same name + phone + email for the same customer

Endpoint

POST /cashout/pakistan/order/create

Request Parameters

Field	Type	Required	Description
name	string	Yes	Customer name — More realistic values improve success rate and reduce risk flags; length must be greater than 5
phone	string	Yes	Customer mobile number — 11 digits starting with 03; phone and account must be the same
email	string	Yes	Customer email — More realistic values improve success rate and reduce risk-control flags
bankCode	string enum	Yes	Payout method code — JAZZCASH, EASYPAISA
account	string	Yes	Account number (Pakistan supports mobile numbers) — 11 digits starting with 03; phone and account must be the same
amount	number	Yes	Amount — 100~49999; up to 2 decimal places (rounded). Trailing zeros after the decimal are omitted in the pre-sign string for float amounts
notifyUrl	string	Yes	Notification URL — Sandbox supports automatic callbacks: odd last digit of phone → success; even → failure
sign	string	Yes	Signature
appId	string	Yes	Merchant appId
mchOrderNo	string	Yes	Merchant order number
mchId	integer	Yes	Merchant ID
txChannel	string	Yes	Transaction channel — Fixed valueTX_PAK_001
timestamp	integer	Yes	Current timestamp — Unix timestamp in seconds
taxNumber	string	Yes	ID number (CNIC) — Length: 13 digits
branch	string	Yes	International bank account — IBAN must start with PK and contain 24 characters

Request Example

{
 "mchId": 7937213261,
 "txChannel": "TX_PAK_001",
 "appId": "R22e9c0f1x3hycRKd9",
 "timestamp": 1662450012,
 "mchOrderNo": "payout_26622128134",
 "name": "Matthew Clark",
 "phone": "03881999382",
 "email": "test@gmail.com",
 "bankCode": "UPAY",
 "account": "03881999382",
 "amount": "500",
 "taxNumber": "3123456789012",
 "branch": "PK36SCBL0000001123456702",
 "notifyUrl": "http://xmevj.kg/obp",
 "sign": "xxxxxxxx"
}

Response Parameters

Field	Type	Required	Description
status	integer	Yes	Status — 200 success
msg	string	Yes	Message
data	object	Yes
data.applyTime	integer	Yes	Application time
data.amount	number	Yes	Credited amount
data.platOrderNo	string	Yes	Platform order number
data.mchOrderNo	string	Yes	Merchant order number
data.orderStatus	string enum	Yes	Order status — PENDING, SUCCESS, FAILED, REFUND

Response Example

{
 "status": 200,
 "msg": null,
 "data": {
 "mchOrderNo": "payout_1662104438",
 "platOrderNo": "wussXUCOoXO3yptr7rQV",
 "applyTime": 1662104742,
 "amount": 180.34,
 "orderStatus": "PENDING"
 }
}

Related

• Pakistan
• Signature & Verification
• Payout Webhook