Brick API Documentation
Brick

การเบิกจ่าย BI-FAST API

การเบิกจ่าย BI-FAST API เป็นจุดสิ้นสุดการส่งเงินของ Brick สำหรับการสร้างการจ่ายเงินด้วยการโอนเงินผ่านธนาคารผ่านเครือข่าย BI-FAST ใช้ API นี้เมื่อธนาคารผู้รับมีสิทธิ์ได้รับ BI-FAST และจำนวนธุรกรรมของคุณตรงกับข้อกำหนดการโอน BI-FAST สำหรับบัญชีของคุณ

คำขอเบิกจ่าย BI-FAST ประกอบด้วยจำนวนเงินที่ชำระ referenceId เฉพาะของคุณ รายละเอียดบัญชีธนาคารของผู้รับ และข้อมูลผู้ส่งที่จำเป็นสำหรับการประมวลผล BI-FAST หลังจากสร้างคำขอแล้ว ให้ติดตามผลลัพธ์สุดท้ายผ่านการเรียกกลับหรือจุดสิ้นสุดสถานะ แทนที่จะอาศัยเฉพาะการตอบสนองของ API เริ่มต้นเท่านั้น

เมื่อใดจึงควรใช้การเบิกจ่าย BI-FAST

ใช้การชำระเงิน BI-FAST เมื่อ:

  • ธนาคารปลายทางรองรับ BI-FAST;
  • จำนวนเงินที่จ่ายอยู่ภายในขีดจำกัด BI-FAST ที่เกี่ยวข้อง
  • การบูรณาการของคุณสามารถระบุตัวตนของผู้ส่ง ที่อยู่ และข้อมูลงานที่จำเป็นได้ และ
  • ระบบของคุณสามารถจัดการการอัปเดตสถานะแบบอะซิงโครนัสผ่านการเรียกกลับหรือการตรวจสอบสถานะ

ขอพารามิเตอร์

พารามิเตอร์ที่สำคัญประเภทข้อมูลคำอธิบาย
โทเค็นการเข้าถึงสาธารณะสตริงโทเค็นการเข้าถึงครั้งเดียวที่สร้างขึ้นโดยใช้โทเค็นการตรวจสอบสิทธิ์ API
รหัสอ้างอิงสตริงรหัสอ้างอิงที่ไม่ซ้ำกันเป็นตัวระบุที่ไม่ซ้ำกัน
จำนวนจำนวนเต็มจำนวนเงินที่จะจ่าย
อีเมลผู้รับสตริงอีเมล์ของผู้รับโอน ระบบจะส่งอีเมลและหลักฐานการโอน PDF มาที่อีเมลนี้
คำอธิบายสตริงสตริงที่กำหนดเองแนบกับวัตถุ มักมีประโยชน์ในการแสดงให้ผู้ใช้เห็นว่าธุรกรรมมีไว้เพื่ออะไร ขีดจำกัดความยาวคำอธิบายคือ 255 ตัวอักษร
ประเภทสตริงขณะนี้รองรับเฉพาะ "bank_transfer" เท่านั้น
เลขที่บัญชีธนาคารสตริงหมายเลขบัญชีของผู้ใช้ผู้รับ
ธนาคาร ShortCodeสตริงรหัสย่อของสถาบันของบัญชีธนาคารของผู้ใช้ผู้รับ
ชื่อผู้ถือบัญชีธนาคารสตริงชื่อบัญชีที่ต้องการส่งเงินไป

พารามิเตอร์คำขอเพิ่มเติมสำหรับ BI-FAST

พารามิเตอร์ที่สำคัญประเภทข้อมูลคำอธิบายข้อจำกัด
ชื่อสตริงชื่อของผู้ใช้ที่ส่งเงิน1. ตัวเลขอัลฟ่า 2. เว้นวรรคได้ 3. สูงสุด 40 ตัวอักษร
ประเภทตัวตนสตริงค่าที่อนุญาตเฉพาะ KTP/SIM/KITAS/NPWPค่าที่อนุญาตเฉพาะ KTP/SIM/KITAS/NPWP
หมายเลขประจำตัวสตริงหมายเลขประจำตัวของผู้ใช้1. ตัวเลขอัลฟ่า 2. ขั้นต่ำ 10 ตัวอักษร 3. สูงสุด 16 ตัวอักษร
รหัสประเทศสตริงรหัสประเทศสองตัวอักษรสำหรับผู้ส่งค่าที่อนุญาต: 2 ตัวพิมพ์ใหญ่
รหัสจังหวัดสตริงรหัสจังหวัดสองตัวอักษรสำหรับผู้ส่งค่าที่อนุญาต: 2 ตัวพิมพ์ใหญ่
รหัสเมืองสตริงรหัสเมืองสี่ตัวอักษรสำหรับผู้ส่งค่าที่อนุญาต: อักขระตัวพิมพ์ใหญ่ 4 ตัว
รหัสงานสตริงรหัสงานสี่ตัวอักษรสำหรับผู้ส่งค่าที่อนุญาต: อักขระตัวพิมพ์ใหญ่ 4 ตัว
ที่อยู่สตริงที่อยู่ของผู้ใช้1. ตัวเลขอัลฟ่า 2. เว้นวรรคได้ 3. สูงสุด 40 ตัวอักษร
สถานที่เกิดสตริงสถานที่เกิดของผู้ใช้1. ตัวเลขอัลฟ่า 2. เว้นวรรคได้ 3. สูงสุด 40 ตัวอักษร
วันเกิดสตริงวันเกิดของผู้ใช้รูปแบบ ปปปป-ดด-วว

