Sign in

v1

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

Get dormancy configuration

Retrieves a dormancy configuration by its ID. Also returns past configurations if you include a showPrevious query parameter set to 'true'.

get/corporate/v1/dormancy-config/{dormancyConfigId}

Path parameters

dormancyConfigIdstring required

Dormancy configuration ID. This is the ID that the Pismo platform generates when you use Create dormancy configuration to set up dormancy.

Query parameters

showPreviousboolean

If true, returns the previous dormancy configurations. For example, if you use Update dormancy configuration to update an existing dormancy configuration, specifying true in this field returns both the current dormancy configuration and the previous ones.<br> There is no limit to how many previous dormancy configurations can be returned.

Response

OK

idstring uuid

Dormancy configuration ID generated internally

check_timestring time

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

target_type'DIVISION' | 'PROGRAM'

Dormancy configuration target

target_idstring

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 response

{
  "id": "b993ba96-b3e8-4ef7-9cf7-7eee5ddafdab",
  "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"
        }
      ]
    }
  ],
  "dormant_processing_codes": [
    "220040"
  ],
  "dormancy_config_validity": {
    "start": "2024-10-18T17:45:26.930Z"
  },
  "previous": [
    {
      "id": "b993ba96-b3e8-4ef7-9cf7-7eee5ddafdab",
      "check_time": "09:00:00",
      "target_type": "DIVISION",
      "target_id": "my-division-code",
      "statuses": [
        {
          "status": "NORMAL",
          "days": 19,
          "reason_id": 1438
        }
      ],
      "dormant_processing_codes": [
        "220040"
      ],
      "dormancy_config_validity": {
        "start": "2024-10-18T17:45:26.930Z",
        "end": "2023-08-14T22:12:48.961Z"
      },
      "deny_forced_transaction_reactivation": true,
      "reactivation_exceptions_config": {
        "field": "soft_descriptor",
        "values": [
          "001"
        ]
      }
    }
  ],
  "deny_forced_transaction_reactivation": true,
  "check_timezone_origin": "PROGRAM",
  "reactivation_exceptions_config": {
    "field": "soft_descriptor",
    "values": [
      "001"
    ]
  }
}