Brick API Documentation
Brick

เริ่มต้นอย่างรวดเร็วสำหรับการเบิกจ่าย API

ก่อนที่คุณจะเริ่ม:

  1. ตรวจสอบ Prepare Yourself to Use API ก่อนเริ่มการรวมระบบ
  2. คุณสามารถทดสอบ API ได้โดยใช้ Try Brick API with Postman

สร้างการเบิกจ่ายครั้งแรกของคุณ

สำหรับการเริ่มต้นอย่างรวดเร็วนี้ ให้ใช้วิธีการชำระเงินแบบปกติ Brick รองรับวิธีการชำระเงินสองวิธี: ปกติและ BI-FAST

1. สร้างโทเค็นการเข้าถึงสาธารณะ - API reference

โทเค็นการเข้าถึงสาธารณะคือโทเค็นการตรวจสอบสิทธิ์ที่ใช้ในการเรียก API เพิ่มเติมสำหรับการส่งเงินและรับเงิน APIs โทเค็นการเข้าถึงสาธารณะนี้สร้างขึ้นโดยใช้ข้อมูลรับรอง Client ID Client ID และ Client Secret ที่คุณได้รับจากส่วนการเตรียมการ

📘 ข้อจำกัดของโทเค็นการเข้าถึงสาธารณะ

API นี้ให้โทเค็นการเข้าถึงสาธารณะแก่คุณซึ่งใช้ได้เพียง 1 ครั้งและใน 5 นาทีถัดไปเท่านั้น หากหมดอายุ คุณจะต้องสร้างโทเค็นการเข้าถึงสาธารณะใหม่

2. ตรวจสอบบัญชีผู้รับ - API reference

ตรวจสอบบัญชีผู้รับก่อนสร้างการเบิกจ่าย ซึ่งจะช่วยป้องกันความล้มเหลวที่เกิดจากรหัสธนาคารไม่ถูกต้อง หมายเลขบัญชีไม่ถูกต้อง หรือรายละเอียดของเจ้าของบัญชีไม่ตรงกัน

📘 รายชื่อบัญชีธนาคารปลายทาง

หากคุณต้องการตรวจสอบว่าปลายทางการจ่ายเงินใดบ้างที่ครอบคลุมโดย Brick โปรดดูที่ Disbursement Coverage ปัจจุบัน Brick ตรวจสอบปลายทางของบัญชีธนาคาร ไม่ใช่ปลายทางของ Ewallet

3. สร้างการเบิกจ่าย - Regular API reference

ใช้ปลายทางนี้เพื่อส่งเงินไปยังบัญชีผู้รับ สร้างโทเค็นการเข้าถึงสาธารณะใหม่ตามที่อธิบายไว้ในขั้นตอนที่ 1 จากนั้นใช้โทเค็นใหม่สำหรับการเรียกการชำระเงิน API

คุณต้องระบุรายละเอียดการชำระเงินและผู้รับ ตัวอย่างด้านล่างแสดงโครงสร้างคำขอพื้นฐาน:

Code
curl --request POST \ --url https://sandbox.onebrick.io/v2/payments/gs/disbursements \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --header 'publicAccessToken: Bearer {{publicAccessToken}}' \ --data ' { "referenceId": "test-disbursement-1", "description": "test-disbursement-1", "amount": 10000, "disbursementMethod": { "type": "bank_transfer", "bankShortCode": "MANDIRI", "bankAccountNo": "12345678", "bankAccountHolderName": "PROD ONLY" } } '

หากคำขอถูกต้อง คำตอบจะแสดงสถานะการชำระเงินเป็น processing

JSONCode
{ "status": 200, "data": { "message": "We have received your request and are processing it, please check your callback URL for transaction status", "id": "asdasd123123asdasdasd", "type": "disbursement", "attributes": { "referenceId": "test-disbursement-1", "description": "test-disbursement-1", "amount": "10000", "status": "processing", "createdAt": "2022-07-21T13:49:39.752+07:00", "disbursementMethod": { "type": "bank_transfer", "bankAccountNo": "12345678", "bankShortCode": "BCA", "bankAccountHolderName": "PROD ONLY" } } }, "metaData": { "source": "API", "entity": "Payment" }, "error": null }

การดำเนินการเบิกจ่ายขึ้นอยู่กับธนาคารปลายทาง Brick จะส่งสถานะที่อัปเดตไปยัง URL ติดต่อกลับที่คุณกำหนดค่าไว้

4. รับสถานะการโทรกลับ

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

JSONCode
{ "data": { "id": "asdasd123123asdasdasd", "type": "disbursement", "attributes": { "referenceId": "test-disbursement-1", "description": "test-disbursement-1", "amount": "10000", "status": "completed", "createdAt": "2022-07-21T13:49:39.752+07:00", "disbursementMethod": { "type": "bank_transfer", "bankAccountNo": "12345678", "bankShortCode": "BCA", "bankAccountHolderName": "PROD ONLY", "bankName" : "Bank Central Asia" } } } }
JSONCode
{ "data": { "id": "9cb8ba6c8aa644ff9a433ace9", "type": "disbursement", "attributes": { "referenceId": "ps-123456", "description": "Good Luck", "amount": "10000", "status": "failed", "settlementStatus": null, "createdAt": "2025-02-12T16:25:11.000+07:00", "errorCode": "5000100", "errorReason": "General Error", "errorDetail": { "code": "general_error", "message": "General Error", "action": "Please try again later or contact support if the issue persists.", "reason": "A general error occurred while processing the request. This may be due to a temporary issue on our end." }, "disbursementMethod": { "type": "bank_transfer", "bankAccountNo": "010800041187", "bankShortCode": "BCA", "bankAccountHolderName": "Bambang Subambang", "bankName": "BCA" } } } }

คุณสามารถจัดการลักษณะการทำงานในภายหลังสำหรับสถานะเสร็จสมบูรณ์หรือตรวจสอบวิธีจัดการกับข้อผิดพลาดในกรณีต่างๆ

5. การถ่ายทอดสดสู่การผลิต

หลังจากที่คุณเสร็จสิ้นการพัฒนาและพร้อมที่จะย้ายไปสู่การผลิตแล้ว ให้ตรวจสอบ Production Checklist

Last modified on