การทดสอบในสภาพแวดล้อม Sandbox (โหมด Testing)

เพื่อจำลองสถานะธุรกรรมต่างๆ ให้ใช้อินพุตตัวอย่างด้านล่างเมื่อเรียก Disbursement API ในสภาพแวดล้อม sandbox:

การเบิกจ่าย BI-Fast

รหัสย่อธนาคารเลขที่บัญชีธนาคารชื่อเจ้าของบัญชีธนาคารจำนวนเงินสถานะที่คาดหวัง
BCA010800041187JOHN CENARp10.000 - Rp250.000.000Completed
BCA7095560835JOHN CENARp10.000 - Rp250.000.000Processing

หมายเหตุสำคัญสำหรับการทดสอบ Sandbox:

  • จำนวนเงิน: ต้องอยู่ในช่วง Rp10.000 ถึง Rp250.000.000

พารามิเตอร์การตอบสนอง

พารามิเตอร์ที่สำคัญชนิดข้อมูลคำอธิบาย
รหัสสตริงตัวระบุที่ไม่ซ้ำ
ประเภทสตริงประเภทของธุรกรรม
สถานะสตริงสถานะของการเบิกจ่าย
สร้างขึ้นที่ประทับเวลาเวลาที่สร้างการตอบกลับ
ความล้มเหลวเหตุผลสตริงสาเหตุของการทำธุรกรรมล้มเหลว ฟิลด์นี้จะแสดงเฉพาะเมื่อการทำธุรกรรมล้มเหลว
จำนวนสตริงจำนวนเงินที่จะจ่าย
ค่าธรรมเนียมจำนวนเงินสตริงค่าธรรมเนียมการทำธุรกรรม
รหัสอ้างอิงสตริงรหัสอ้างอิงที่ไม่ซ้ำกันเป็นตัวระบุที่ไม่ซ้ำกัน
คำอธิบายสตริงสตริงที่กำหนดเองแนบกับวัตถุ มักมีประโยชน์ในการแสดงให้ผู้ใช้เห็นว่าธุรกรรมมีไว้เพื่ออะไร ขีดจำกัดความยาวคำอธิบายคือ 255 ตัวอักษร
ประเภทวิธีการชำระเงินสตริงปัจจุบันรองรับการโอนเงินผ่านธนาคารเท่านั้น
เลขที่บัญชีธนาคารสตริงหมายเลขบัญชีของผู้ใช้
ธนาคาร ShortCodeสตริงรหัสย่อสถาบันของผู้ใช้
ชื่อผู้ถือบัญชีธนาคารสตริงชื่อบัญชีที่ต้องการส่งเงินไป
ชื่อธนาคารสตริงชื่อของสถาบัน
สถานะการตั้งถิ่นฐานสตริงสถานะของการชำระธุรกรรม

พารามิเตอร์การตอบสนองเพิ่มเติมสำหรับ BI-FAST

พารามิเตอร์ที่สำคัญประเภทข้อมูลคำอธิบาย
ชื่อสตริงชื่อของผู้ใช้ที่ส่งเงิน
ประเภทตัวตนสตริงค่าที่อนุญาตเฉพาะ KTP/SIM/KITAS/NPWP
หมายเลขประจำตัวสตริงหมายเลขประจำตัวของผู้ใช้
รหัสประเทศสตริงรหัสประเทศขึ้นอยู่กับผู้ใช้
รหัสจังหวัดสตริงรหัสจังหวัดขึ้นอยู่กับผู้ใช้
รหัสเมืองสตริงรหัสเมืองขึ้นอยู่กับผู้ใช้
รหัสงานสตริงรหัสงานขึ้นอยู่กับผู้ใช้
ที่อยู่สตริงที่อยู่ของผู้ใช้
สถานที่เกิดสตริงสถานที่เกิดของผู้ใช้
วันเกิดสตริงวันเกิดของผู้ใช้

❗️ หมายเหตุสำคัญเกี่ยวกับการตอบกลับของ API

หากระบบของคุณไม่ได้รับการตอบกลับ HTTP 200 พร้อมด้วยสถานะธุรกรรมที่ถูกต้อง (กำลังประมวลผล เสร็จสมบูรณ์ หรือล้มเหลว) คุณต้องไม่ตั้งค่าสถานะธุรกรรมว่าสำเร็จหรือล้มเหลว

การตอบสนองที่ไม่ใช่ 200 (เช่น หมดเวลา ข้อผิดพลาด 5xx หรือไม่ตอบสนอง) หมายความว่าผลลัพธ์ไม่แน่นอน และคุณควรถือว่าธุรกรรมอยู่ระหว่างดำเนินการจนกว่าคุณจะยืนยันสถานะผ่านสถานะ API

Last modified on