Danh sách giao dịch hoàn tiền

Endpoint: /api/v1/refunds

Method: GET

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ệu	Yêu cầu	Mô tả
appotapayTransId	String		Mã giao dịch thanh toán của AppotaPay
orderId	String		Mã đơn hàng
refundId	String		Mã giao dịch hoàn tiền của AppotaPay
refundOriginalId	String		Mã giao dịch hoàn tiền của đối tác
status	String		Trạng thái giao dịch hoàn tiền
amount	Int		Số tiền hoàn
startTime	String		Lọc khoảng thời gian thực hiện giao dịch hoàn tiền
endTime	String		Lọc khoảng thời gian thực hiện giao dịch hoàn tiền
page	Int		Số trang
limit	Int		Số lượng giao dịch trên mỗi trang

Dữ liệu trả về

Tham số	Kiểu dữ liệu	Mô tả
errorCode	Integer	Mã lỗi trả về
message	String	Chi tiết mã lỗi
data	Object	Dữ liệu trả về
data.appotapayTransId	String	Mã giao dịch thanh toán
data.refundId	String	Mã giao dịch hoàn tiền (AppotaPay)
data.refundOriginalId	String	Mã giao dịch hoàn tiền (đối tác)
data.amount	String	Sô tiền hoàn
data.reason	String	Lý do hoàn tiền
data.reject_reason	String	Lý do Appota từ chối yêu cầu
data.status	String	Trạng thái yêu cầu
data.transactionTs	Integer	Thời gian thực hiện yêu cầu hoàn tiền

Ví dụ

Response

{
    "errorCode": 0,
    "message": "Thành công",
    "data": [
        {
            "appotapayTransId": "AP211338083228",
            "refundId": "AP211338083228",
            "refundOriginalId": "237052c887614019bedfd1851a287d9c",
            "amount": 10000,
            "reason": "Test refund",
            "status": "processing",
            "transactionTs": 1638180805
        }
    ],
    "meta": {
        "page": 1,
        "limit": 10,
        "total": 1,
        "totalAmount": 10000,
        "pages": 1
    }
}

Error

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