TarsPay_EN
  1. withdraw
TarsPay_EN
Pakistan🇵🇰
  • Indonesia🇮🇩
  • India🇮🇳
  • Thailand🇹🇭
  • Philippines🇵🇭
  • Malaysia🇲🇾
  • Vietnam🇻🇳
  • Egypt🇪🇬
  • Bangladesh🇧🇩
  • Kenya🇰🇪
  • Pakistan🇵🇰
  • Brazil🇧🇷
  • Mexico🇲🇽
  • Ban_TEST
  • Access Guide
  • Core Business Process Description
  • Attachment Code Table
  • deposit
    • Create a deposit order
      POST
    • Query deposit order status
      POST
  • withdraw
    • Create withdraw order
      POST
    • Query withdraw order
      POST
  • account
    • Query balance
      POST
  • CallBack
    • Callback notification interface (customized by the merchant)
      POST
  1. withdraw

Create withdraw order

POST
/api/payOut/unifiedOrder

Payment bank code#

Bank & wallet codeBank & wallet name
jazzcashjazzcash
easypaisaeasypaisa
ABHI FINANCE SERVICES LIMITEDABHI FINANCE SERVICES LIMITED
AFTAFT
AFT IBFTAFT IBFT
AdvansAdvans
Al Meezan Investment Management LimitedAl Meezan Investment Management Limited
AlHabibAlHabib
AlbarkaAlbarka
AlfalahAlfalah
AlliedAllied
ApnaApna
AskariAskari
BOKBOK
BYKEABYKEA
BankIslamiBankIslami
BurjBurj
Central Directorate of National SavingsCentral Directorate of National Savings
Central Directorate of National Savings (CDNS)Central Directorate of National Savings (CDNS)
Central Directorate of National Savings – 1IBFT IMD AdditionCentral Directorate of National Savings – 1IBFT IMD Addition
CitiCiti
DubaiIslamicDubaiIslamic
EZ wageEZ wage
FINCAFINCA
FINJAFINJA
FWBLFWBL
FaysalFaysal
First Microfinance BankFirst Microfinance Bank
HBLHBL
HBL ASSET MANAGEMENTHBL ASSET MANAGEMENT
Habib Metro Bank – Bulk 1IBFTHabib Metro Bank – Bulk 1IBFT
HabibMetroHabibMetro
Humrah Financial ServicesHumrah Financial Services
ICBCICBC
JSJS
KASBKASB
KBLKBL
KEENUKEENU
KEENU BankKEENU Bank
KEENU – IMD and 1IBFT Screen AdditionKEENU – IMD and 1IBFT Screen Addition
Keenu1Keenu1
MCBMCB
MCB-Arif HabibMCB-Arif Habib
MIBMIB
MeezanMeezan
MobilinkBank PakistanMobilinkBank Pakistan
NAYAPAYNAYAPAY
NBPNBP
NBP Fund Management LimitedNBP Fund Management Limited
NBP1NBP1
NIBNIB
NRSPNRSP
National BankNational Bank
Numbers Private LimitedNumbers Private Limited
PayMaxPayMax
PayMax1PayMax1
PunjabBankPunjabBank
SADAPAYSADAPAY
SCBSCB
SEEDCREED Financial Services LimitedSEEDCREED Financial Services Limited
SIMPAISASIMPAISA
SINDSIND
SambaSamba
SilkSilk
SindhBankSindhBank
SoneriSoneri
SummitSummit
TAGTAG
TezPAyTezPAy
UBLUBL
UPaisaUPaisa
WaseelaWaseela
Waseela bankWaseela bank
ZTBL1ZTBL1
Zarai Taraqiati BankZarai Taraqiati Bank
CDNSCDNS
KhyberKhyber
MCB Islamic BankMCB Islamic Bank
Standard Chartered BankStandard Chartered Bank
Telenor Microfinance BankTelenor Microfinance Bank
U Microfinance BankU Microfinance Bank
UNITEDUNITED

Limit Information#

Payment Amount Rules
Payment ChannelMinimum Single TransactionMaximum Single Transaction
jazzcash10050,000
easypaisa10050,000

Request

Header Params
X-API-KEY
string 
required
the public key applied for by the merchant backend
Example:
0221f85d6a09945403ef161b5200f4df152935a748ce2b9f291bb2d351d709b6a0
X-API-NONCE
string 
required
the system timestamp is accurate to milliseconds
Example:
1704250498993
X-API-SIGNAT URE
string 
required
signature
Example:
304502203968d3ce6a4c275816fbf71feee790ca4dfb192df71d49e10d631436 8470bf79022100b9cacaf8df3fd302bd408b2f0e75c9a54069b3994748b6a31aac1dd3928ff0a6
Body Params application/json
mchNo
string 
Merchant number
required
mchOrderNo
string 
Merchant order number (guaranteed to be unique)
required
wayCode
string 
Payment code
required
Payment code (reference payment bank code)
currency
string 
Currency
required
Fixed to PKR
amount
string 
Amount
required
Must be an integer
notifyUrl
string 
Result notification address
required
customerContact
string 
Real user wallet number
optional
Required when wayCode is easypaisa or jazzcash; starts with 03, total 11 digits
customerAccountNumber
string 
Bank account number (IBFT-Inter Bank Funds Transfer​)
optional
Required when wayCode is not equal to easypaisa jazzcash, and it is a bank account rather than a wallet account
customerName
string  | null 
Payee's name
optional
customerEmail
string  | null 
Payee's email
optional
Compatibility parameters
cnic
string  | null 
ID number
optional
13 pure digits
Example
{
    "amount": "50",
    "cnic": "0000000400000",
    "currency": "PKR",
    "customerAccountNumber": "508879XXXX22003",
    "customerContact": "03339605665",
    "customerEmail": "g762646676@gmail.com",
    "customerName": "ZEESHAN TAHIR",
    "mchNo": "M1677225721",
    "mchOrderNo": "BJST969202503000840",
    "notifyUrl": "http://yourdomain/notify",
    "wayCode": "jazzcash"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/payOut/unifiedOrder' \
--header 'X-API-KEY:  0221f85d6a09945403ef161b5200f4df152935a748ce2b9f291bb2d351d709b6a0' \
--header 'X-API-NONCE:  1704250498993' \
--header 'X-API-SIGNAT URE: 304502203968d3ce6a4c275816fbf71feee790ca4dfb192df71d49e10d631436 8470bf79022100b9cacaf8df3fd302bd408b2f0e75c9a54069b3994748b6a31aac1dd3928ff0a6' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": "50",
    "cnic": "0000000400000",
    "currency": "PKR",
    "customerAccountNumber": "508879XXXX22003",
    "customerContact": "03339605665",
    "customerEmail": "g762646676@gmail.com",
    "customerName": "ZEESHAN TAHIR",
    "mchNo": "M1677225721",
    "mchOrderNo": "BJST969202503000840",
    "notifyUrl": "http://yourdomain/notify",
    "wayCode": "jazzcash"
}'

Responses

🟢200成功
application/json
Body
code
integer 
required
data
object 
required
mchOrderNo
string 
Merchant order number
required
payOrderId
string 
Platform order number
required
msg
string 
required
Example
{
    "code": 0,
    "data": {
        "mchOrderNo": "BJST969202503000840",
        "payOrderId": "P1901533955932266497"
    },
    "msg": "SUCCESS",
    "sign": ""
}
Previous
Query deposit order status
Next
Query withdraw order
Built with