Skip to content

Create Payout

Request URL

methodurl
POST/api/pay/payout/create/v1

Headers

Header ParameterDescription
timestampRequest timestamp
nonceRandom value
countryPK
appCodeApplication ID

Request Parameters

FieldTypeRequiredMax LengthDescription
merchantOrderNoStringyes32Merchant order number
amountStringyes20Payout amount in PKR, must be an integer
bankCodeStringyes50Bank code: use bankCode if 301, WalletCode if 302
bankNameStringyes50Bank name, same as bank code
accountTypeIntyesAccount type: 301 (BANK), 302 (E-Wallet)
bankAccountStringyes255Bank/Wallet account number
realNameStringyes255Customer name
idCardNumberStringyes13ID number (13 digits)
idTypeStringyes32Fixed value: CERT
phoneStringyes10Phone number (10 digits)
emailStringno64Customer email
userIBANStringno64International Bank Account Number (IBAN)
callbackUrlStringno200Callback URL, uses merchantโ€™s default if not provided
signStringyesSignature
request
{
"merchantOrderNo": "2503231308020924",
"amount": "1000",
"bankCode": "EASYPAISA",
"bankName": "EASYPAISA",
"accountType": 302,
"bankAccount": "3000000000",
"realName": "TEEMO",
"idCardNumber": "3000000000000",
"idType": "CERT",
"phone": "3000000000",
"callbackUrl": "https://www.callbackexample.com",
"sign": "YOUR_SIGN"
}

Response Parameters

FieldTypeRequiredMax LengthDescription
merchantOrderNoStringyes32Merchant order number
tradeNoStringyesPlatform order number
statusIntyesPayout status: 1 - Processing, 3 - Failed (can retry)
amountStringyesTransaction amount
response
{
"msg": "success",
"traceId": "747bbf80261844ed85b809212aab0d81.85.17422898158610298",
"code": 200,
"data": {
"amount": "1000",
"merchantOrderNo": "OrderNoExample",
"status": 1,
"tradeNo": "TF2501010001CPK0000000000000000"
}
}