List refund transaction by order id

Endpoint: /api/v1/transaction/{orderId}/refund

Method: GET

Header: How to generate JWT_TOKEN

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

HTTP Request:

Params	Type	Required	Description
orderId	√	String	Order Id

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.orderId	String	Order id
data.orderInfo	String	Order information
data.partnerCode	String	Partner code
data.applicationId	Integer	Application Id
data.amount	Integer	Payment amount
data.bankCode	String	Bank Code
data.paymentMethod	String	Payment method
data.refundType	String	Kind of refund (total => Refund total amount payment, partial => Refund partial amount payment)
data.transactionTs	Integer	Transaction time
data.refundTransactions	Array of Object	List refund transaction
data.refundTransactions.appotapayTransId	String	Transaction Id
data.refundTransactions.refundId	String	Refund Id (AppotaPay)
data.refundTransactions.refundOriginalId	String	Refund Id (Partner)
data.refundTransactions.amount	String	Refund Amount
data.refundTransactions.reason	String	Refund reason
data.refundTransactions.reject_reason	String	Reject reason
data.refundTransactions.status	String	Status of refund transaction
data.refundTransactions.transactionTs	Integer	Refund transaction time

Example

Response

{
    "errorCode": 0,
    "message": "Thành công",
    "data": {
        "appotapayTransId": "AP211338083228",
        "orderId": "61a4919ca5b23",
        "orderInfo": "test thanh toan",
        "partnerCode": "TEST",
        "applicationId": 316869,
        "amount": 10000,
        "bankCode": "SHB",
        "paymentMethod": "ATM",
        "refundType": "total",
        "transactionTs": 1638175132,
        "refundTransactions": [
            {
                "appotapayTransId": "AP211338083228",
                "refundId": "AP211338083228",
                "refundOriginalId": "237052c887614019bedfd1851a287d9c",
                "amount": 10000,
                "reason": "Test refund",
                "status": "processing",
                "transactionTs": 1638180805
            }
        ]
    }
}

Error

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