Create a deposit order

deposit method

Code	Description
BANK	BANK
PROMPTPAY	PROMPTPAY
TRUEMONEY	TRUEMONEY

bank name

Code	Description
PROMPTPAY	PROMPTPAY
BBL	BANGKOK BANK
KBANK	KASIKORNBANK
KTB	KRUNG THAI BANK
TMB	TMB BANK
SCB	SIAM COMMERCIAL BANK
CIMB	CIMB THAI BANK
UOB	UNITED OVERSEAS BANK (THAI)
BAY	BANK OF AYUDHYA (KRUNGSRI)
GSB	THE GOVERNMENT SAVINGS BANK
GHB	THE GOVERNMENT HOUSING BANK
BAAC	BANK FOR AGRICULTURE AND AGRICULTURAL COOPERATIVES
TISCO	TISCO BANK
KKP	KIATNAKIN BANK
LHBANK	LAND AND HOUSES BANK
TTB	TMBTHANACHART BANK
BOT	BANK OF THAILAND
CITI	CITIBANK, N.A.
StandardCB	STANDARD CHARTERED BANK (THAI) PUBLIC COMPANY LIMITED
BOC	BANK OF CHINA (THAI) PUBLIC COMPANY LIMITED
IBT	ISLAMIC BANK OF THAILAND
ICBC	INDUSTRIAL AND COMMERCIAL BANK OF CHINA (THAI) PUBLIC COMPANY LIMITED
LHB	LAND AND HOUSES BANK PUBLIC COMPANY LIMITED
JPMC	JP Morgan Chase Bank Bangkok Branch
SMBC	Sumitomo Mitsui Banking Corporation
HSBC	Hongkong and Shanghai Banking Corporation
MEGAICBC	Mega International Commercial Bank
AMERICAB	Bank of America National Association
IOBA	Indian Overseas Bank
DEUTSCHE	Deutsche Bank A.G
MHCB	MIZUHO BANK, LTD. BANGKOK BRANCH
BNPP	BNP Paribas Bangkok Branch

Limit information

	Deposit amount rules
Deposit channel	Minimum single transaction	Maximum single transaction
BANK	20	150,000
QR	20	150,000

Request

Header Params

X-API-KEY

string

required

The public key applied by the merchant backend

Example:

02106af2a085fbfc6d1bb49f485205fcdfcc79a4ddb1913c72a271fedd24c2d7fe

X-API-NONCE

string

required

System timestamp accurate to milliseconds

Example:

1702279880267

X-API-SIGNATURE

string

required

signature

Example:

304502207a4a88a5b0def29b9dbbf8563112d090c0e0b793ff6a5c57fe9d4fd1254d8ecf022100ff63c279f5926069fa1d161598e8d3249cb90e9d728e88e514352cdae6feff72

Body Params application/json

amount

string

Amount

required

Using PROMPTPAY, the amount will have a floating value in the range of -1.99 to 0. For example, if you use 100 to create a deposit, the randomized amount in the QR code information may be 99.58 or 98.32. You need to pay according to the amount displayed in the QR code

body

string | null

Product description

optional

currency

string

Currency

required

Fixed to fill in THA

customerAccountNumber

string

User bank card

required

This item is required

customerContact

string | null

User's mobile phone

optional

User contact information format: Thailand starts with 66, such as: 662XXXXXXXX

customerEmail

string | null

User email

optional

customerName

string

User name

required

mchNo

string

Merchant number

required

mchOrderNo

string

Merchant order number

required

notifyUrl

string

Result notification address

required

returnUrl

string | null

Cashier return page

optional

subject

string | null

Product Title

optional

wayCode

string

Payment Method Code

required

CASHIER-Cashier Mode Non-CASHIER-Reference Collection Method Code

bankName

string

Bank Name

required

Please check the bank name code

Example

