Skip to main content
Version: 1.0

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

ParamsTypeRequiredDescription
appotapayTransIdStringAppotaPay transaction id
orderIdStringOrder id
refundIdStringAppotaPay refund id
refundOriginalIdStringPartner refund id
statusStringRefund status
amountIntRefund amount
startTimeStringStart time transaction
endTimeStringEnd time transaction
pageIntPage current (default: 1)
limitIntTotal transaction in per page (default: 10)

Data response#

Tham sốKiểu dữ liệuMô tả
errorCodeIntegerError code result
messageStringError code detail
dataObjectData return
data.appotapayTransIdStringTransaction Id
data.refundIdStringRefund Id (AppotaPay)
data.refundOriginalIdStringRefund Id (Partner)
data.amountStringRefund Amount
data.reasonStringRefund reason
data.reject_reasonStringReject reason
data.statusStringStatus of refund transaction
data.transactionTsIntegerRefund 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}