Chuyển đến nội dung chính

Hoàn tiền​

API dùng để hoàn tiền

Khuyến nghị triển khai

  • API Refund chỉ xác nhận yêu cầu hoàn tiền đã được tiếp nhận.
  • Merchant không nên sử dụng response của API này để kết luận giao dịch đã hoàn tiền thành công.
  • Merchant cần gọi API Query Refund Status để nhận kết quả cuối cùng.
Request Body required
  • app_id integer required

    Định danh cho ứng dụng (web, app, pos ...) hay dịch vụ (auto-debit, disbursement ...) của Merchant được cấp khi đăng ký tích hợp phương thức thanh toán với Zalopay.

  • m_refund_id string(45) required

    Mã giao dịch hoàn tiền Merchant gửi qua hệ thống Zalopay để yêu cầu thực hiện hoàn tiền (TXID của giao dịch hoàn tiền).
    Mã giao dịch hoàn tiền phải theo format yymmdd_appid_mã định danh hoàn tiền.
    Merchant dùng giá trị này cho việc tra cứu thông tin trạng thái giao dịch hoàn tiền.

  • zp_trans_id string required

    Mã giao dịch Zalopay muốn hoàn tiền. Thông tin mã giao dịch Zalopay, Merchant nhận được từ dữ liệu callback, hoặc gọi API get order's status.

  • amount int64 required

    Số tiền cần hoàn tiền.

  • refund_fee_amount int64

    Phí của giao dịch hoàn tiền. Phí này sẽ được trích ra từ phần tiền người mua hàng nhận lại được từ giao dịch hoàn tiền. Nếu không cần phí hoàn, bạn có thể bỏ qua trường dữ liệu này.

  • timestamp int64 required

    Thời điểm yêu cầu hoàn tiền (unix timestamp in millisecond). Thời gian tính đến milisecond, và lấy theo thời gian hiện hành.

  • description string(100) required

    Lý do hoàn tiền.

  • mac string required

    Thông tin chứng thực: mac = HMAC(hmac_algorihtm, mac key, hmacinput), chi tiết như bên dưới:
    - hmac_algorihtm: là phương thức bảo mật được Merchant đăng ký với Zalopay, mặc định là HmacSHA256.
    - mac key: được cung cấp bởi Zalopay.
    - hmacinput:

    + Nếu không có phí hoàn, hmacinput = app_id + | + zp_trans_id + | + amount + | + description + | + timestamp
    + Trường hợp có phí hoàn (refund_fee_amount), hmacinput = app_id + | + zp_trans_id + | + amount + | + refund_fee_amount + | + description + | + timestamp

    Vui lòng tham khảo truyền dữ liệu an toàn để biết thêm chi tiết.

Responses

OK

Schema
  • return_code integer

    Mã trạng thái. Vui lòng tham khảo mã trạng thái để biết thêm chi tiết.

  • return_message string

    Mô tả mã trạng thái.

  • sub_return_code integer

    Mã trạng thái chi tiết. Vui lòng tham khảo mã trạng thái để biết thêm chi tiết.

  • sub_return_message string

    Mô tả mã trạng thái chi tiết.

  • refund_id int64

    Mã giao dịch hoàn tiền của Zalopay, cần lưu lại để đối chiếu.

Loading...