3.3.6 Callback kết quả đăng ký thanh toán tự độ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 gọi từ Server MB khi có sự kiện liên quan đến giao dịch
- API Endpoint do Đối tác cung cấp cho hệ thống MB
- API cần được public ra Internet
- Đối tác phải thiết kế API nhận dữ liệu theo đúng như đặc tả trong tài liệu cung cấp
Lưu ý
API có sử dụng checksum để thẩm tra lại các trường quan trọng trong bản tin không bị thay đổi
Đặc tả API
Endpoint
URL: Do đối tác tự đình nghĩa và gửi lại cho hệ thống MB Payment Hub. API cần được public ra internet
Method: POST
Header
- Đối tác cung cấp các tham số tĩnh để truyền qua Headers
Content-Type: application/json
Thông tin về checksum
Dữ liệu chuyển sang đối tác
| Tham số | Mô tả |
|---|---|
requestId | Kiểu String, tối đa 50 ký tự. ID của yêu cầu |
requestType | Kiểu String, tối đa 50 ký tự. Loại giao dịch: REGISTER: đăng ký UPDATE: chỉnh sửa CANCEL: hủy |
autoDebitId | Kiểu String, tối đa 50 ký tự. Id giao dịch autodebit |
merchant.code | Kiểu String, tối đa 100 ký tự. Mã đối tác |
merchant.name | Kiểu String, tối đa 256 ký tự. Tên đối tác |
cif | Kiểu String, tối đa 45 ký tự. Mã khách hàng MB |
amount | Kiểu Long. Số tiền thực hiện giao dịch |
scheduledPattern | Kiểu String, tối đa 25 kí tự Chuỗi cron giá trị tần suất |
description | Kiểu String, tối đa 48 ký tự. Nội dung giao dịch |
type.code | Kiểu String, tối đa 100 ký tự. Mã loại giao dịch |
type.name | Kiểu String, tối đa 256 ký tự. Tên loại giao dịch |
type.allowCard | Kiểu Boolean. Cho phép thanh toán bằng thẻ hay không true: Có cho phép false: Không cho phép |
metadata | Kiểu String, tối đa 500 ký tự. Chuỗi dữ liệu bổ sung thông tin cho giao dịch được Đối tác truyền vào khi khởi tạo giao dịch |
createdDate | Kiểu Date. Thời điểm tạo giao dịch Theo định dạng yyyy-MM-dd'T'HH:mm:ss (ISO 8601) |
requestStatus | Kiểu String, tối đa 45 ký tự. Trạng thái của request.SUCCESS: thành công FAIL: thất bại |
fundingSource | Kiểu String, tối đa 2000 ký tự. Nguồn tiền được khách hàng sử dụng để thanh toán ACCOUNT: Nguồn TKTT CARD: Nguồn thẻ |
cardType | Kiểu String, tối đa 100 ký tự. Loại thẻ được khách hàng sử dụng để thanh toán BMC MBVT_VISA_CREDIT SIMPLE VIETTEL_PAYROLL MBVG_VISA_CREDIT VISA_CREDIT SME_CREDIT JCB_CREDIT SSC PRIORITY_MBVG_VISA_CREDIT PRIORITY_VISA_CREDIT NEWPLUS VIETTELPAY |
checksum | BẮT BUỘC, Kiểu String. Chuỗi mã hóa tạo ra dựa trên các tham số dưới đây:merchantCode + autoDebitId + requestID + requestType + typeCode + cif + amount + scheduledPattern + requestStatus Nếu trường nào bằng null thì bỏ qua không cộng chuỗi vào checksum.Ví dụ nếu autoDebitId, typeCode, amount, scheduledPattern = null thì chuỗi checksum chỉ còn merchantCode + requestID + requestType + cif + requestStatus |
frequencyUnit | Kiểu String. Tần suất thanh toán: DAY, WEEK, MONTH, YEAR |
dayOfAutodebit | Kiểu String. Thời gian thực hiện autodebit. Trong trường hợp frequencyUnit = DAY, để null. Trong trường hợp frequencyUnit = WEEK nhận các giá trị nhận giá trị MON, TUE, WED, THU, FRI, SAT, SUN Trong trường hợp frequencyUnit = MONTH nhận một giá trị từ 1->28 Trong trường hợp frequencyUnit = YEAR nhận giá trị theo format: DD/MM .Ví dụ 28/12 |
firstpaymentAmount | Kiểu Long. Số tiền thanh toán lần đầu. Yêu cầu: 0 ≤ amount < 10 tỉ VND |