Yêu cầu kết nối

Merchant cung cấp

Để kết nối merchant cần cung cấp cho phía mPoS các API sau đây

1. API lấy thông tin thanh toán (là thông tin hóa đơn/phiếu mua hàng, …)

Các tham số đầu vào (request data): Là các tham số hệ thống mPoS sẽ gửi sang hệ thống của merchant để lấy thông tin thanh toán

Tham số (key) Kiểu dữ liệu Mô tả Bắt buộc
serviceName string Giá trị của trường này là hằng số "SERVICE_CHECK_ORDER"
orderID string Mã hóa đơn/Mã phiếu thu/Mã vạch,...Là trường thông tin duy nhất để có thể truy vấn thông tin thanh toán từ merchant

Các tham số trả về (response data): Là các thông tin merchant sẽ trả về cho mPoS để tạo thanh toán

Tham số (key) Kiểu dữ liệu Mô tả Bắt buộc
orderID string Mã đơn hàng/Mã phiếu thu/… trường giá trị duy nhất được định nghĩa ở bên merchant để truy vấn thông tin thanh toán (primary key)
transAmount Long Số tiền cần thanh toán (vnd)
orderType string Loại hàng hóa dịch vụ thanh toán (1: Hàng hóa vật chất, 2: Dịch vụ). Với giá trị 2(Dịch vụ) thì Giao dịch sẽ không thể Hủy sau khi thanh toán.
status string ACTIVE, DENIED, SUSPENDED
description string Mô tả hóa đơn thanh toán, Xuống dòng bằng ký tự ‘|’ Không
merchantId string Mã ID của merchant bên đối tác Không

2. API cập nhật thanh toán

API này cung cấp để phía mPoS gọi sau khi thanh toán hoàn thành. Các tham số đầu vào (request data): Là các tham số mPoS sẽ gửi sang merchant để cập nhật thông tin thanh toán cho hóa đơn tương ứng

Tham số (key) Kiểu dữ liệu Mô tả Bắt buộc
serviceName string Giá trị của trường này là hằng số "SERVICE_UPDATE_TRANSACTION"
transType interger Loại giao dịch (Thanh toán (1), Hủy (2), Kết toán (3))
transCode string Mã giao dịch thanh toán bên mPoS
transDate Timestamp Thời gian thanh toán
transAmount Long Số tiền thanh toán
issuerCode string Loại thẻ(DOMESTIC, VISA, MASTER)
muid string Tài khoản thanh toán
orderID string Mã hóa đơn của merchant
merchantId string Mã ID của merchant bên đối tác Không