# API get detail refund request

* **Purpose**: This is the API used to get detail of refund request by with requestId provided by merchant.
* **API**:
  * Path: ***v2/col/refund-requests/:requestId***
  * Method: ***GET***
  * Request: Content-Type: ***application/json***

### **Request Parameter**

<table><thead><tr><th width="239">Parameter</th><th width="124">Data Type</th><th width="101">Required</th><th>Description</th></tr></thead><tbody><tr><td>requestId</td><td>String</td><td>Y</td><td>The requestId when merchant create refund request.</td></tr></tbody></table>

### **Response Data**

| Parameter     | Data Type | Description                                                                                        |
| ------------- | --------- | -------------------------------------------------------------------------------------------------- |
| code          | Number    | Error code, refer to [Error codes](https://docs.neox.vn/docs/collections/integration/error-codes). |
| message       | String    | Error description.                                                                                 |
| data          | Object    | Refer to [GetDetailRefundRequestResponse](#getdetailrefundrequestresponse).                        |
| neoResponseId | String    | The ID of NeoX response.                                                                           |

#### GetDetailRefundRequestResponse

<table><thead><tr><th width="187.33333333333331">Parameter</th><th width="127">Data Type</th><th>Description</th></tr></thead><tbody><tr><td>merchantCode</td><td>String</td><td>Merchant Code</td></tr><tr><td>requestId</td><td>String</td><td>The requestId when creating refund request.</td></tr><tr><td>collectionTransId</td><td>String</td><td>ID of collection transaction being refunded.</td></tr><tr><td>refundTransId</td><td>String</td><td><p>ID of refund transaction from NeoX.</p><p>(Will be returned when refund request was approved)</p></td></tr><tr><td>amount</td><td>Number</td><td>Refund amount.</td></tr><tr><td>bankSwiftCode</td><td>String</td><td>Refund request to bank swiftcode</td></tr><tr><td>bankAccountNumber</td><td>String</td><td>Refund request to bank account number</td></tr><tr><td>bankAccountName</td><td>String</td><td>Refund request to bank account name</td></tr><tr><td>bankBranch</td><td>String</td><td>Refund request to bank branch</td></tr><tr><td>approvalStatus</td><td>String</td><td>Refund request status, Include:<br>PENDING: Refund request is waiting for approval.<br>APPROVED: Refund request was approved.<br>REJECTED: Refund request was rejected.</td></tr><tr><td>status</td><td>String</td><td>Refund transaction status, Include:<br>PROCESSING: Refund transaction is being processed<br>SUCCESS: Refund transaction was successful<br>FAILED: Refund transaction was failed</td></tr><tr><td>note</td><td>String</td><td>Note for current refund request.</td></tr><tr><td>failedReason</td><td>String</td><td>Return failed reason from banking system if refund transaction was failed</td></tr><tr><td>createdAt</td><td>Datetime String (ISO 8601)</td><td>Record created time</td></tr><tr><td>updatedAt</td><td>Datetime String (ISO 8601)</td><td>Record last updated time</td></tr></tbody></table>