TarsPay_EN
  1. deposit
TarsPay_EN
Vietnam🇻🇳
  • Indonesia🇮🇩
  • India🇮🇳
  • Thailand🇹🇭
  • Philippines🇵🇭
  • Malaysia🇲🇾
  • Vietnam🇻🇳
  • Egypt🇪🇬
  • Bangladesh🇧🇩
  • Kenya🇰🇪
  • Pakistan🇵🇰
  • Brazil🇧🇷
  • Mexico🇲🇽
  • Korea🇰🇷
  • Türkiye🇹🇷
  • 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. deposit

Create a deposit order

POST
/api/pay/unifiedOrder
Payment method code

Internet banking type code#

Bank codeBank name
VCBVIETCOMBANK
VTBVIETINBANK
TCBTECHCOMBANK
VIBVIB
BIDVBIDV
SEASEABANK
SHBSHB
DABDONGABANK
ACBACB
TPBTPBANK
EXBEXIMBANK
SACSACOMBANK
SCBSAIGONBANK
MBBMBBANK
MSBMSB
KLBKIENLONGBANK

E-wallet type code#

E-wallet codeE-wallet name
MOMOMOMO
VIETTELPAYVIETTELPAY

VIRTUAL ACCOUNT (va) type code#

Scan codeScan name
VAVA

Scan code (qr) type code#

Scan codeScan name
QRQR

Recharge card (scratch card) type code#

Recharge card codeRecharge card name
VIETTELViettel
MOBIFONEMobifone
VINAPHONEVinaphone
VIETNAMOBILEVietnamobile
ZINGZing
GATEGate
VCOINVcoin
GARENAGarena

Limit information#

Deposit amount rules
Deposit channelMinimum single transactionMaximum single transaction
internetbank50,000300,000,000
ewallet50,0005,000,000
qr50,000300,000,000
va100,000300,000,000
scratch card10,0001,000,000

Request

Header Params

Body Params application/json

Example
{
    "amount": "100000",
    "currency": "VND",
    "customerName": "DW",
    "mchNo": "M1688454487",
    "mchOrderNo": "VN31420230300564",
    "notifyUrl": "http://47.241.33.220:8896/tarspay/notify",
    "returnUrl": "https://www.tarspay.com/notify/return",
    "wayCode": "CASHIER"
}

Request Code 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/pay/unifiedOrder' \
--header 'X-API-KEY: 02d6433f5bedc5bc35b0971b8acce048b2ad4bce74210bea1288a10f42b166e057' \
--header 'X-API-NONCE: 1704183963685' \
--header 'X-API-SIGNATURE: 3046022100e3f77085dd40cd803ed5b74f909b1e775bb0b1a795cd2a464a7258479d663bb6022100f27c27d29d840e641119a2aa4c8126d755e9e16c2965cec51f296a20e34ebdd9' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": "100000",
    "currency": "VND",
    "customerName": "DW",
    "mchNo": "M1688454487",
    "mchOrderNo": "VN31420230300564",
    "notifyUrl": "http://47.241.33.220:8896/tarspay/notify",
    "returnUrl": "https://www.tarspay.com/notify/return",
    "wayCode": "CASHIER"
}'

Responses

🟢200成功
application/json
Body

