🚧

Deprecation notice

This functionality is scheduled to be deprecated. This is a continuous improvement action for the platform. For any new deployments, use Hold funds instead.

A legal or judicial block is a block that is placed on an account for legal reasons. A legal block prevents or limits financial movement within the account. The Pismo platform offers both total and partial legal blocks.

Total legal blocks

If a total legal block is placed on an account, the Pismo platform blocks all financial movement into or out of the account. A total legal block is also called a levy.

Get the current status

To find out if an account is totally blocked, you need to get its current status. You do this using the Get account details endpoint. The account is totally blocked if the status field of the response is set to "BLOCKED". The following sample response shows that the account in question is blocked.

Sample response

{
  "available_limit": 11.0,
  "program_type": "DEBIT",
  "current_cicle": null,
  "org": "TN-f60b5e18-9f53-46ce-953b-b81ddf123456",
  "document_number": "97835021234",
  "program_name": "Pismo-Prog-Debit",
  "entity_type": "PHYSICAL",
  "current_balance": null,
  "name": "Test Name",
  "acquisition_id": 16468012,
  "email": "[email protected]",
  "status": "BLOCKED"
}

Place a total legal block

📘

The Pismo platform does not distinguish between total legal blocks and other types of total blocks. In both cases, the account status is simply changed to "BLOCKED". If you need to clarify that an account is blocked for legal reasons, you can do so by adding a reason for the block.

You place a total legal block on an account by changing its status to "BLOCKED". You do this by calling the Update account status endpoint and passing the following payload in the body of the request:

{
  "status": "BLOCKED"
}

Add a reason for a total legal block

There is currently no endpoint for adding reasons, but you can contact Pismo to implement status change reasons for you. See Account status change reasons for more info.

Remove a total legal block

The act of removing a total legal block on an account is called a full legal unlock. You perform a full legal unlock by calling the Update account status endpoint and passing the following payload in the body of the request:

{  
  "status": "NORMAL"  
}