รับยอดคงเหลือ API
🚧 อัปเดตเอกสาร API – มีผลวันที่ 10 มิถุนายน 2025
เอกสารนี้ใช้แทนที่เวอร์ชันก่อนหน้า ซึ่งจะเลิกใช้งานอย่างเป็นทางการตั้งแต่วันที่ 10 มิถุนายน 2025
🔄 Key Changes:
- ส่วน BrickFlex ถูกลบออกจากการตอบกลับแล้ว
- ตอนนี้ BrickPay ถูกแยกออกเป็น:
- ใช้งานได้สมดุล
- ยอดคงเหลือที่รอดำเนินการ
- ขณะนี้ข้อมูลการชำระบัญชีในวันเดียวกัน (SDS) ได้รวมอยู่ในการตอบกลับแล้ว
โปรดตรวจสอบให้แน่ใจว่าการบูรณาการของคุณได้รับการอัปเดตตามนั้น โปรดแจ้งให้เราทราบหากคุณต้องการความช่วยเหลือเกี่ยวกับการเปลี่ยนแปลงนี้
📘 สภาพแวดล้อมสำหรับ URL ปลายทาง
- แซนด์บ็อกซ์: https://sandbox.onebrick.io/v2/payments/gs
- จำนวนผลิต: https://api.onebrick.io/v2/payments/gs
ขอพารามิเตอร์
| พารามิเตอร์ที่สำคัญ | ประเภทข้อมูล | คำอธิบาย |
|---|---|---|
| โทเค็นการเข้าถึงสาธารณะ | สตริง | โทเค็นการเข้าถึงครั้งเดียวที่สร้างขึ้นโดยใช้โทเค็นการตรวจสอบสิทธิ์ API |
พารามิเตอร์การตอบสนอง
| พารามิเตอร์ที่สำคัญ | ชนิดข้อมูล | คำอธิบาย |
|---|---|---|
| ความสมดุล | วัตถุ | ประกอบด้วยฟิลด์สำคัญที่เกี่ยวข้องกับยอดคงเหลือในบัญชีของคุณ: usableBalance, pendingBalance และ TotalBalance |
| ใช้งานได้สมดุล | หมายเลข | ยอดคงเหลือที่สามารถนำไปใช้ทำธุรกรรมได้ทันที เสมอ ≥ 0 |
| อยู่ระหว่างดำเนินการยอดคงเหลือ | หมายเลข | ยอดเงินที่ได้รับแล้วแต่ยังอยู่ในระหว่างรอการชำระหนี้ เสมอ ≥ 0 |
| ยอดคงเหลือทั้งหมด | หมายเลข | ผลรวมของยอดคงเหลือที่ใช้งานได้และยอดคงเหลือที่รอดำเนินการ |
| SameDaySettlement | วัตถุ | อธิบายการตั้งค่าการชำระเงินในวันเดียวกัน (SDS) ของคุณ รวมถึง isActive และ EarlySettlementBalanceQuota |
| คือใช้งานอยู่ | บูลีน | ระบุว่าการชำระเงินในวันเดียวกันนั้นเปิดใช้งานอยู่สำหรับบัญชีของคุณหรือไม่ |
| EarlySettlementยอดคงเหลือโควต้า | หมายเลข | จำนวนยอดเงินคงเหลือ (ในสกุลเงินท้องถิ่นของคุณ) ที่มีอยู่สำหรับการใช้งานการชำระเงินในวันเดียวกันวันนี้ เสมอ ≥ 0 |
Last modified on