QR Code แบบไดนามิก

Server

สร้าง ทดสอบ และตรวจสอบรหัส QRIS QR แบบไดนามิกสำหรับการชำระเงินของลูกค้า รหัส QR แบบไดนามิกถูกสร้างขึ้นต่อธุรกรรม และควรปรับยอดผ่าน callbacks หรือการสอบถามสถานะ

สร้างไดนามิก QR Code

POST

https://sandbox.onebrick.io

/v2/payments/gs/qris/dynamic

publicAccessToken (header)

สร้าง QRIS QR Code แบบไดนามิกสำหรับจำนวนเงินที่ชำระเฉพาะและ reference ID ใช้ endpoint นี้เมื่อธุรกรรมของลูกค้าทุกรายการจำเป็นต้องมี QR payload ที่ไม่ซ้ำกันสำหรับการเรียกเก็บเงิน การตอบกลับประกอบด้วยข้อมูล QR ที่สามารถแสดงผลได้ในขั้นตอนการชำระเงินของคุณ ในขณะที่สถานะการชำระเงินขั้นสุดท้ายควรได้รับการยืนยันผ่าน callbacks หรือสถานะ QR แบบไดนามิก endpoint

สร้างไดนามิก QR Code › Request Body

referenceId

string · required

การอ้างอิงเฉพาะของธุรกรรมจากฝั่งไคลเอ็นต์ (ความยาวสูงสุด 25 อักขระ)

amount

integer · int32 · required

จำนวนเงินที่ลูกค้าต้องการโอน

validityPeriod

string

ขั้นต่ำ 600 วินาที (10 นาที) สูงสุด 86,400 วินาที (24 ชั่วโมง) นับจากเวลาสร้าง หากไม่ได้ตั้งค่าไว้ ค่าเริ่มต้นจะเป็น 86,400 วินาที (24 ชั่วโมง)

สร้างไดนามิก QR Code › Responses

200

status

integer

Default: 0

object

error

POST/v2/payments/gs/qris/dynamic

curl https://sandbox.onebrick.io/v2/payments/gs/qris/dynamic \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'publicAccessToken: <api-key>' \
  --data '{
  "referenceId": "referenceId",
  "amount": 0,
  "validityPeriod": "validityPeriod"
}'

Example Request Body

{
  "referenceId": "referenceId",
  "amount": 0,
  "validityPeriod": "validityPeriod"
}

json

Example Responses

{
    "status": 200,
    "data": {
        "message": "We have successfully generated the dynamic qris",
        "id":"QR_7d13c668fea84081832d02368c61af69",
        "referenceId": "test-qris-sandbox",
        "amount": 10000,
        "createdAt": "2024-01-16T17:00:00.000+07:00",
        "expiredAt": "2024-01-17T17:00:00.000+07:00",
        "qrData": "00020101021226670016COM.NOBUBANK.WWW01189360050300000491530214082500000318170303UKE51440014ID.CO.QR Code.WWW0215ID20200814004210303UKE5204549953033605405100005802ID5914BRICK PAYMENT 6015Banten - Kota T61051581162570114011200010968090620202401121013231606140703A010804POSP630443C4"
    },
    "metaData": {
        "source": "API",
        "entity": "Payment"
    },
    "error": null
}

json

application/json

สถานะสำหรับไดนามิก QR Code

GET

https://sandbox.onebrick.io

/v2/payments/gs/qris/dynamic/{referenceId}

publicAccessToken (header)

ตรวจสอบสถานะล่าสุดของธุรกรรม QRIS แบบไดนามิกโดย reference ID ใช้ endpoint นี้เมื่อระบบของคุณต้องการยืนยันว่าการชำระเงิน QR ยังคงดำเนินการอยู่ ชำระแล้ว หมดอายุแล้ว หรือยังไม่ได้รับการแก้ไข โดยเป็นส่วนเสริม callbacks และมีประโยชน์สำหรับงานกระทบยอด การตรวจสอบการสนับสนุนลูกค้า และหน้าจอยืนยันการชำระเงิน

