Place Account Lien

To place a lien on an account, you need to make a POST request to the designated API endpoint with the required URL path parameters. The request body should include specific payloads, such as accountNumber, formOfLien, and referenceNumber. POST /api/accountlien/v1/placelien A successful request will return a confirmation message along with the lien ID for future reference in the response. This process enables you to securely place liens on accounts, providing important financial safeguards.

Headers

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

Body

Name	Data Type (length)	Required	Description
accountNumber	string		The account number to be placed on the lien
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
referenceNumber	string		A unique reference number for the lien "This is necessary when processing a transaction that requires the automatic release of the lien."
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 percentage of the account balance to be held as a lien
description	string		Description/reason for placing the lien The percentage should be shown with a maximum of three decimal places. (nullable)
tenure	integer		The duration of the lien in months
commencementDate	date		The date when the lien will start

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/placelien' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--header 'Content-Type: application/json' \
--data '{
  "accountNumber": "string",
  "formOfLien": "string",
  "referenceNumber": "string",
  "amount": 0,
  "percentage": 0,
  "description": "string",
  "tenure": 0,
  "commencementDate": "2023-01-20T23:38:50.196Z"
}'

Respose: 200

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