Regular Disbursement

Server

สร้างการจ่ายเงินมาตรฐาน Brick Send Money ไปยังบัญชีธนาคารหรือปลายทาง Ewallet ที่รองรับ ใช้ Disbursement ปกติเมื่อไม่จำเป็นต้องใช้การกำหนดเส้นทาง BI-FAST แบบเรียลไทม์หรือไม่พร้อมใช้งาน

Disbursement ปกติ

POST

https://sandbox.onebrick.io

/v2/payments/gs/disbursements

publicAccessToken (header)

สร้างการชำระเงินปกติไปยังบัญชีธนาคารหรือปลายทาง Ewallet ที่รองรับ ใช้ endpoint นี้สำหรับเวิร์กโฟลว์การจ่ายเงินมาตรฐาน โดยที่ไม่จำเป็นต้องใช้ BI-FAST ไม่พร้อมใช้งาน หรือไม่ได้เลือกตามกฎการกำหนดเส้นทางของคุณ ส่งรายละเอียด reference ID และผู้รับที่ไม่ซ้ำกัน จากนั้นกระทบยอดเสร็จสมบูรณ์ผ่าน callbacks บันทึกบัญชีแยกประเภท หรือจุดสิ้นสุดสถานะการชำระเงิน

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

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

การเบิกจ่ายแบบ Regular

รหัสย่อธนาคาร	เลขที่บัญชีธนาคาร	ชื่อเจ้าของบัญชีธนาคาร	จำนวนเงิน	สถานะที่คาดหวัง
MANDIRI	112233445	PROD ONLY	Rp29.999	Completed
BRI	112233445	PROD ONLY	Rp10.000 - Rp500.000.000	Processing
MANDIRI	112233445	PROD ONLY	Rp39.999	Failed
SINARMAS	112233445	PROD ONLY	Rp10.000 - Rp500.000.000	Failed with error 503 (Bank Under Maintenance)

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

เลขที่บัญชีธนาคาร: สามารถใช้หมายเลขใดก็ได้ที่มีมากกว่า 8 หลัก
ชื่อเจ้าของบัญชี: ต้องเป็น "PROD ONLY" ทุกครั้งแบบตรงตัว
จำนวนเงิน: ต้องอยู่ในช่วง Rp10.000 ถึง Rp500.000.000
ค่าเหล่านี้ถูก hardcode ในสภาพแวดล้อม sandbox ของเราเพื่อช่วยจำลองสถานะการตอบกลับที่เฉพาะเจาะจง

Disbursement ปกติ › Request Body

referenceId

string · required

reference ID ที่ไม่ซ้ำกันเป็นตัวระบุที่ไม่ซ้ำกัน

Default: test-1

description

string · required

สตริงที่กำหนดเองแนบกับวัตถุ มักมีประโยชน์ในการแสดงให้ผู้ใช้เห็นว่าธุรกรรมมีไว้เพื่ออะไร ขีดจำกัดความยาวคำอธิบายคือ 1,000 ตัวอักษร

Default: test-disbursement-1

amount

integer · int32 · required

จำนวนเงินที่คุณต้องการส่ง

Default: 29999

object · required

recipientEmail

string

Disbursement ปกติ › Responses

200

No data returned

POST/v2/payments/gs/disbursements

curl https://sandbox.onebrick.io/v2/payments/gs/disbursements \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'publicAccessToken: <api-key>' \
  --data '{
  "referenceId": "test-1",
  "description": "test-disbursement-1",
  "amount": 29999,
  "disbursementMethod": {
    "type": "bank_transfer",
    "bankAccountNo": "000123456789",
    "bankShortCode": "MANDIRI",
    "bankAccountHolderName": "Example Customer"
  },
  "recipientEmail": "recipientEmail"
}'

Example Request Body

{
  "referenceId": "test-1",
  "description": "test-disbursement-1",
  "amount": 29999,
  "disbursementMethod": {
    "type": "bank_transfer",
    "bankAccountNo": "000123456789",
    "bankShortCode": "MANDIRI",
    "bankAccountHolderName": "Example Customer"
  },
  "recipientEmail": "recipientEmail"
}

json

Example Responses

{
  "status": 200,
  "data": {
    "message": "We have received your request and are processing it, please check your callback URL for transaction status",
    "id": "example-disbursement-id",
    "type": "disbursement",
    "attributes": {
      "referenceId": "reference-id-from-your-system",
      "description": "reference-id-from-your-system",
      "amount": "100000",
      "feeAmount": "2000",
      "status": "processing",
      "settlementStatus": "null",
      "createdAt": "2022-07-21T13:49:39.752+07:00",
      "disbursementMethod": {
        "type": "bank_transfer",
        "bankAccountNo": "000123456789",
        "bankShortCode": "BCA",
        "bankAccountHolderName": "Example Customer"
      }
    }
  },
  "metaData": {
    "source": "API",
    "entity": "Payment"
  },
  "error": null
}

json

application/json

QR Code Static Topup

Disbursement ปกติ

POST

https://sandbox.onebrick.io

/v2/payments/gs/disbursements

publicAccessToken (header)

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

การเบิกจ่ายแบบ Regular

รหัสย่อธนาคาร	เลขที่บัญชีธนาคาร	ชื่อเจ้าของบัญชีธนาคาร	จำนวนเงิน	สถานะที่คาดหวัง
MANDIRI	112233445	PROD ONLY	Rp29.999	Completed
BRI	112233445	PROD ONLY	Rp10.000 - Rp500.000.000	Processing
MANDIRI	112233445	PROD ONLY	Rp39.999	Failed
SINARMAS	112233445	PROD ONLY	Rp10.000 - Rp500.000.000	Failed with error 503 (Bank Under Maintenance)

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

เลขที่บัญชีธนาคาร: สามารถใช้หมายเลขใดก็ได้ที่มีมากกว่า 8 หลัก
ชื่อเจ้าของบัญชี: ต้องเป็น "PROD ONLY" ทุกครั้งแบบตรงตัว
จำนวนเงิน: ต้องอยู่ในช่วง Rp10.000 ถึง Rp500.000.000
ค่าเหล่านี้ถูก hardcode ในสภาพแวดล้อม sandbox ของเราเพื่อช่วยจำลองสถานะการตอบกลับที่เฉพาะเจาะจง

Disbursement ปกติ › Request Body

referenceId

string · required

reference ID ที่ไม่ซ้ำกันเป็นตัวระบุที่ไม่ซ้ำกัน

Default: test-1

description

string · required

Default: test-disbursement-1

amount

integer · int32 · required

จำนวนเงินที่คุณต้องการส่ง

Default: 29999

object · required

recipientEmail

string

Disbursement ปกติ › Responses

200

No data returned