Payment method code

Internet banking type code

Bank code	Bank name
VCB	VIETCOMBANK
VTB	VIETINBANK
TCB	TECHCOMBANK
VIB	VIB
BIDV	BIDV
SEA	SEABANK
SHB	SHB
DAB	DONGABANK
ACB	ACB
TPB	TPBANK
EXB	EXIMBANK
SAC	SACOMBANK
SCB	SAIGONBANK
MBB	MBBANK
MSB	MSB
KLB	KIENLONGBANK

E-wallet type code

E-wallet code	E-wallet name
MOMO	MOMO
VIETTELPAY	VIETTELPAY

VIRTUAL ACCOUNT (va) type code

Scan code	Scan name
VA	VA

Scan code (qr) type code

Scan code	Scan name
QR	QR

Recharge card (scratch card) type code

Recharge card code	Recharge card name
VIETTEL	Viettel
MOBIFONE	Mobifone
VINAPHONE	Vinaphone
VIETNAMOBILE	Vietnamobile
ZING	Zing
GATE	Gate
VCOIN	Vcoin
GARENA	Garena

Limit information

	Deposit amount rules
Deposit channel	Minimum single transaction	Maximum single transaction
internetbank	100,000	200,000,000
ewallet	50,000	10,000,000
qr	100,000	20,000,000
va	100,000	300,000,000
scratch card	10,000	1,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:

1704183963685

X-API-SIGNATURE

string

required

signature

Example:

3046022100e3f77085dd40cd803ed5b74f909b1e775bb0b1a795cd2a464a7258479d663bb6022100f27c27d29d840e641119a2aa4c8126d755e9e16c2965cec51f296a20e34ebdd9

Body Params application/json

amount

string

Amount

required

Amount (no decimals. Cannot be zero, must meet the amount standard.) If the payment method is a recharge card, the amount is fixed. The supported amount denominations are: 10000, 20000, 30000, 50000, 100000, 200000, 300000, 500000, 1000000

currency

string

Currency

required

Fixed VND

customerName

string

Username

required

mchNo

string

Merchant No.

required

mchOrderNo

string

Merchant order number

required

notifyUrl

string

Result notification address

required

returnUrl

string | null

Cashier return page

optional

wayCode

string

Payment method code

required

CASHIER-Cashier mode Non-CASHIER-reference collection method code

serial

string | null

Recharge card number

optional

Recharge card number, if the payment method is a recharge card, it is required

string | null

Recharge card password

optional

Recharge card password, if the payment method is a recharge card, it is required

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 samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200成功

application/json

Body

code

integer

Response Code

required

0 - Success, Non-zero - Failure

data

object

Response Data

required

amount

string

Order Amount

required

accountName

string

User Name

required

User name, only returned in non-cashier mode for collection methods internet banking, e-wallet, and QR code

accountNumber

string

Account

required

Only returned in non-cashier mode for collection methods VA, internet banking, and QR code

body

string

Product Description

required

countryCode

string

Country Code

required

currency

string

Currency

required

Fixed value: VND

customerContact

string

User Phone Number

required

mchOrderNo

string

Merchant Order Number

required

orderState

integer

Order Status

required

typeBank

string

Payment Mode

required

Bank name, only returned in non-cashier mode for collection methods VA, internet banking, and QR code

payData

string

Payment Data

required

QR code image/collection account (only returned in non-cashier mode, and only for collection methods VA, QR code, and e-wallet)

cashierUrl

string

TP Cashier Address

required

Cashier address in non-cashier mode

payOrderId

string

Payment Platform Order Number

required

payUrl

string

Cashier Address

required

Returns cashier address in cashier mode; - Returns transfer information (may be empty) in non-cashier mode

payWays

object

required

msg

string

Response Description

required

sign

string

required

Examples

Checkout success exampleQR Success ExampleOnline banking success exampleWallet Success Example

{
    "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"
}

Create a deposit order

Internet banking type code#

E-wallet type code#

VIRTUAL ACCOUNT (va) type code#

Scan code (qr) type code#

Recharge card (scratch card) type code#

Limit information#

Request

Request samples

Responses

Internet banking type code

E-wallet type code

VIRTUAL ACCOUNT (va) type code

Scan code (qr) type code

Recharge card (scratch card) type code

Limit information