Update Account Lien

The request body should include specific payloads such as a required id and other parameters like FormOfLien, and amount, allowing you to modify and update existing lien information.

POST /api/accountlien/v1/updatelien A successful request will return a confirmation message indicating that the lien has been updated along with any relevant details. This process allows for the secure and efficient updating of liens on accounts, ensuring that accurate and current financial information is maintained.

Headers

Name	Value
Content-Type*	application/json
Authorization*	Bearer <token>
Request-Reference	{unique-reference}

Body

Name	Data Type (length)	Required	Description
id	string		The unique identifier of the lien (GUID)
formOfLien	string		The form or type of lien. Lien type can be a flat amount or a percentage The enumerations are: 1 = FlatAmount 2 = Percentage
amount	integer		The amount of money to be held as a lien The amount should be sent in the base unit of the currency. For example, 1000 naira will be sent as 1000 * 100. (nullable)
percentage	integer		The updated percentage of the account balance to be held The percentage must be rounded to a maximum of three decimal places.
description	string		Updated description or reason for the lien
tenure	integer		Updated duration of the lien in months
commencementDate	date		Updated start date of the lien

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

Sample Request

curl --location -g '{{baseurl}}/api/accountlien/v1/updatelien' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--header 'Content-Type: application/json' \
--data '{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "formOfLien": "string",
  "amount": 0,
  "percentage": 0,
  "description": "string",
  "tenure": 0,
  "commencementDate": "2023-01-20T23:39:49.208Z"
}'

Respose: 200

{
  "status": true,
  "message": "string",
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "referenceNumber": "string"
  }
}