List refund transaction

Endpoint: /api/v1/refunds

Method: GET

Header: How to generate JWT_TOKEN

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

HTTP Request:

Params	Type	Required	Description
appotapayTransId	String		AppotaPay transaction id
orderId	String		Order id
refundId	String		AppotaPay refund id
refundOriginalId	String		Partner refund id
status	String		Refund status
amount	Int		Refund amount
startTime	String		Start time transaction
endTime	String		End time transaction
page	Int		Page current (default: 1)
limit	Int		Total transaction in per page (default: 10)

Data response

Tham số	Kiểu dữ liệu	Mô tả
errorCode	Integer	Error code result
message	String	Error code detail
data	Object	Data return
data.appotapayTransId	String	Transaction Id
data.refundId	String	Refund Id (AppotaPay)
data.refundOriginalId	String	Refund Id (Partner)
data.amount	String	Refund Amount
data.reason	String	Refund reason
data.reject_reason	String	Reject reason
data.status	String	Status of refund transaction
data.transactionTs	Integer	Refund transaction time

Example

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
}