# API create refund request

* This is the API used to create refund request.
* API:
  * Path: *v2/col/refund-requests*
  * Method: *POST*
  * Request: Content-Type: *application/json*

### **Request Parameter**

<table><thead><tr><th width="180">Parameter</th><th width="140">Data Type</th><th width="80">Required</th><th>Description</th></tr></thead><tbody><tr><td>requestId</td><td>String</td><td>Y</td><td>Refund request id from merchant</td></tr><tr><td>collectionTransId</td><td>String</td><td>Y</td><td>ID of collection transaction being refunded.</td></tr><tr><td>amount</td><td>Number</td><td>Y</td><td>Refund amount.</td></tr><tr><td>bankSwiftCode</td><td>String</td><td>Y</td><td>Refund request to bank swiftcode</td></tr><tr><td>bankAccountNumber</td><td>String</td><td>Y</td><td>Refund request to bank account number</td></tr><tr><td>bankAccountName</td><td>String</td><td>Y</td><td>Refund request to bank account name</td></tr><tr><td>bankBranch</td><td>String</td><td>N</td><td>Refund request to bank branch</td></tr></tbody></table>

### **Response Data**

| Parameter     | Data Type | Description                                                           |
| ------------- | --------- | --------------------------------------------------------------------- |
| code          | Number    | Error code, refer to [table of error codes](#../error-codes.md).      |
| message       | String    | Error description.                                                    |
| data          | Object    | Refer to [CreateRefundRequestResponse](#createrefundrequestresponse). |
| neoResponseId | String    | The ID of NeoX response.                                              |

#### CreateRefundRequestResponse

<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>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>status</td><td>String</td><td>Refund request status, include:<br>PENDING: Refund request has been created and waiting for approval.<br>APPROVED: Refund request has been approved.<br>REJECTED: Refund request has been rejected, view note for reject reasons.</td></tr><tr><td>approvalDate</td><td>Datetime String (ISO 8601)</td><td><p>Date of approval from NeoX.</p><p>(Will be returned when refund request was approved)</p></td></tr><tr><td>createdAt</td><td>Datetime String (ISO 8601)</td><td>Record created time</td></tr></tbody></table>