Chuyển tới nội dung chính

Webhook kết quả xác thực thẻ

Quy trình​

Mô tả:

  • Sau khi Ngân hàng hợp tác gửi kết quả xác thực về Baokim, Baokim gọi webhook của Merchant để thông báo kết quả.
  • Merchant cần xây dựng API webhook để nhận thông báo này.

Thông tin API​

URL: Merchant cung cấp

Method: POST

Header:

Content-Type: application/json
Signature: $signature

Request​

(Tham số Baokim gửi tới Merchant)

Bảng tham số chính​

STTTên trườngKiểu dữ liệuBắt buộcMô tả
1request_idString(100)✅ID duy nhất của request
2request_timeString(20)✅Thời gian gửi request. Format: YYYY-MM-DD H:i:s
3merchant_codeString(50)✅Mã định danh Merchant
4operationString(20)✅AUTHENTICATION: xác thực thẻ / REFUND: hoàn tiền
5order_codeString(50)✅Mã đơn hàng Baokim
6total_amountString(255)✅Tổng số tiền của đơn hàng
7authen_statusNumber✅Trạng thái authentication: 0 - Chờ xác thực / 1 - Đã xác thực / 2 - Xác thực thất bại / 3 - Bypass (3ds off)
8statusNumber✅Trạng thái đơn hàng trên Baokim
9save_tokenNumber❌0: Không lưu token, 1: Có lưu
10off_3dsNumber❌0: Không tắt 3DS (default), 1: Tắt 3DS
11extendObject❌Dữ liệu mở rộng (billing)
12created_atDatetime✅Thời gian tạo đơn hàng
13updated_atDatetime✅Thời gian cập nhật đơn hàng

Thông tin extend​

STTTên trườngKiểu dữ liệuBắt buộcMô tả
1billingObject❌Thông tin người thanh toán

Thông tin billing​

STTTên trườngKiểu dữ liệuBắt buộcMô tả
1firstnameString(255)❌Tên người thanh toán
2lastnameString(255)❌Họ người thanh toán
3addressString(500)❌Địa chỉ
4cityString(50)❌Thành phố. Ví dụ: HANOI
5stateString(255)❌Bang / Tỉnh
6countryString(2)❌Quốc gia, mã ISO2. Ví dụ: VN
7emailString(255)❌Email
8phoneString(10)❌Số điện thoại
9postal_codeString(6)❌Mã bưu điện

Ví dụ Request​

{
"request_id": "MERCHANT050015588AXE012",
"request_time": "2020-08-11 14:41:00",
"merchant_code": "MERCHANT",
"operation": "AUTHENTICATION",
"order_code": "VLAD_1753867524",
"total_amount": 10000000,
"authen_status": 1,
"status": 5,
"save_token": 0,
"off_3ds": 0,
"extend": {
"billing": {
"firstname": "A",
"lastname": "NGUYEN VAN",
"address": "313 Truong Chinh, Dong Da",
"city": "HANOI",
"state": null,
"country": "VN",
"email": "[email protected]",
"phone": "0394899999",
"postal_code": "100000"
}
},
"created_at": "2020-08-11 14:41:00",
"updated_at": "2020-08-11 14:41:00"
}

Response​

(Merchant phản hồi lại Baokim)

Bảng tham số chính​

STTTên trườngKiểu dữ liệuBắt buộcMô tả
1codeInteger✅Mã kết quả. 0, 100 hoặc 200 = Thành công
2messageString✅Thông báo kết quả xử lý
3dataObject❌Dữ liệu trả về (nếu có)

Ví dụ Response​

{
"code": 200,
"message": "Successfully",
"data": null
}