{
    "amount": "100",
    "customerContact": "01085230144",
    "mchOrderNo": "D1730277342330",
    "customerEmail": "199199@gmail.com",
    "wayCode": "PROMPTPAY",
    "notifyUrl": "https:/notifyUrl.com",
    "currency": "THA",
    "bankName": "BBL",
    "customerAccountNumber": "01817999051",
    "returnUrl": "https://returnUrl.com",
    "mchNo": "M1688444708",
    "customerName": "GDW"
}

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 - 0 - Failure

data

object

Response Data

required

amount

string

Order Amount

required

body

string

Product Description

required

countryCode

string

Country Code

required

currency

string

Currency

required

Fixed value THA

customerContact

string

User Phone Number

required

mchOrderNo

string

Merchant Order Number

required

orderState

integer

Order Status

required

payDataType

string

Payment Mode

required

payurl - Cashier Desk, Non - payurl - Merchant Self - built Cashier Desk

payData

string

Payment Data

required

When using the merchant's self - built cashier desk, this field returns a VA code, e - wallet jump link, or QR image link. The merchant can determine how to handle this field based on the collected payment code of the order

payOrderId

string

Payment Platform Order Number

required

payUrl

string

Cashier Desk Address

required

In cashier desk order mode, return this link to the frontend

payWays

object

required

subject

string

Product Title

required

depositAmount

string

Amount to be Paid

required

Only displayed when using PROMPTPAY, the actual amount to be paid by the user

msg

string

Response Description

required

sign

string

required

Examples

Checkout success exampleBANK Success ExamplePROMPTPAY Success Example

{
    "code": 0,
    "data": {
        "amount": "50",
        "body": "Test",
        "countryCode": "th",
        "currency": "THA",
        "customerContact": "13116709877",
        "mchOrderNo": "TG2520230300170",
        "orderState": 0,
        "payDataType": "payurl",
        "payOrderId": "P1742757150174674946",
        "payUrl": "https://payment.tpservice.ai/#/order/th/P1742757150174674946",
        "payWays": {
            "TRUEMONEY": [
                {
                    "countryCode": "th",
                    "createdAt": 0,
                    "id": 60,
                    "payWay": "TRUEMONEY",
                    "payWayLogo": "https://tarspay.oss-ap-southeast-1.aliyuncs.com/tarspay_v_1.0/f11776e0-702d-4520-82f5-f6efa066490c.png",
                    "payWayType": "TRUEMONEY",
                    "skipMode": 2,
                    "state": 1,
                    "updatedAt": 0
                }
            ],
            "PROMPTPAY": [
                {
                    "countryCode": "th",
                    "createdAt": 0,
                    "id": 59,
                    "payWay": "PROMPTPAY",
                    "payWayLogo": "https://tarspay.oss-ap-southeast-1.aliyuncs.com/tarspay_v_1.0/363afea6-c8cf-46ae-948d-5517a258ecfd.png",
                    "payWayType": "PROMPTPAY",
                    "skipMode": 3,
                    "state": 1,
                    "updatedAt": 0
                }
            ],
            "BANK": [
                {
                    "countryCode": "th",
                    "createdAt": 0,
                    "id": 58,
                    "payWay": "BANK",
                    "payWayLogo": "https://tarspay.oss-ap-southeast-1.aliyuncs.com/tarspay_v_1.0/bf8f03a8-0d2b-40b0-b65c-18e01ce1597a.png",
                    "payWayType": "BANK",
                    "skipMode": 1,
                    "state": 1,
                    "updatedAt": 0
                }
            ]
        },
        "subject": "buycar"
    },
    "msg": "SUCCESS",
    "sign": "3045022006c26a41d4cac3be103b9ba00926fef05b0e27116f3cdae3b573b0d5c8399d37022100b99650ff4134ecf0b638317f34087bc7747b97d4e76564aa627982b63e037d7a"
}

Create a deposit order

deposit method#

bank name#

Limit information#

Request

Request samples

Responses

deposit method

bank name

Limit information