สถานะสำหรับไดนามิก QR Code › path Parameters

referenceId

string · required

referenceId ที่ไม่ซ้ำของธุรกรรม

สถานะสำหรับไดนามิก QR Code › Responses

200

status

integer

Default: 0

object

error

GET/v2/payments/gs/qris/dynamic/{referenceId}

curl https://sandbox.onebrick.io/v2/payments/gs/qris/dynamic/:referenceId \
  --header 'publicAccessToken: <api-key>'

Example Responses

{
    "status": 200,
    "data": {
        "id": "QR_7d13c668fea84081832d02368c61af69",
        "referenceId": "test-qris-sandbox",
        "amount": 10000,
        "status": "processing",
        "qrData": "00020101021226670016COM.NOBUBANK.WWW01189360050300000491530214082500000318170303UKE51440014ID.CO.QR Code.WWW0215ID20200814004210303UKE5204549953033605405100005802ID5914BRICK PAYMENT 6015Banten - Kota T61051581162570114011200010968090620202401121013231606140703A010804POSP630443C4",
        "paidAt": null
    },
    "metaData": {
        "source": "API",
        "entity": "Payment"
    },
    "error": null
}

json

application/json

การทดสอบ QR Code ใน Sandbox

POST

https://sandbox.onebrick.io

/v2/payments/gs/qris/update-status-sandbox

publicAccessToken (header)

จำลองการเปลี่ยนแปลงสถานะการชำระเงิน QRIS ในสภาพแวดล้อมแบบแซนด์บ็อกซ์ เพื่อให้ทีมของคุณสามารถทดสอบการจัดการและการกระทบยอด callback ก่อนการผลิตได้ ใช้ endpoint นี้หลังจากสร้างแซนด์บ็อกซ์ไดนามิก QR Code เพื่อย้ายธุรกรรมไปยังสถานะทดสอบที่ต้องการ อย่าใช้เพื่อการชำระเงินการผลิตหรือธุรกรรมของลูกค้าแบบเรียลไทม์

การทดสอบ QR Code ใน Sandbox › Request Body

referenceId

string · required

referenceId ที่ไม่ซ้ำของธุรกรรม

status

string · required

สถานะที่ต้องการบรรลุ (PAID/COMPLETED)

Default: PAID/COMPLETED

การทดสอบ QR Code ใน Sandbox › Responses

200

status

integer

Default: 0

data

string

object

error

Ewallet QR Code แบบคงที่

สร้างไดนามิก QR Code

POST

https://sandbox.onebrick.io

/v2/payments/gs/qris/dynamic

publicAccessToken (header)

สร้างไดนามิก QR Code › Request Body

referenceId

string · required

การอ้างอิงเฉพาะของธุรกรรมจากฝั่งไคลเอ็นต์ (ความยาวสูงสุด 25 อักขระ)

amount

integer · int32 · required

จำนวนเงินที่ลูกค้าต้องการโอน

validityPeriod

string

สร้างไดนามิก QR Code › Responses

200

status

integer

Default: 0

object

error

สถานะสำหรับไดนามิก QR Code

GET

https://sandbox.onebrick.io

/v2/payments/gs/qris/dynamic/{referenceId}

publicAccessToken (header)

สถานะสำหรับไดนามิก QR Code › path Parameters

referenceId

string · required

referenceId ที่ไม่ซ้ำของธุรกรรม

สถานะสำหรับไดนามิก QR Code › Responses

200

status

integer

Default: 0

object

error

การทดสอบ QR Code ใน Sandbox

POST

https://sandbox.onebrick.io

/v2/payments/gs/qris/update-status-sandbox

publicAccessToken (header)

การทดสอบ QR Code ใน Sandbox › Request Body

referenceId

string · required

referenceId ที่ไม่ซ้ำของธุรกรรม

status

string · required

สถานะที่ต้องการบรรลุ (PAID/COMPLETED)

Default: PAID/COMPLETED

การทดสอบ QR Code ใน Sandbox › Responses

200

status

integer

Default: 0

data

string

object

error