Create Pay-in Order
Merchants initiate pay-in (collection) orders via this interface. The platform generates a corresponding payment URL or parameters for the user to complete the payment.
Interface Info
- Endpoint:
/payin/create - HTTP Method:
POST - Content-Type:
application/json; charset=utf-8
Request Header Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| merchantNo | Yes | string | Merchant Number |
| sign | Yes | string | RSA Signature (Refer to Global Specification) |
Request Body Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| timestamp | Yes | Long | Millisecond timestamp |
| merchantOrderNo | Yes | string | Merchant order number (Unique) |
| amount | Yes | string | Order amount (up to 2 decimal places) |
| payType | Yes | string | Payment Type: QR (Aggregate QR Code), BANK (Bank Transfer) |
| bankCode | No | string | Bank Code. Required when payType is BANK |
| accountNo | No | string | Bank Account Number. Required when payType is BANK |
| accountName | Yes | string | Account Name / Payer Name |
| mobile | Yes | string | Payer's mobile number. Format: must start with 06, 08, or 09 |
| notifyUrl | Yes | string | Asynchronous callback notification URL |
| No | string | Payer Email | |
| remark | No | string | Remarks |
Response Examples
json
{
"code": 1,
"msg": "success",
"data": {
"merchantNo": "M1639466186292",
"merchantOrderNo": "202112151143188593456",
"platOrderNo": "876324486452871168",
"amount": "220.00",
"fee": "0.00",
"payType": "QR",
"payUrl": "https://api.xxx.com/pay/gate?id=876324486452871168",
"expireTime": "2026-05-05 11:11:11",
"status": "1"
}
}json
{
"code": 0,
"msg": "param merchant error"
}Response Parameter Description
| Parameter | Type | Description |
|---|---|---|
| code | number | 1 for Success, 0 for Failure |
| msg | string | Message explanation |
| data | object | Returned data payload upon success |
| └ merchantNo | string | Merchant Number |
| └ merchantOrderNo | string | Merchant Order Number |
| └ platOrderNo | string | Platform Order Number |
| └ amount | string | Amount |
| └ fee | string | Service Fee |
| └ payType | string | Payment Type: THAI_DYNAMIC_QR, BANK |
| └ payUrl | string | Payment URL / Invocation parameter |
| └ expireTime | string | Expiration Time (Format: yyyy-MM-dd HH:mm:ss) |
| └ status | string | Status: 0 Created, 1 Processing, 2 Failed, 3 Success |
Bank Code List
When payType is BANK, the bankCode must be chosen from the following list:
| bankCode | Bank Name (EN) | Bank Name (TH) |
|---|---|---|
| BBL | BANGKOK BANK PUBLIC COMPANY LTD. | ธ. กรุงเทพ จำกัด (มหาชน) |
| KBANK | KASIKORNBANK PUBLIC COMPANY LTD. | ธ. กสิกรไทย จำกัด (มหาชน) |
| KTB | KRUNG THAI BANK PUBLIC COMPANY LTD. | ธ. กรุงไทย จำกัด (มหาชน) |
| TTB | TMBTHANACHART BANK PUBLIC COMPANY LIMITED | ธ. ทหารไทยธนชาต จำกัด (มหาชน) |
| SCB | SIAM COMMERCIAL BANK PUBLIC COMPANY LTD | ธ. ไทยพาณิชย์ จำกัด (มหาชน) |
| SCBT | STANDARD CHARTERED BANK (THAI) PUBLIC COMPANY LIMITED | ธ. สแตนดาร์ดชาร์เตอร์ด (ไทย) จำกัด (มหาชน) |
| CIMBT | CIMB THAI BANK PUPBLIC COMPANY LTD. | ธ. ซีไอเอ็มบี ไทย จำกัด (มหาชน) |
| UOBT | UNITED OVERSEAS BANK (THAI) PUBLIC COMPANY LIMITED | ธ. ยูโอบี จำกัด (มหาชน) |
| BAY | BANK OF AYUDHYA PUBLIC COMPANY LIMITED | ธ. กรุงศรีอยุธยา จำกัด (มหาชน) |
| GSB | THE GOVERNMENT SAVINGS BANK | ธ. ออมสิน |
| GHB | THE GOVERNMENT HOUSING BANK | ธ. อาคารสงเคราะห์ |
| BAAC | BANK FOR AGRICULTURE AND AGRICULTURAL COOPERATIVES | ธ. เพื่อการเกษตรและสหกรณ์การเกษตร |
| TISCO | TISCO BANK PUBLIC COMPANY LIMITED | ธ. ทิสโก้ จำกัด (มหาชน) |
| TCR | THE THAI CREDIT RETAIL BANK PUBLIC COMPANY LIMITED | ธ. ไทยเครดิต เพื่อรายย่อย จำกัด (มหาชน) |
| LHBANK | LAND AND HOUSES BANK PUBLIC COMPANY LIMITED | ธ. แลนด์แอนด์เฮ้าส์ จำกัด (มหาชน) |
| SME | SME BANK | ธ. พัฒนาวิสาหกิจขนาดกลางและขนาดย่อม |
