Refund: Detail

You can use the API to view the refund transaction detail.

EndPoint

GET /credit-card/refund/:creditCardRefundId

Header Params

Param	Required	Type	Description	Note
X-APPOTAPAY-AUTH	required	String	How to generate JWT_TOKEN
Content-Type	required	String	Value: application/json
X-Request-ID	optional	String	UUIDv4 format. Request ID to check when a problem occurs	max:42
Language	optional	String	The value vi or en corresponding to the payment link will be Vietnamese or English, (default: vi)	in:vi,en
X-Account-Ref-ID	optional	String	Iidentifier of the sub account provided by AppotaPay. Mandatory be passed over when processing payment for transactions of owner-type sub account

{
    "X-APPOTAPAY-AUTH": "JWT_TOKEN",
    "Content-Type": "application/json",
    "X-Request-ID": "Your_Unique_id",
    "Language": "vi",
    "X-Account-Ref-ID": "9723f73b-9295-4acb-884b-ab6310c2e653"
}

Request Params

URL Parameter

Parameters	Requirement	Data type	Description	Note
refundId	required	String	Unique ID is returned by AppotaPay

Query Parameter

Parameters	Requirement	Data type	Description	Note
referenceType	optional	String	- APPOTAPAY_REFERENCE_ID Refund ID returned by AppotaPay which can be retrieved from the charge response to retrieve the transaction detail (default value) - MERCHANT_REFERENCE_ID Reference ID submitted by the merchant during refund transaction

Response Params

{
    "refundId": "01HQJ41Q7135ZNJTKTWB92BTVH",
    "transactionId": "01HQHRWBC773J6CJV9VRZMBXD2",
    "merchantRefId": "S68O0whWv",
    "amount": 500000,
    "currency": "VND",
    "status": "success",
    "createdAt": "2024-02-26T14:11:12+07:00",
    "updatedAt": "2024-02-26T14:11:15+07:00"
}

Success

Http Status Code 200 - OK

The response is the same with Refund: Create API

Error

HTTP Status Code != 200