CHcheckout
Control groups

Get control group details

Retrieves the details of a control group you created previously.

get/issuing/controls/control-groups/{controlGroupId}

Request

Path parameters

controlGroupIdstring required

The control group's unique identifier.

Example:cgr_oemoyd3otivelkhf4zcnimwdva

Response

Control group retrieved successfully

idstring required

The control group's unique identifier.

descriptionstring

A description for the control group.

target_idstring required

The ID of the card or control profile.

fail_if'all_fail' | 'any_fail' required

Sets how to determine the result of the group.

is_editableboolean required

Indicates whether the control group is set to readonly. Control groups marked as non-editable are predefined by Checkout and are not modifiable by clients.

created_datestring date-time required
last_modified_datestring date-time required

Example response

{
  "id": "cgr_oemoyd3otivelkhf4zcnimwdva",
  "description": "Block grocery shopping except Walmart",
  "target_id": "crd_dba7tjsh7utufgid7yety4gnxq",
  "fail_if": "all_fail",
  "controls": [
    {
      "mcc_limit": {
        "type": "block",
        "mcc_list": [
          5422
        ]
      },
      "description": "Block the card being used for groceries",
      "control_type": "mcc_limit"
    },
    {
      "mid_limit": {
        "type": "allow",
        "mid_list": [
          1234
        ]
      },
      "description": "Allow the card to be used at Walmart",
      "control_type": "mid_limit"
    }
  ],
  "is_editable": true,
  "created_date": "2023-12-06T14:01:31.7155085+00:00",
  "last_modified_date": "2023-12-06T14:01:31.7155085+00:00",
  "_links": {
    "self": {
      "href": "https://{prefix}.api.checkout.com/issuing/controls/control-groups/cgr_oemoyd3otivelkhf4zcnimwdva",
      "actions": [
        "GET"
      ],
      "types": [
        "application/json"
      ]
    }
  }
}

Changes

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