Copy page

การยืนยันบัญชี API

การยืนยันบัญชี API คือจุดสิ้นสุดการตรวจสอบบัญชีธนาคาร Brick สำหรับการตรวจสอบรายละเอียดบัญชีธนาคารปลายทาง ส่งรหัสย่อของธนาคารและหมายเลขบัญชี จากนั้นใช้การตอบกลับเพื่อยืนยันว่า Brick สามารถตรวจสอบบัญชีผ่านเครือข่ายธนาคารที่รองรับได้หรือไม่

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

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

พารามิเตอร์ที่สำคัญ	ประเภทข้อมูล	คำอธิบาย
public_access_token	String	โทเค็นการเข้าถึงสาธารณะถูกสร้างขึ้นโดยใช้ clientId และ clientSecret ของคุณ และคุณสามารถดึงข้อมูลได้จาก endpoint นี้
accountNumber	String	หมายเลขบัญชีที่ต้องการส่งเงินไป
bankShortCode	String	นี่ควรเป็นสถาบันที่ลูกค้าปลายทางของคุณตั้งใจที่จะตรวจสอบ โปรดดู Validation Coverage สำหรับรายการปลายทางการตรวจสอบที่รองรับ

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

พารามิเตอร์ที่สำคัญ	ชนิดข้อมูล	คำอธิบาย
accountNo	String	หมายเลขบัญชีของผู้ใช้
bankShortCode	String	รหัสย่อสถาบันของผู้ใช้
accountName	String	ชื่อบัญชีสถาบันที่ต้องการส่งเงินไป
activityId	String	รหัสอ้างอิงที่ไม่ซ้ำกันสำหรับคำขอตรวจสอบบัญชีธนาคารแต่ละรายการ

Response examples

200 Success

Code
{
  "status": 200,
  "data": {
    "message": "We are successfully able to verify the account",
    "bankShortCode": "DANA",
    "accountNo": "08123412341234",
    "accountName": "beneficiary holder name",
    "activityId": "86569bbf0b017afb59cb71765eaec280"
  },
  "error": null,
  "metaData": {
    "source": "API",
    "entity": "Payment"
  }
}

400 Invalid format

Code
{
  "status": 400,
  "data": null,
  "error": {
    "code": "invalid_format",
    "message": "The bank account validation request could not be processed because one or more submitted fields are missing, invalid, or not in the required format.",
    "action": "Please review the request parameters and ensure the account number, bank code, and other required fields follow the required format before submitting again.",
    "reason": "The request contains invalid, incomplete, or improperly formatted information required to process the bank account validation."
  },
  "metaData": {
    "source": "API",
    "entity": "Payment"
  }
}

404 Account not found

Code
{
  "status": 404,
  "data": null,
  "error": {
    "code": "account_not_found",
    "message": "We were unable to verify the submitted bank account details. The account number, account holder name, or bank information may be incorrect or not available for validation.",
    "action": "Please review the account number, account holder name, and bank details, then submit the request again with the correct information.",
    "reason": "The provider could not find a matching bank account or account holder based on the submitted validation details."
  },
  "metaData": {
    "source": "API",
    "entity": "Payment"
  }
}

500 Internal server error

Code
{
  "status": 500,
  "data": null,
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "message": "Bank account validation could not be completed at this time due to a temporary processing issue from the downstream bank network, or internal validation service.",
    "action": "Please retry the request later. If the issue persists, please contact support with the transaction reference for further assistance.",
    "reason": "The validation request could not be completed because a temporary system or bank network error occurred during processing."
  },
  "metaData": {
    "source": "API",
    "entity": "Payment"
  }
}

503 Unknown behaviour

Code
{
  "status": 503,
  "data": null,
  "error": {
    "code": "UNKNOWN_BEHAVIOUR",
    "message": "Bank account validation could not be completed because the bank network returned an unexpected response that could not be met with a standard validation result.",
    "action": "Please retry the request later. If the issue persists, please contact support with the transaction reference for further investigation.",
    "reason": "The provider returned an unmapped, unexpected, or unsupported response that could not be classified under the standard validation outcome."
  },
  "metaData": {
    "source": "API",
    "entity": "Payment"
  }
}