Brick API Documentation
Brick
Brick API

Checkout Page

Server

สร้างและตรวจสอบเซสชัน Brick Checkout Page ที่โฮสต์ Checkout Page มีประโยชน์เมื่อคุณต้องการลิงก์การชำระเงินที่แชร์ได้หรือหน้าการชำระเงินที่โฮสต์ไว้โดยไม่ต้องสร้างวิธีการชำระเงินทุกวิธี UI ด้วยตัวเอง


สร้างเซสชัน Checkout Page

POST
https://sandbox.onebrick.io
/v1/payments/checkout
publicAccessToken (header)

สร้างเซสชัน Brick Checkout Page ที่โฮสต์ และรับ checkoutUrl ที่สามารถแชร์กับลูกค้าได้ ใช้ Checkout Page เมื่อคุณต้องการให้ Brick โฮสต์ประสบการณ์การชำระเงินผ่านวิธีการที่รองรับ แทนที่จะสร้างการชำระเงินแต่ละรายการ UI ด้วยตัวเอง คำขอจะกำหนดจำนวนเงิน สกุลเงิน รายละเอียดลูกค้า วันหมดอายุ และบริบท callback สำหรับการกระทบยอดในภายหลัง

สร้างเซสชัน Checkout Page › Headers

publicAccessToken
​string · required

ผู้ถือ `. เช็ค /getting-started/generate-public-access-token-jwt-token

สร้างเซสชัน Checkout Page › Request Body

externalId
​string · required

ตัวระบุที่ไม่ซ้ำกันที่ผู้ขายกำหนดสำหรับเซสชันการชำระเงิน

currency
​string · required

สกุลเงินของธุรกรรม ใช้ IDR สำหรับโฟลว์ Receive Money ปัจจุบัน

description
​string · required

ป้ายกำกับ Checkout แสดงให้ลูกค้าเห็นและใช้สำหรับการปรับยอด

amount
​number · double

จำนวนเงินที่ชำระคงที่ หากละเว้น การชำระเงินอาจทำงานเป็นกระแสจำนวนเงินที่เปิดอยู่

type
​string

ประเภทการชำระเงิน คอลเลกชันที่ทดสอบรองรับ qris และ virtual_account

สร้างเซสชัน Checkout Page › Responses

200

status
​integer
Default: 0
​object
errors
​
hashcode
​string

สถานะ Checkout

GET
https://sandbox.onebrick.io
/v1/payments/checkout/status
publicAccessToken (header)

รับสถานะล่าสุดของเซสชัน Checkout Page ที่โฮสต์ ใช้ endpoint นี้เพื่อปรับลิงก์การชำระเงิน การชำระเงินตามคำสั่งซื้อ หรือกรณีการสนับสนุนลูกค้า เมื่อคุณมีการอ้างอิงเซสชันการชำระเงิน การตอบกลับจะยืนยันว่าเซสชันอยู่ระหว่างรอดำเนินการ ชำระเงิน หมดอายุ ล้มเหลว หรือพร้อมสำหรับการติดตามผลในระบบของคุณ

สถานะ Checkout › query Parameters

checkoutId
​string

ตัวระบุการชำระเงินที่สร้างโดย Brick ส่งคืนจาก POST /v1/payments/checkout.

externalId
​string

ชำระเงิน externalId

สถานะ Checkout › Responses

200

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object
type = object
type = object
type = object
Properties for สร้างแล้ว:
status
​integer
Default: 0
​object
errors
​
hashcode
​string