3.3.5 Truy vấn thông tin thanh toán tự động bằng mã hợp đồng
Lưu ý
API này chỉ sử dụng cho đối tác đăng ký sử dụng tính năng thanh toán tự động.
Thông tin chung
- API truy vấn thông tin Autodebit đã đăng ký tại MB
Đặc tả
Endpoint
GET /api/merchant/v2/auto-debit/info
Header
Content-Type: application/json
MERCHANT_CODE: Mã đối tác
MERCHANT_SECRET: Khóa bí mật của Đối tác
CLIENT_MESSAGE_ID: Mã tra cứu log giao dịch phía MB (using UUID)
Dữ liệu truyền lên
Lưu ý
- Ưu tiên truy vấn theo cif và contractCode nếu truyền
- Nếu không truyền trường nào => api trả lỗi
| Tham số(URL) | Mô tả |
|---|---|
cif | Mã khách hàng |
contractCode | Mã hợp đồng |
autoDebitId | Mã auto debit |
fromDate | Từ ngày Định dạng: yyyy-MM-dd Chỉ truyền khi truy vấn thông tin bằng autoDebitId |
toDate | Đến ngày Định dạng: yyyy-MM-dd Chỉ truyền khi truy vấn thông tin bằng autoDebitId |
Dữ liệu trả về
| Tham số | Mô tả |
|---|---|
onBehalfRegistrations | Kiểu List Object, Thông tin bản ghi đăng ký autoDebit |
onBehalfRegistrations.recordId | Kiểu String, ID bản ghi tại hệ thống MB |
onBehalfRegistrations.onbehalfPaymentRegisterId | Kiểu String, tối đa 256 ký tự. Tên đối tác |
onBehalfRegistrations.serviceIdentify | Kiểu List Object, Thông tin định danh dịch vụ |
onBehalfRegistrations.serviceIdentify.serviceCode | Kiểu List Object, Mã dịch vụ |
onBehalfRegistrations.serviceIdentify.providerUnit1Code | Kiểu String, Mã dịch vụ con |
onBehalfRegistrations.serviceIdentify.providerUnit2Code | Kiểu String, Mã dịch vụ con |
onBehalfRegistrations.serviceIdentify.providerUnit3Code | Kiểu String, Mã dịch vụ con |
onBehalfRegistrations.billIdentifies | Kiểu List Object, Mã dịch vụ con |
onBehalfRegistrations.billIdentifies.name | Kiểu String, Mặc định trả CONTRACT_CODE |
onBehalfRegistrations.billIdentifies.value | Kiểu String, Mã hợp đồng |
onBehalfRegistrations.billInfoOthers | Kiểu List Object, Thông tin khác của hóa đơn |
onBehalfRegistrations.billInfoOthers.name | Kiểu String, Thông tin khác của hóa đơn |
onBehalfRegistrations.billInfoOthers.value | Kiểu String, Thông tin khác của hóa đơn |
onBehalfRegistrations.billInfoOthers.value | Kiểu String, Thông tin khác của hóa đơn |
onBehalfRegistrations.t24CustomerCode | Kiểu String, Mã khách hàng tại MB |
onBehalfRegistrations.customerNationalId | Kiểu String, Số giấy tờ tùy thân của KH |
onBehalfRegistrations.debitSource | Kiểu String, Số tài khoản/ CardId của KH đăng ký autodebit |
onBehalfRegistrations.debitName | Kiểu String, Tên số tài khoản/ số thẻ |
onBehalfRegistrations.billerCustomerName | Kiểu String, Tên khách hợp của hợp đồng _Mã hợp đồng |
onBehalfRegistrations.billerCustomerCode | Kiểu String, Mã hợp đồng |
onBehalfRegistrations.billerCustomerPhone | Kiểu String, Số điện thoại của KH |
onBehalfRegistrations.billerCustomerEmail | Kiểu String, Email của KH |
onBehalfRegistrations.channel | Kiểu String, Kênh đăng ký autodebit |