Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Dormancy

Create dormancy configuration

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.

post/corporate/v2/dormancy-config

Request body

check_timestring time required

Dormancy check time<br> <b>Note</b>: The timezone is inherited from the customer's divisions or programs.

target_type'DIVISION' | 'PROGRAM' required

Dormancy configuration target

target_idstring required

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.

dormant_processing_codesValidProcessingCode[]

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.

deny_forced_transaction_reactivationboolean

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

check_timezone_origin'PROGRAM' | 'DIVISION'

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.

Example request

{
  "check_time": "09:00:00",
  "target_type": "DIVISION",
  "target_id": "my-division-code",
  "statuses": [
    {
      "status": "NORMAL",
      "days": 19,
      "reason_external_id": "CREDIT_ONLY",
      "restrictions": [
        {
          "current_reason_external_id": "CREDIT_ONLY",
          "new_reason_external_id": "DEBIT_ONLY"
        }
      ]
    }
  ],
  "dormant_processing_codes": [
    "220040"
  ],
  "deny_forced_transaction_reactivation": true,
  "check_timezone_origin": "PROGRAM",
  "reactivation_exceptions_config": {
    "field": "soft_descriptor",
    "values": [
      "001"
    ]
  }
}

Response

Created

check_timestring time required

Dormancy check time<br> <b>Note</b>: The timezone is inherited from the customer's divisions or programs.

target_type'DIVISION' | 'PROGRAM' required

Dormancy configuration target

target_idstring required

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.

dormant_processing_codesValidProcessingCode[]

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.

deny_forced_transaction_reactivationboolean

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

idstring uuid

Dormancy configuration ID generated internally

check_timezone_origin'PROGRAM' | 'DIVISION'

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.

Example response

{
  "check_time": "09:00:00",
  "target_type": "DIVISION",
  "target_id": "my-division-code",
  "statuses": [
    {
      "status": "NORMAL",
      "days": 19,
      "reason_id": 1438,
      "reason_external_id": "CREDIT_ONLY",
      "restrictions": [
        {
          "current_reason_id": 13,
          "new_reason_id": 16,
          "current_reason_external_id": "CREDIT_ONLY",
          "new_reason_external_id": "DEBIT_ONLY"
        }
      ]
    }
  ],
  "dormancy_config_validity": {
    "start": "2024-10-18T17:45:26.930Z"
  },
  "dormant_processing_codes": [
    "220040"
  ],
  "deny_forced_transaction_reactivation": true,
  "id": "b993ba96-b3e8-4ef7-9cf7-7eee5ddafdab",
  "check_timezone_origin": "PROGRAM",
  "reactivation_exceptions_config": {
    "field": "soft_descriptor",
    "values": [
      "001"
    ]
  }
}