3.3.3 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ó gioa dịch thanh toán tự động hằng kỳ
- 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ả |
|---|---|
id | Kiểu String, tối đa 50 ký tự. ID giao dịch (mã đăng ký trích nợ tự độngbắt đầu bằng AT) |
paymentPeriodId | Kiểu String, tối đa 50 ký tự. ID của giao dịch thanh toán theo kỳ |
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 |
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 |
paidTime | Kiểu Date. Thời điểm thanh toán thành công. Theo định dạng yyyy-MM-dd’T’HH:mm:ss (ISO 8601) |
fundingSource | Kiểu String, tối đa 20 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ẻ thanh toán lần đầu; bao gồm CREDIT_CARD hoặc PREPAID_CARD |
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) |
status | Kiểu String, tối đa 45 ký tự. Trạng thái của giao dich.SUCCESS: thành công FAIL: thất bại |
session | Kiểu String, tối đa 15 ký tự. Kỳ thu autodebit DD/MM/YYYY |
errorCode | Kiểu String. Mã lỗi |
errorDesc | Kiểu String. Mô tả lỗi |
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+paymentPeriodId+id+cif+typeCode+amount+status - merchantCode: Mã đối tác - id: ID giao dịch (mã đăng ký trích nợ tự động bắt đầu bằng AT) - paymentPeriodId: ID của giao dịch thanh toán theo kỳ - typeCode: Mã loại giao dịch - cif: Mã khách hàng tại MB - amount: Số tiền giao dịch - status: Trạng thái giao dịch |