Examples
{
    "code": 0,
    "data": {
        "amount": "100000",
        "countryCode": "vn",
        "currency": "VND",
        "customerContact": "",
        "mchOrderNo": "VN31420230300564",
        "orderState": 0,
        "payDataType": "payurl",
        "payOrderId": "P1742099907246653442",
        "payUrl": "https://payment-test.tarspay.com/#/order/vn/P1742099907246653442",
        "payWays": {
            "scratch card": [
                {
                    "countryCode": "vn",
                    "createdAt": 0,
                    "id": 112,
                    "payWay": "ZING",
                    "payWayLogo": "https://tarspay.oss-ap-southeast-1.aliyuncs.com/tarspay_v_1.0/Zing.png",
                    "payWayType": "scratch card",
                    "skipMode": 1,
                    "state": 1,
                    "updatedAt": 0
                },
                {
                    "countryCode": "vn",
                    "createdAt": 0,
                    "id": 108,
                    "payWay": "VIETTEL",
                    "payWayLogo": "https://tarspay.oss-ap-southeast-1.aliyuncs.com/tarspay_v_1.0/Viettel.png",
                    "payWayType": "scratch card",
                    "skipMode": 2,
                    "state": 1,
                    "updatedAt": 0
                }
            ],
            "ewallet": [
                {
                    "countryCode": "vn",
                    "createdAt": 0,
                    "id": 139,
                    "payWay": "VIETTELPAY",
                    "payWayLogo": "https://tarspay.oss-ap-southeast-1.aliyuncs.com/ViettelPay.png",
                    "payWayType": "ewallet",
                    "skipMode": 1,
                    "state": 1,
                    "updatedAt": 0
                },
                {
                    "countryCode": "vn",
                    "createdAt": 0,
                    "id": 66,
                    "payWay": "MOMO",
                    "payWayLogo": "https://tarspay.oss-ap-southeast-1.aliyuncs.com/tarspay_v_1.0/banklogo/momo.png",
                    "payWayType": "ewallet",
                    "skipMode": 1,
                    "state": 1,
                    "updatedAt": 0
                }
            ],
            "internetbank": [
                {
                    "countryCode": "vn",
                    "createdAt": 0,
                    "id": 82,
                    "payWay": "VTB",
                    "payWayLogo": "https://tarspay.oss-ap-southeast-1.aliyuncs.com/tarspay_v_1.0/banklogo/vtb.png",
                    "payWayType": "internetbank",
                    "skipMode": 1,
                    "state": 1,
                    "updatedAt": 0
                },
                {
                    "countryCode": "vn",
                    "createdAt": 0,
                    "id": 84,
                    "payWay": "VIB",
                    "payWayLogo": "https://tarspay.oss-ap-southeast-1.aliyuncs.com/tarspay_v_1.0/banklogo/vib.png",
                    "payWayType": "internetbank",
                    "skipMode": 1,
                    "state": 1,
                    "updatedAt": 0
                },
                {
                    "countryCode": "vn",
                    "createdAt": 0,
                    "id": 81,
                    "payWay": "VCB",
                    "payWayLogo": "https://tarspay.oss-ap-southeast-1.aliyuncs.com/tarspay_v_1.0/banklogo/vcb.png",
                    "payWayType": "internetbank",
                    "skipMode": 1,
                    "state": 1,
                    "updatedAt": 0
                },
                {
                    "countryCode": "vn",
                    "createdAt": 0,
                    "id": 89,
                    "payWay": "TPB",
                    "payWayLogo": "https://tarspay.oss-ap-southeast-1.aliyuncs.com/tarspay_v_1.0/banklogo/tpb.png",
                    "payWayType": "internetbank",
                    "skipMode": 1,
                    "state": 1,
                    "updatedAt": 0
                },
                {
                    "countryCode": "vn",
                    "createdAt": 0,
                    "id": 83,
                    "payWay": "TCB",
                    "payWayLogo": "https://tarspay.oss-ap-southeast-1.aliyuncs.com/tarspay_v_1.0/banklogo/tcb.png",
                    "payWayType": "internetbank",
                    "skipMode": 1,
                    "state": 1,
                    "updatedAt": 0
                },
                {
                    "countryCode": "vn",
                    "createdAt": 0,
                    "id": 86,
                    "payWay": "SHB",
                    "payWayLogo": "https://tarspay.oss-ap-southeast-1.aliyuncs.com/tarspay_v_1.0/banklogo/shb.png",
                    "payWayType": "internetbank",
                    "skipMode": 1,
                    "state": 1,
                    "updatedAt": 0
                },
                {
                    "countryCode": "vn",
                    "createdAt": 0,
                    "id": 142,
                    "payWay": "SEA",
                    "payWayLogo": "https://tarspay.oss-ap-southeast-1.aliyuncs.com/SEA.png",
                    "payWayType": "internetbank",
                    "skipMode": 1,
                    "state": 1,
                    "updatedAt": 0
                },
                {
                    "countryCode": "vn",
                    "createdAt": 0,
                    "id": 92,
                    "payWay": "SCB",
                    "payWayLogo": "https://tarspay.oss-ap-southeast-1.aliyuncs.com/tarspay_v_1.0/banklogo/scb.png",
                    "payWayType": "internetbank",
                    "skipMode": 1,
                    "state": 1,
                    "updatedAt": 0
                },
                {
                    "countryCode": "vn",
                    "createdAt": 0,
                    "id": 91,
                    "payWay": "SAC",
                    "payWayLogo": "https://tarspay.oss-ap-southeast-1.aliyuncs.com/tarspay_v_1.0/banklogo/sac.png",
                    "payWayType": "internetbank",
                    "skipMode": 1,
                    "state": 1,
                    "updatedAt": 0
                },
                {
                    "countryCode": "vn",
                    "createdAt": 0,
                    "id": 93,
                    "payWay": "MBB",
                    "payWayLogo": "https://tarspay.oss-ap-southeast-1.aliyuncs.com/tarspay_v_1.0/banklogo/mbb.png",
                    "payWayType": "internetbank",
                    "skipMode": 1,
                    "state": 1,
                    "updatedAt": 0
                },
                {
                    "countryCode": "vn",
                    "createdAt": 0,
                    "id": 90,
                    "payWay": "EXB",
                    "payWayLogo": "https://tarspay.oss-ap-southeast-1.aliyuncs.com/tarspay_v_1.0/banklogo/exb.png",
                    "payWayType": "internetbank",
                    "skipMode": 1,
                    "state": 1,
                    "updatedAt": 0
                },
                {
                    "countryCode": "vn",
                    "createdAt": 0,
                    "id": 87,
                    "payWay": "DAB",
                    "payWayLogo": "https://tarspay.oss-ap-southeast-1.aliyuncs.com/tarspay_v_1.0/banklogo/dab.png",
                    "payWayType": "internetbank",
                    "skipMode": 1,
                    "state": 1,
                    "updatedAt": 0
                },
                {
                    "countryCode": "vn",
                    "createdAt": 0,
                    "id": 85,
                    "payWay": "BIDV",
                    "payWayLogo": "https://tarspay.oss-ap-southeast-1.aliyuncs.com/tarspay_v_1.0/banklogo/bidv.png",
                    "payWayType": "internetbank",
                    "skipMode": 1,
                    "state": 1,
                    "updatedAt": 0
                },
                {
                    "countryCode": "vn",
                    "createdAt": 0,
                    "id": 88,
                    "payWay": "ACB",
                    "payWayLogo": "https://tarspay.oss-ap-southeast-1.aliyuncs.com/tarspay_v_1.0/banklogo/acb.png",
                    "payWayType": "internetbank",
                    "skipMode": 1,
                    "state": 1,
                    "updatedAt": 0
                }
            ],
            "qr": [
                {
                    "countryCode": "vn",
                    "createdAt": 0,
                    "id": 80,
                    "payWay": "QR",
                    "payWayLogo": "https://tarspay.oss-ap-southeast-1.aliyuncs.com/tarspay_v_1.0/QR.png",
                    "payWayType": "qr",
                    "skipMode": 1,
                    "state": 1,
                    "updatedAt": 0
                }
            ]
        }
    },
    "msg": "SUCCESS",
    "sign": "3045022100da18fd80984abb0cf081885d6cc427fcfd9251fac26af625fe70d9c194b328ee02205224398d8a65da90dc18cbdfcaddb826642be2b3c05bdce831a0b3764dcd30e9"
}
Modified at 2025-10-31 09:27:08
Previous
Attachment Code Table
Next
Query deposit order status
Built with