APIs
Sub-processorsAbout PismoContact us

Create dormancy configuration

post
https://sandbox.pismolabs.io/corporate/v2/dormancy-config

Create a dormancy configuration at the division or program level. This configuration sets the days of inactivity required for accounts to switch to a dormant status and the reason for the switch. The dormancy configuration is applied to all accounts under the specified division or program. Automated dormancy checks are performed according to the number of days specified in the dormancy configuration.

For information about dormancy, refer to Dormancy overview.

This endpoint generates a Dormancy configuration created event.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Create dormancy configuration request body

string
required
length ≤ 8

Dormancy check time
Note: The timezone is inherited from the customer's divisions or programs.

string
enum
required

Dormancy configuration target

Allowed:
string
required
length ≤ 60

Target ID. When target_type is DIVISION, this value is the division code. Likewise, when target_type is PROGRAM, the value is the program ID, and so on.

statuses
array of objects
required

List of objects containing all the information pertinent to an organization's valid account status

statuses*
dormant_processing_codes
array of objects

List of processing codes that prevent account reactivation. If there are financial transactions in an account that were made with any of these codes, the account cannot be reactivated.

dormant_processing_codes
boolean
Defaults to false

Whether an account under that dormancy configuration should be reactivated when a forced transaction is made to that account (true) or not (false).

string
enum

Specify whether the dormancy check uses the timezone of the account’s program or division. If not specified, the timezone of target_id is used.

Allowed:
reactivation_exceptions_config
object

Specifies configuration rules that allow certain transactions to bypass dormancy reactivation based on defined transaction attributes and their corresponding values.

Responses

401

Access token is missing or invalid

403

The request has been lost

Updated 22 days ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 22 days ago