Skip to main content

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
    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ả
transactionIdBẮT BUỘC. Kiểu String, tối đa 30 ký tự. ID của giao dịch
amountBẮT BUỘC. Kiểu Number. Số tiền hoàn
descriptionBẮ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ả
idKiểu String, tối đa 30 ký tự. ID của giao dịch hoàn tiền
transactionIdKiểu String, tối đa 30 ký tự. ID của giao dịch thanh toán
amountKiểu Number. Số tiên giao dịch
descriptionKiểu String, tối đa 45 ký tự. Nội dung giao dịch hoàn tiền
createdTimeKiể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)
refundedTimeKiể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)
statusKiể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ông
FAILED: Thất bại
errorCodeKiể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ền
refund-period-expired: Thời hạn hoàn tiền của giao dịch đã hết
invalid-transaction-status: Trạng thái giao dịch không cho phép hoàn tiền
unknown: Lỗi không xác định. Vui lòng liên hệ với MB để được hỗ trợ

Thử nghiệm

Tham khảo