Open API Reference for Bluepay

# 1.1 QR Code Create

# HTTP request info

# URL

{domain}/open-api/v2/jt/qrcode

# Method

POST

# Content-Type

application/json

# Request Param

Parameter name Required Type of data Length Example Description
appId Y string - - Application ID
param Y string - - Parameter Body
sign Y string - 45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892 Sign

# param

paramter name required type description
timestamp Yes long current timestamp
channelCode Yes string channel code, fixed value THAI_DYNAMIC_QR
mchOrderId Yes string mchOrderId, alphanumeric, max length 32
amount Yes integer amount (unit: cents)
businessType No integer businessType， 1、Direct Sale Store（If not filled，default - 1.Direct Sale Store） 2、Franchisees
projectType No string projectType， 'PPCASH','VIP','HOME' (If not filled，default 'PPCASH')
notifyUrl Yes string merchant payment notification URL
items No List items detail
remark No string remark

# Item parameter description

paramter name required type description
subOrderId Yes string subOrderId, alphanumeric, max length 32
customerName No string customer name
customerMobile No string customer mobile number(Mobile phone format: 06,08,09+8 digits (total 10 digits) Landline phone format: 02,03,04,05,07+7 digits (total 9 digits))
amount Yes int payment amount (unit: cents)
email No string customer email
regionNo Yes string region No(1-50 digits);Support uppercase and lowercase letters and numbers
branchNo Yes string branch No(1-100 digits);Support uppercase and lowercase letters and numbers
courierNo Yes string courier No(1-100 digits);Support uppercase and lowercase letters and numbers
courierName No string courier name(1-100 digits)
courierMobile No string courier mobile number(Mobile phone format: 06,08,09+8 digits (total 10 digits) Landline phone format: 02,03,04,05,07+7 digits (total 9 digits))

# Response parameters

paramter name type description
mchOrderId string mchOrderId, alphanumeric, max length 32
qrCodeId string QR Code transaction ID
qrCodeContent string QR Code content
channelCode string channel code
notifyUrl string merchant payment notification URL
remark string remark
transactionStatus string transaction status (PENDING, COMPLETED, FAILED)
qrStatus string QR Code status (ACTIVE,INACTIVE, CANCELLED)
qrLink string customer payment guide URL
createTime string transaction create time
updateTime string transaction update time
amount integer amount (unit: cents)
fee integer fee (unit: cents)
totalAmount integer totalAmount(qrCode amount, unit: cents)
businessType integer businessType， 1、Direct Sale Store 2、Franchisees
projectType string projectType， 'PPCASH','VIP','HOME'
items List items detail

# Request example

# Param content

{
  "timestamp": 1676017834369,
  "channelCode": "THAI_DYNAMIC_QR",
  "mchOrderId": "PC880001",
  "businessType": 1,
  "projectType": "PPCASH",
  "amount": 140000,
  "notifyUrl": "https://example.com/",
  "items": [
    {
      "subOrderId": "PCW00000000003249",
      "customerName": "WalletUser Name",
      "customerMobile": "60128888888",
      "amount": 60000,
      "email": "example@example.com",
      "regionNo": "001",
      "branchNo": "F604602",
      "courierNo": "F6046024088",
      "courierName": "Courier Name",
      "courierMobile": "0912345678"
    },
    {
      "subOrderId": "PCW00000000003250",
      "customerName": "WalletUser Name",
      "customerMobile": "60128888888",
      "amount": 80000,
      "email": "example@example.com",
      "regionNo": "001",
      "branchNo": "F604602",
      "courierNo": "F6046024088",
      "courierName": "Courier Name",
      "courierMobile": "0912345678"
    }
  ],
  "remark": "remark"
}

How to construct request body

# Request body

