Refund: Detail
EndPoint
GET
/credit-card/refund/:creditCardRefundId
Header Params
{
Content-Type: "application/json",
X-APPOTAPAY-AUTH: "your_auth_token",
Language: "en", // option vi | en, default vi
X-Request-ID: "your_request_id" // optional - easy to debug request
}
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