Skip to content

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

ParameterRequiredTypeDescription
merchantNoYesstringMerchant Number
signYesstringRSA Signature (Refer to Global Specification)

Request Body Parameters

ParameterRequiredTypeDescription
timestampYesLongMillisecond timestamp
merchantOrderNoYesstringMerchant order number (Unique)
amountYesstringOrder amount (up to 2 decimal places)
payTypeYesstringPayment Type: QR (Aggregate QR Code), BANK (Bank Transfer)
bankCodeNostringBank Code. Required when payType is BANK
accountNoNostringBank Account Number. Required when payType is BANK
accountNameYesstringAccount Name / Payer Name
mobileYesstringPayer's mobile number. Format: must start with 06, 08, or 09
notifyUrlYesstringAsynchronous callback notification URL
emailNostringPayer Email
remarkNostringRemarks

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

ParameterTypeDescription
codenumber1 for Success, 0 for Failure
msgstringMessage explanation
dataobjectReturned data payload upon success
merchantNostringMerchant Number
merchantOrderNostringMerchant Order Number
platOrderNostringPlatform Order Number
amountstringAmount
feestringService Fee
payTypestringPayment Type: THAI_DYNAMIC_QR, BANK
payUrlstringPayment URL / Invocation parameter
expireTimestringExpiration Time (Format: yyyy-MM-dd HH:mm:ss)
statusstringStatus: 0 Created, 1 Processing, 2 Failed, 3 Success

Bank Code List

When payType is BANK, the bankCode must be chosen from the following list:

bankCodeBank Name (EN)Bank Name (TH)
BBLBANGKOK BANK PUBLIC COMPANY LTD.ธ. กรุงเทพ จำกัด (มหาชน)
KBANKKASIKORNBANK PUBLIC COMPANY LTD.ธ. กสิกรไทย จำกัด (มหาชน)
KTBKRUNG THAI BANK PUBLIC COMPANY LTD.ธ. กรุงไทย จำกัด (มหาชน)
TTBTMBTHANACHART BANK PUBLIC COMPANY LIMITEDธ. ทหารไทยธนชาต จำกัด (มหาชน)
SCBSIAM COMMERCIAL BANK PUBLIC COMPANY LTDธ. ไทยพาณิชย์ จำกัด (มหาชน)
SCBTSTANDARD CHARTERED BANK (THAI) PUBLIC COMPANY LIMITEDธ. สแตนดาร์ดชาร์เตอร์ด (ไทย) จำกัด (มหาชน)
CIMBTCIMB THAI BANK PUPBLIC COMPANY LTD.ธ. ซีไอเอ็มบี ไทย จำกัด (มหาชน)
UOBTUNITED OVERSEAS BANK (THAI) PUBLIC COMPANY LIMITEDธ. ยูโอบี จำกัด (มหาชน)
BAYBANK OF AYUDHYA PUBLIC COMPANY LIMITEDธ. กรุงศรีอยุธยา จำกัด (มหาชน)
GSBTHE GOVERNMENT SAVINGS BANKธ. ออมสิน
GHBTHE GOVERNMENT HOUSING BANKธ. อาคารสงเคราะห์
BAACBANK FOR AGRICULTURE AND AGRICULTURAL COOPERATIVESธ. เพื่อการเกษตรและสหกรณ์การเกษตร
TISCOTISCO BANK PUBLIC COMPANY LIMITEDธ. ทิสโก้ จำกัด (มหาชน)
TCRTHE THAI CREDIT RETAIL BANK PUBLIC COMPANY LIMITEDธ. ไทยเครดิต เพื่อรายย่อย จำกัด (มหาชน)
LHBANKLAND AND HOUSES BANK PUBLIC COMPANY LIMITEDธ. แลนด์แอนด์เฮ้าส์ จำกัด (มหาชน)
SMESME BANKธ. พัฒนาวิสาหกิจขนาดกลางและขนาดย่อม