Nhảy tới nội dung
Phiên bản: 1.0

Hoàn tiền giao dịch

Endpoint: /api/v1/transaction/refund

Method: POST

Header: Cách tạo JWT_TOKEN 

{
    "X-APPOTAPAY-AUTH": Bearer JWT_TOKEN,
    "Content-Type": "application/json"
}

Tham số​

Tham sốKiểu dữ liệuYêu cầuMô tả
refundIdString√Mã giao dịch hoàn tiền của đối tác (Mã này là duy nhất với mỗi bản tin gửi lên)
appotapayTransIdString√Mã giao dịch thanh toán muốn hoàn tiền
amountInteger√Số tiền hoàn
reasonString√Lý do hoàn tiền
signatureString√Chữ ký kiểm tra dữ liệu
signature = HMAC_SHA256(data, secretKey)

data: amount={amount}&appotapayTransId={appotapayTransId}&reason={reason}&refundId={refundId}

Dữ liệu trả về​

Tham sốKiểu dữ liệuMô tả
appotapayTransIdStringMã giao dịch thanh toán của AppotaPay
refundIdStringMã giao dịch hoàn tiền của AppotaPay
refundOriginalIdStringMã giao dịch hoàn tiền của đối tác
amountIntegerSố tiền hoàn
reasonStringLý do hoàn tiền
statusStringTrạng thái hoàn tiền
transactionTsIntegerThời gian thực hiện giao dịch
signatureStringChữ ký kiểm tra dữ liệu
signature = HMAC_SHA256(data, secretKey)

data: amount={amount}&appotapayTransId={appotapayTransId}&errorCode={errorCode&reason={reason}&refundId={refundId}&refundOriginalId={refundOriginalId}&status={status}&transactionTs={transactionTs}

Bảng mã trạng thái giao dịch​

Trạng tháiMô tả
pendingGiao dịch thanh toán không hỗ trợ hoàn tiền tự động AppotaPay tiếp nhận yêu cầu hoàn tiền và xử lý hoàn thủ công trong 1 ngày, đối tác có thể gọi API kiểm tra trạng thái giao dịch. Quá 1 ngày giao dịch vẫn chưa đổi về trạng thái cuối (success, error) thì đối tác vui lòng liên hệ CSKH để được trợ giúp
processingGiao dịch thanh toán hỗ trợ hoàn tiền tự động AppotaPay tiếp nhận yêu cầu hoàn tiền và đang xử lý, đối tác có thể gọi API kiểm tra trạng thái giao dịch. Quá 1 ngày giao dịch vẫn chưa đổi về trạng thái cuối (success, error) thì đối tác vui lòng liên hệ CSKH để được trợ giúp
successGiao dịch hoàn tiền thành công.
errorGiao dịch hoàn tiền thất bại.

Ví dụ​

Request​

{
    "refundId": "237052c887614019bedfd1851a287d9c",
    "appotapayTransId": "AP211364332963",
    "amount" : 10000,
    "reason": "Test refund",
    "signature": "20150ead77ee8ce0c6c161bf3fef42775423196e74268d26f2de077378007167"
}

Response​

{
    "errorCode": 0,
    "message": "Thành công",
    "data": {
        "appotapayTransId": "AP211364332963",
        "refundId": "57bd2769-3827-42a4-be47-aab498496a46",
        "refundOriginalId": "237052c887614019bedfd1851a287d9c",
        "amount": 10000,
        "reason": "Test refund",
        "status": "processing",
        "transactionTs": 1638180805
    },
    "signature": "cf31a492c8639b213ea55782a8853792a676522cf26a111b6e0fe45249042c3b"
}

Error​

{
    "errorCode": int,
    "message": error message
}

Danh sách nhà cung cấp hỗ trợ refund​

Vendor codeThời gian hỗ trợ refundAuto qua apiRefund một phầnRefund nhiều lầnRefund toàn phầnTime user nhận tiền
Napas1 nămCóCóCó5 - 7 ngày làm việc
Vpbank Visa - Mastercard6 thángCóCóCó10 - 15 ngày làm việc
VnptPayCóKhôngKhôngCó
ONEPAYKhôngKhông
EBILLKhôngKhông
SHOPEE90 ngàyCóCóCóCóReal time
MOCA1 thángCóKhôngKhôngCóReal time
APPOTA WALLETCóKhôngKhôngCóReal time
MOMOCóCóCóCóReal time
ViettelPayKhôngKhôngKhôngKhông
ZaloPay180 ngàyCóCóCóCóReal time
VAKhôngKhôngKhông
VNpayCóCóKhông
CybersourceKhôngKhôngKhôngKhôngKhôngKhông