Create Payout

Request URL

method	url
POST	/api/pay/payout/create/v1

Headers

Header Parameter	Description
timestamp	Request timestamp
nonce	Random value
country	PK
appCode	Application ID

Request Parameters

Field	Type	Required	Max Length	Description
merchantOrderNo	String	yes	32	Merchant order number
amount	String	yes	20	Payout amount in PKR, must be an integer
bankCode	String	yes	50	Bank Code For accountType 301, take bankCode from the bank list; For accountType 303, always pass EASYPAISA; For accountType 304, always pass JAZZCASH
bankName	String	yes	50	Bank name, same as bank code
accountType	Int	yes		Account type: 301 (BANK) 303 (EASYPAISA) 304 (JAZZCASH)
bankAccount	String	yes	50	Bank/Wallet account number
realName	String	yes	255	Customer name
idCardNumber	String	yes	13	ID number (13 digits)
idType	String	yes	32	Fixed value: CERT
phone	String	yes	10	Phone number (10 digits)
email	String	no	64	Customer email
userIBAN	String	no	64	International Bank Account Number (IBAN)
callbackUrl	String	no	200	Callback URL, (If not transmitted, the callback URL configured in the merchant backend will be used.)
sign	String	yes		Signature

request

{
  "merchantOrderNo": "OrderNoExample",
  "amount": "1000",
  "bankCode": "EASYPAISA",
  "bankName": "EASYPAISA",
  "accountType": 303,
  "bankAccount": "3000000000",
  "realName": "TeemoPay",
  "idCardNumber": "3000000000000",
  "idType": "CERT",
  "phone": "3000000000",
  "callbackUrl": "https://www.callbackexample.com",
  "sign": "YOUR_SIGN"
}

Response Parameters

Field	Type	Required	Max Length	Description
merchantOrderNo	String	yes	32	Merchant order number
tradeNo	String	yes		Platform order number
status	Int	yes		Payout status: 1 - Processing, 3 - Failed (can retry)
amount	String	yes		Transaction amount

response

{
  "msg": "success",
  "traceId": "747bbf80261844ed85b809212aab0d81.85.17422898158610298",
  "code": 200,
  "data": {
    "amount": "1000",
    "merchantOrderNo": "OrderNoExample",
    "status": 1,
    "tradeNo": "TF2501010001PK0000000000000000"
  }
}