3.2.1 Khởi tạo yêu cầu hoàn tiền
Lưu ý
API này chỉ sử dụng cho đối tác đăng ký sử dụng tính năng hoàn tiền.
Thông tin chung
- API khởi tạo yêu cầu hoàn tiền được gọi từ server của Đối tác để thiết lập một yêu cầu trích tiền từ TKTT của Đối tác tại MB, hoàn trả đến TKTT/Thẻ hoặc TK Loyalty của khách hàng căn cứ theo giao dịch thanh toán đã thực hiện thành công trước đó.
Lưu ý
- Yêu cầu hoàn hoàn tiền có thể thực hiện nhiều lần trên cùng một giao dịch.
- Tại cùng một thời điểm chỉ có một yêu cầu hoàn tiền trên cùng một giao dịch được thưc hiện. Các yêu cầu khác sẽ trả về lỗi.
- Tổng số tiền trong các yêu cầu hoàn tiền không được vượt quá số tiền trên giao dịch đó.
Đặc tả
Endpoint
POST /api/merchant/v1/transaction/{transactionId}/refund
Header
Content-Type: application/json
MERCHANT_CODE: Mã đối tác
MERCHANT_SECRET: Khóa bí mật của Đối tác
Dữ liệu truyền lên
Tham số (URL) | Mô tả |
---|---|
transactionId | BẮT BUỘC. Kiểu String, tối đa 30 ký tự. ID của giao dịch |
amount | BẮT BUỘC. Kiểu Number. Số tiền hoàn |
description | BẮT BUỘC. Kiểu String, tối đa 45 ký tự. Nội dung giao dịch hoàn tiền |
Dữ liệu trả về
Tham số | Mô tả |
---|---|
id | Kiểu String, tối đa 30 ký tự. ID của giao dịch hoàn tiền |
transactionId | Kiểu String, tối đa 30 ký tự. ID của giao dịch thanh toán |
amount | Kiểu Number. Số tiên giao dịch |
description | Kiểu String, tối đa 45 ký tự. Nội dung giao dịch hoàn tiền |
createdTime | Kiểu String. Thời điểm tạo yêu cầu hoàn tiền Theo định dạng yyyy-MM-dd’T’HH:mm:ss (ISO 8601) |
refundedTime | Kiểu String. Thời điểm thực hiện hoàn tiền 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 đăng ký bao gồm:PROCESSING : Đang xử lýSUCCEEDED : Thành côngFAILED : Thất bại |
errorCode | Kiểu String, tối đa 100 ký tự. Mã lỗi trong trường hợp hoàn tiền thất bại bao gồm: customer-account-invalid : Tài khoản/thẻ của khách hàng không hợp lệinvalid-refund-amount : Số tiền hoàn không hợp lệaccount-balance-insufficient : Tài khoản chuyên chi của đối tác không đủ số dư để hoàn tiềnrefund-period-expired : Thời hạn hoàn tiền của giao dịch đã hếtinvalid-transaction-status : Trạng thái giao dịch không cho phép hoàn tiềnunknown : Lỗi không xác định. Vui lòng liên hệ với MB để được hỗ trợ |