Close VA

Server

สร้าง ตรวจสอบ และจำลองการชำระเงิน Close VA ในจำนวนคงที่ ใช้จุดสิ้นสุดเหล่านี้สำหรับลำดับการสั่งซื้อหรือใบแจ้งหนี้ที่ต้องมีจำนวนเงินที่แน่นอน กรอบเวลาหมดอายุ และการตรวจสอบสถานะการชำระเงิน Close VA

สถานะของ Close VA

GET

https://sandbox.onebrick.io

/v2/payments/gs/va/close

publicAccessToken (header)

ตรวจสอบสถานะการชำระเงินล่าสุดสำหรับการปิด Virtual Account ใช้ endpoint นี้เพื่อยืนยันว่าได้ชำระเงิน VA ในจำนวนคงที่แล้ว หมดอายุแล้วหรือยังอยู่ระหว่างการพิจารณา มีประโยชน์สำหรับการกระทบยอดใบสั่ง การสนับสนุนลูกค้า และงานตามกำหนดการที่ต้องแก้ไขการชำระเงินด้วยการโอนเงินผ่านธนาคารที่ค้างชำระหรือล่าช้า

สถานะของ Close VA › query Parameters

vaId

string

รหัสเฉพาะของบัญชีเสมือน เช่น CL_xxxx

สถานะของ Close VA › Responses

200

status

integer

Default: 0

object

error

สร้าง Close VA

POST

https://sandbox.onebrick.io

/v2/payments/gs/va/close

publicAccessToken (header)

สร้างการปิด Virtual Account สำหรับจำนวนเงินการชำระเงินคงที่ การอ้างอิงลูกค้า และกรอบเวลาการหมดอายุ ใช้ Close VA เมื่อควรชำระเงินตามคำสั่งซื้อหรือใบแจ้งหนี้แต่ละรายการด้วยจำนวนเงินที่แน่นอนและระยะเวลาที่มีผลใช้ได้ การตอบกลับจะส่งคืนรายละเอียด VA ที่สามารถแสดงให้ลูกค้าเห็น และปรับยอดในภายหลังผ่าน callback หรือการสอบถามสถานะ

สร้าง Close VA › Request Body

referenceId

string · required

ID เฉพาะที่ไคลเอ็นต์สร้างขึ้นเพื่อติดตามแต่ละรุ่น VA

Default: test-closeVA-1

bankShortCode

string · required

Default: MANDIRI

amount

integer · int32 · required

จำนวนเงินที่จะระบุไว้ในบัญชีเสมือน

Default: 10000

expiredAt

string · required

เวลาหมดอายุของการปิด VA ในหน่วยนาที

Default: 60

displayName

string · required

ชื่อที่แสดงของ VA

Default: Close VA test

description

string

คำอธิบายที่จะระบุไว้ในบัญชีเสมือน (สูงสุด 255 ตัวอักษร)

Default: test-closeVA-1

สร้าง Close VA › Responses

200

status

integer

Default: 0

object

error

POST/v2/payments/gs/va/close

curl https://sandbox.onebrick.io/v2/payments/gs/va/close \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'publicAccessToken: <api-key>' \
  --data '{
  "referenceId": "test-closeVA-1",
  "bankShortCode": "MANDIRI",
  "amount": 10000,
  "expiredAt": "60",
  "displayName": "Close VA test",
  "description": "test-closeVA-1"
}'

Example Request Body

{
  "referenceId": "test-closeVA-1",
  "bankShortCode": "MANDIRI",
  "amount": 10000,
  "expiredAt": "60",
  "displayName": "Close VA test",
  "description": "test-closeVA-1"
}

json

Example Responses

{
    "status": 200,
    "data": {
				"message": "We have successfully generated the close VA",
        "id": "CL_asd31231SAD123123asasd122",
				"referenceId": "brick12345",
        "description": "Test Initial VA Close",
        "amount": "15000.0",
        "status": "pending",
        "createdAt": "2021-12-13T14:26:43.000+07:00",
        "expiredAt": "2021-12-31T15:27:43.000+07:00",
        "bankShortCode": "MANDIRI",
        "accountNo": "1304421991909265",
        "displayName": "IKN-BRICK"
    },
    "metaData": {
        "source": "API",
        "entity": "Payment"
    },
    "error": null
}

json

application/json

จำลองการชำระเงิน Close VA [PAID/COMPLETED]

POST

https://sandbox.onebrick.io

/v2/payments/gs/va/close/status/{vaIdCL}

publicAccessToken (header)

จำลองการเปลี่ยนแปลงสถานะการชำระเงิน Close VA ในสภาพแวดล้อม Sandbox ใช้ endpoint นี้ในระหว่างการพัฒนาเพื่อทดสอบ callbacks ตรรกะการกระทบยอด การจัดการแบบชำระเงิน และการกู้คืนความล้มเหลวโดยไม่ต้องย้ายเงินทุนจริง endpoint นี้ไม่ได้มีไว้สำหรับการรับส่งข้อมูลที่ใช้งานจริง และควรใช้กับข้อมูลการทดสอบแซนด์บ็อกซ์ VA เท่านั้น

จำลองการชำระเงิน Close VA [PAID/COMPLETED] › path Parameters

vaIdCL

string · required

ID ของ VA ที่สร้างขึ้นโดย Brick ในการตอบสนอง VA รุ่น API สำหรับการจำลองสถานะ "ชำระเงิน", ID ของการชำระเงินที่สร้างโดย Brick ในการตอบสนอง VA callback สำหรับการจำลองสถานะ "PAID/COMPLETED" ตัวอย่าง: CL_xxx

จำลองการชำระเงิน Close VA [PAID/COMPLETED] › Request Body

action

string · required

สถานะที่ต้องการบรรลุ (PAID / COMPLETED)

Default: PAID/COMPLETED

จำลองการชำระเงิน Close VA [PAID/COMPLETED] › Responses

200

Open VA Authentication