Skip to main content
Version: 1.0

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:#

ParamsTypeRequiredDescription
orderIdStringOrder Id

Data response#

Tham sốKiểu dữ liệuMô tả
errorCodeIntegerError code result
messageStringError code detail
dataObjectData return
data.appotapayTransIdStringTransaction id
data.orderIdStringOrder id
data.orderInfoStringOrder information
data.partnerCodeStringPartner code
data.applicationIdIntegerApplication Id
data.amountIntegerPayment amount
data.bankCodeStringBank Code
data.paymentMethodStringPayment method
data.refundTypeStringKind of refund (total => Refund total amount payment, partial => Refund partial amount payment)
data.transactionTsIntegerTransaction time
data.refundTransactionsArray of ObjectList refund transaction
data.refundTransactions.appotapayTransIdStringTransaction Id
data.refundTransactions.refundIdStringRefund Id (AppotaPay)
data.refundTransactions.refundOriginalIdStringRefund Id (Partner)
data.refundTransactions.amountStringRefund Amount
data.refundTransactions.reasonStringRefund reason
data.refundTransactions.reject_reasonStringReject reason
data.refundTransactions.statusStringStatus of refund transaction
data.refundTransactions.transactionTsIntegerRefund 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}