Clear lien on an account

PATCH /api/v1/Accounts/clear-lien

Description

This endpoint allows you to clear a lien on an account. When a lien is cleared, any restrictions or holds on the account are removed, and the account is restored to its original status.

Request

• Path Parameters:

  • version: API version (string)

• Headers:

  • Accept-Language: Change default response message language from English(en). Available languages fr,en

• Request Body:

  • ClearLienOnAccountCommand: Represents the command to clear a lien on an account (object)

Responses

• 200: Success. Returns a StringResponse.

• 400: Bad Request. The request is not valid.

Examples

Request

httpCopy codePATCH /api/v{version}/Accounts/clear-lien HTTP/1.1
Host: example.com
Accept-Language: en
Content-Type: application/json
{
  "accountId": "1234"
}

Response

httpCopy codeHTTP/1.1 200 OK
{
  "message": "The lien has been successfully cleared from the account."
}

Error Response

httpCopy codeHTTP/1.1 400 Bad Request
{
  "message": "Invalid account ID."
}

/api/v`{{version}}`/Accounts/clear-lien

Headers

Content-Type	Value
Accept-Language

Headers

Content-Type	Value
Content-Type	application/json

Headers

Content-Type	Value
Accept	text/plain

Body (raw)

{
  "accountNumber": `<string>`,
  "transactionId": `<long>`
}

Response: 200

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": `<string>`
}

Response: 400

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": `<string>`
}