Sign in
Dormancy

List dormancy configurations

Lists all dormancy configurations for an organization.

get/corporate/v1/dormancy-config

Query parameters

cursorstring

Cursor to the next page of results. If no value is specified, it fetches the first page.

limitinteger

Maximum number of items per page. Defaults to 10

targetType'DIVISION' | 'PROGRAM'

Type of dormancy configuration to list. If you don't specify a type, all types are listed.

Response

OK

Example response

{
  "dormancy_configs": [
    {
      "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",
        "end": "2023-08-14T22:12:48.961Z"
      },
      "deny_forced_transaction_reactivation": true,
      "check_timezone_origin": "PROGRAM"
    }
  ],
  "pagination": {
    "next_cursor": 124,
    "has_next": true
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.