> For the complete documentation index, see [llms.txt](https://docs.udara360.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.udara360.io/udara360-docs-1/savings/frequentsavings/liquidate-frequent-savings.md).

# Liquidate Frequent Savings

The "Liquidate Frequent Savings" endpoint allows customers to liquidate a frequent savings account, either fully or in part.

<mark style="color:yellow;">`POST`</mark> `/api/savingsaccount/v1/frequentsavings/liquidate`

To liquidate a frequent savings account, you need to provide the necessary body parameters, such as `accountNumber`, `liquidationType`, and other relevant details.

**Headers**

| Name                                                | Value                |
| --------------------------------------------------- | -------------------- |
| Content-Type<mark style="color:red;">\*</mark>      | `application/json`   |
| Authorization<mark style="color:red;">\*</mark>     | `Bearer`             |
| Request-Reference<mark style="color:red;">\*</mark> | `{unique_reference}` |

**Body**

<table><thead><tr><th>Name</th><th>Data Type (Length)</th><th data-type="checkbox">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>accountNumber</code></td><td>string (50)</td><td>true</td><td>This is the Savings Account that will be debited.<br><br><em><mark style="color:red;">This is not the Liquidation Account.</mark></em></td></tr><tr><td><code>liquidationAmount</code></td><td>Integer</td><td>true</td><td>The amount to be liquidated.<br><br><em><mark style="color:red;">The amount should be sent in the base unit of the currency. For example, 1000 naira will be sent as 1000 * 100.</mark></em><br><br></td></tr><tr><td><code>partLiquidationFee</code></td><td>Integer</td><td>false</td><td>The percentage fee applied if there is a Pre-Liquidation Fee.<br><br><em><mark style="color:red;">If there is a Pre-Liquidation Fee, it should be passed here.</mark></em><br><br>Required if liquidationType = PartLiquidation</td></tr><tr><td><code>liquidationType</code></td><td><br>Integer</td><td>true</td><td><p>The type of liquidation to be performed.</p><p></p><p>Enum (FullLiquidation = 1, PartLiquidation = 2)<br><br><em><mark style="color:red;">If it is FullLiquidation, the full Principal will be liquidated and the Savings account will close, liquidationAmount is not required. For PartLiquidation, only an amount not greater than or equal to the Savings balance is accepted, and liquidationAmount is required.</mark></em></p></td></tr></tbody></table>

Here is an example request and response with a sample payload sent to the endpoint in Curl format.

<details>

<summary>Sample Request</summary>

```json
curl --location -g '{{baseurl}}/api/savingsaccount/v1/frequentsavings/liquidate' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--header 'Content-Type: application/json' \
--data '{
  "accountNumber": "string",
  "partLiquidationFee": 0,
  "liquidationType": "FullLiquidation",
  "liquidationAmount": 0
}'
```

</details>

<details>

<summary>Response: <code>200</code></summary>

```json
{
  "status": true,
  "message": "string",
  "data": {
    "statusCode": "string",
    "referenceNumber": "string",
    "instrumentNumber": "string",
    "message": "string",
    "duration": "string",
    "sessionID": "string"
  },
  "isSuccessful": true,
  "statusCode": "string",
  "referenceNumber": "string",
  "instrumentNumber": "string",
  "duration": "string",
  "sessionID": "string"
}
```

</details>