Managing account statuses

The status of an account refers to its current state. There are several possible values for account status that all types of account have in common.

Account statuses that are common to all accounts

The status field for any account can contain one of the following values:

StatusDescription
NORMALAccount is active. Allows both cash-in and cash-out, based on the limits of this account.
BLOCKEDAccount is blocked. Allows cash-in only.
This is a temporary status, so it is possible to change it to NORMAL or CANCELLED when needed (details below).
CANCELLEDAccount is cancelled. No cash-in or cash-out allowed.
This is a final status, so you must use a different endpoint to roll back this status (details below).

You can use the Update account status endpoint to change the account status to one of these values. See Account status for more information.

Managing inactive/dormant corporate accounts

Corporate accounts have additional account statuses that you can use to manage inactive/dormant accounts. An account is said to be inactive/dormant if there have been no transactions on it for a certain period of time. The Pismo platform enables you to define three types of dormancy, based on the length of time an account has been idle. These are defined at the division level, as described in the following sections.

Account statuses specific to corporate accounts

The additional account statuses for corporate banking are:

  • INACTIVE
  • DORMANT
  • UNCLAIMED

For corporate accounts in any of the inactive statuses, a customer initiated transaction will reactivate the account and send the status back to normal. The account status reasons are a way of controlling what types of transactions are accepted into the account, activating the account as a consequence.

An automated process within the Pismo platform checks for accounts that have been idle for a certain minimum number of days, and, when it finds one, it changes the account status to one of the above values. Generally, an idle account first becomes INACTIVE; if it remains INACTIVE long enough, it becomes DORMANT; and, if it remains DORMANT long enough, its status changes to UNCLAIMED. The length of time an account must remain idle before each of these changes occurs depends on your custom settings. You configure this length of time at the same time that you configure the reason for the change. The next section shows you how to configure these settings.

Configuring dormancy statuses and change reasons

When the status of an account changes to or from one of these additional statuses, the Pismo platform records the reason for the change. The available account status change reasons for this feature are:

  • NO CREDIT - You can't put money in the account.
  • NO DEBIT - You can't withdraw money from the account
  • ANY - The account status changed to NORMAL.
  • MANUAL - You can't withdraw money or put money in.

These parameters must be applied by division, using the Update division endpoint. Instead of passing the reason directly, you pass its reason_id. To get a list of these IDs, use List account status reasons. The following code illustrates the type of response you should get back when you call this endpoint:

[
  {
    "code": "24",
    "reason_id": 123,
    "description": "NO CREDIT"
  },
  {
    "code": "25",
    "reason_id": 456,
    "description": "NO DEBIT"
  },
  {
    "code": "26",
    "reason_id": 789,
    "description": "ANY"
  },
  {
    "code": "27",
    "reason_id": 952,
    "description": "MANUAL"
  }
]

The response is an array of status objects, where each object consists of the code for the new status, the reason_id, and the description.

📘

If a transaction is posted and the current account status is INACTIVE, DORMANT, or UNCLAIMED, then the account's status should change to NORMAL.

When you use the Update division endpoint, you also pass the length of time (in days) an account must be idle before the status change occurs.

The following code demonstrates how you pass the values for these parameters in the body of the Update divisionrequest:

{
    "job_params": {
        "inactive": {
            "days": 60,
            "reason_id": 123
        },
        "unclaimed": {
            "days": 180,
            "reason_id": 456
        },
        "dormant": {
            "days": 360,
            "reason_id": 789
        }
    }
}

The following table shows how the account status change reason relates the operation being performed to the account status:

Reason nameOperationStatus of operation
Credit OnlyCash-inEnabled (customer can perform a cash-in credit operation)
Credit OnlyCash-outDisabled (customer cannot perform a cash-out credit operation)
Debit OnlyCash-inDisabled (customer cannot perform a cash-in debit operation)
Debit OnlyCash-outEnabled (customer can perform a cash-out debit operation)
AnyCash-inEnabled (customer can perform a cash-in credit or debit operation)
AnyCash-outEnabled (customer can perform a cash-out credit or debit operation)
ManualCash-inDisabled (account can only be reactivated manually)
ManualCash-outDisabled (account can only be reactivated manually)

📘

Account status change reasons must be mapped to the Org. This is configured during the Setup of the Org.