{
  "appId": "c9b002aef1d7496c9df078d937896605",
  "sign": "tVa+aoAXH0ls1IoPznzkFyF+4v+iTZaCSttPWmYl1kCHeh8mwao8cqAD7Y7wdymcr9yavKh4bKT18KeLu27g7Q5GqhEQ0cm1dkARe+i2xoH32la4HAzBfPj9liULDawGoPbo739+FLgZnV79CLaiukvqtnkgI/Km6J/KccRPl2CtS4PUjxCyRicOAcv91KZiVOxyhoP9bKhvwtCkCIlkpBHKWskBPCxxfctoORjgXWj7FhRPLYBuRDaczfmr2um9aNXhVoH1XFZf7Gu67n6RmeB0kc2dHFPI89JEI0PwGq+bvbCAEUtHK4SlLexCtbMoCgGWKTJbSMDTvVF126jz8g==",
  "param": "{\"timestamp\":1676017834369,\"channelCode\":\"THAI_DYNAMIC_QR\",\"mchOrderId\":\"PC880001\",\"businessType\":1,\"amount\":140000,\"notifyUrl\":\"https://example.com/\",\"items\":[{\"subOrderId\":\"PCW00000000003249\",\"customerName\":\"WalletUser Name\",\"customerMobile\":\"09123456789\",\"amount\":60000,\"email\":\"pay@example.com\",\"regionNo\":\"001\",\"branchNo\":\"F604602\",\"courierNo\":\"F6046024088\",\"courierName\":\"Courier Name\",\"courierMobile\":\"09123456789\"},{\"subOrderId\":\"PCW00000000003250\",\"customerName\":\"WalletUser Name\",\"customerMobile\":\"09123456789\",\"amount\":80000,\"email\":\"pay@example.com\",\"regionNo\":\"001\",\"branchNo\":\"F604602\",\"courierNo\":\"F6046024088\",\"courierName\":\"Courier Name\",\"courierMobile\":\"09123456789\"}],\"remark\":\"remark\"}"
}

# Response example

code collection

{
  "code": 10000,
  "message": "Success",
  "data": {
    "mchOrderId": "PC880001",
    "qrcodeId": "QR1597145776390279168",
    "qrcodeContent": "iVBORw0KGgoAAAANSUhEUgAAAGQAAABkCAIAAAD/gAIDAAAACXBIWXMAAA7EAAAOxAGVKw4bAAACV0lEQVR4nO2cwY7CMAwF6Wr//5fZW1WJbOKx3QDSzBHatHpyzIsTfDyfz4fE+Hn3C3wTigVQLIBiARQL8Pv60XEcXaOfP7XnmPEf3+FrzG+/482vGFkAxQIoFmCQs64k/P0811y/HX7Y9Rpdb37FyAIoFmAxDU+6ZsrysuEF86cX/UR8whpZAMUCKBYgmrOKDJc78TXQh1QojSyAYgE2TcO4WU8UG7ZhZAEUC6BYgGjO6soaQ+sQZ1i0iD+xiJEFUCzAYhp2bQEkNiyWXn8+ZuPmxYmRBVAsgGIBjs0riXjdMuES7sbIAigWIDoNi/t9xVrC3DrEB4y7Dc86VFEsQGkhHQ/7+GWVOZ77AY17fSMLoFgAxQJEj0nGawBzirWEBMuEGM+SRhZAsQCZfcPKWjc3KeaGe/7openROtyCYgEUC5Ap/sWtQ+UA4x3rlWKWNLIAigXIFP+GVKzD8kHBmdLlNv7DyAIoFkCxAIuqw3ytMMwvxUMGibXLnMaDmUYWQLEAC+sQN9mViuBy8OGAc+swHyeHkQVQLIBiAQY5q7HC/0ouzXUdhIwnaK1DFcUCbDr5124sriQmV+5UhJEFUCzApi5HxeVxcBbnin8upG9BsQCKBdjU5WiYLNpdS7HlwfJ2IwugWIDdXY5yD7q16h/HyAIoFkCxAB/XXuX1ltyV/kf6zSgWYHezsSE52zFv3Bx3G578uwXFAigWYFOXo1v7uHf9w8KqQyeKBdjU5Wg4YHA747HaaOhqla516ESxAIoF2N3l6KsxsgCKBVAsgGIBFAugWIA/BQySrn6cOmYAAAAASUVORK5CYII=",
    "channelCode": "THAI_DYNAMIC_QR",
    "notifyUrl": "https://example.com/",
    "createTime": "2022-07-02 18:12:46",
    "updateTime": null,
    "remark": "test qrcode",
    "transactionStatus": "PENDING",
    "qrStatus": "ACTIVE",
    "amount": 140000,
    "fee": 2000,
    "totalAmount": 142000,
    "businessType": 1,
    "projectType": "PPCASH",
    "items": [
      {
        "subOrderId": "PCW00000000003249",
        "customerName": "WalletUser Name",
        "customerMobile": "60128888888",
        "amount": 60000,
        "email": "example@example.com",
        "regionNo": "001",
        "branchNo": "F604602",
        "courierNo": "F6046024088",
        "courierName": "Courier Name",
        "courierMobile": "0912345678"
      },
      {
        "subOrderId": "PCW00000000003250",
        "customerName": "WalletUser Name",
        "customerMobile": "60128888888",
        "amount": 80000,
        "email": "example@example.com",
        "regionNo": "001",
        "branchNo": "F604602",
        "courierNo": "F6046024088",
        "courierName": "Courier Name",
        "courierMobile": "0912345678"
      }
    ],
    "warning": ""
  }
}

← 1.2 QR Code Detail →