TarsPay_EN
  1. withdraw
TarsPay_EN
Vietnam🇻🇳
  • 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
withdraw bank code
bank & e-wallet codebank & e-wallet name
MOMOMOMO
VCBVIETCOMBANK
VTBVIETINBANK
TCBTECHCOMBANK
BIDVBIDV
SHBSHB
DABDONGABANK
ACBACB
TPBTPBANK
EXBEXIMBANK
SACSACOMBANK
SCBSCB
MBBMBBANK
VIBVIB
AGBAGRIBANK
HDBHDB
VPBVPBANK
OEBOCEANBANK
MSBMSB
LPBLPB
ABBABBANK
NCBNCB
SEABSEABANK
PCVPVCOMBANK
KLBKIENLONGBANK
VCTBVIETCAPITAL BANK
OCBOCB
VEBVIETBANK
VRBVRB
SHVSHBVN
UOBNgân hàng TNHH MTV United Overseas Bank (Việt Nam)
WOONgân hàng TNHH Woori bank
HLBNgân hàng TNHH một thành viên Hong Leong Việt Nam
PBVNNgân hàng TNHH MTV PUBLIC Việt Nam
BVBNgân hàng TMCP Bảo Việt
IVBNgân hàng TNHH Indovina
PGBNgân hàng TNHH MTV Xăng dầu Petrolimex
NABNgân hàng TMCP NAM Á(NAMABANK)
VABNgân hàng TMCP Việt Á
SVBNgân hàng TNHH MTV Shinhan (Việt Nam)
GPBNgân hàng TNHH MTV Dầu khí toàn cầu
SGBNgân hàng Sài Gòn Công Thương

Limit information#

withdraw amount rules
withdraw channellowest single transactionhighest single transaction
BANK200,000100,000,000
EWALLET200,000100,000,000

Request

Header Params
X-API-KEY
string 
required
The public key applied by the merchant backend
Example:
02d6433f5bedc5bc35b0971b8acce048b2ad4bce74210bea1288a10f42b166e057
X-API-NONCE
string 
required
System timestamp accurate to milliseconds
Example:
1704248227906
X-API-SIGNATURE
string 
required
signature
Example:
3045022100bac479cd032b4a39673b5419f204e47bddb78f0ef9e58117dca0160497c3b7730220650c6adde3f911f78d1c4f18cd4764ce9d64d1f5d0801ea2cb49d1a6deb8ea44
Body Params application/json
mchNo
string 
Merchant No.
required
mchOrderNo
string 
Merchant Order No. (guaranteed to be unique)
required
wayCode
string 
withdraw code
required
withdraw code
currency
string 
Currency
required
Fixed VND
amount
string 
Amount
required
notifyUrl
string 
Result notification address
required
customerName
string 
User name
required
customerEmail
string 
User mailbox
required
customerContact
string  | null 
User mobile phone
optional
Mobile phone number, when wayCode is MOMO, it cannot be empty
customerAccountNumber
string  | null 
User payment account
optional
User bank card, when wayCode is not MOMO, it cannot be empty
Example
{
    "amount": "1000000",
    "bankName": "VCB",
    "currency": "VND",
    "customerAccountNumber": "55686666888811111",
    "customerContact": "0978216915",
    "customerEmail": "g762646676@126.com",
    "customerName": "GDW",
    "mchNo": "M1688454487",
    "mchOrderNo": "YN35320230300880",
    "notifyUrl": "http://47.241.33.220:8896/tarspay/notify",
    "wayCode": "MOMO"
}

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: 02d6433f5bedc5bc35b0971b8acce048b2ad4bce74210bea1288a10f42b166e057' \
--header 'X-API-NONCE: 1704248227906' \
--header 'X-API-SIGNATURE: 3045022100bac479cd032b4a39673b5419f204e47bddb78f0ef9e58117dca0160497c3b7730220650c6adde3f911f78d1c4f18cd4764ce9d64d1f5d0801ea2cb49d1a6deb8ea44' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": "1000000",
    "bankName": "VCB",
    "currency": "VND",
    "customerAccountNumber": "55686666888811111",
    "customerContact": "0978216915",
    "customerEmail": "g762646676@126.com",
    "customerName": "GDW",
    "mchNo": "M1688454487",
    "mchOrderNo": "YN35320230300880",
    "notifyUrl": "http://47.241.33.220:8896/tarspay/notify",
    "wayCode": "MOMO"
}'

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": "YN35320230300880",
        "payOrderId": "P1742369451135565825"
    },
    "msg": "SUCCESS",
    "sign": "3045022100c0d4f194dbdcf67f8b7dab94b67e9f8afc7304f61d79a20d9907152adf60c67202203e1079c1a7e8afd12c3404bd083617a4c9b6efb807fa98c37593eb6397737d0e"
}
Previous
Query deposit order status
Next
Query withdraw order
Built with