Control groups
Get a target's control groups
Retrieves a list of control groups applied to the specified target.
get/issuing/controls/control-groups
Request
- Base URLhttps://{prefix}.api.sandbox.checkout.com
- AuthOAuth 2Client credentialsToken URLstringScopesissuing:controls-read
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
target_idstring required
The ID of the card or control profile.
Example:crd_fa6psq42dcdd6fdn5gifcq1491
Response
Target's control groups retrieved successfully
Example response
{
"control_groups": [
{
"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"
},
{
"id": "cgr_xvrszbgkaifuflnslzkt2uimkm",
"description": "Allow restaurants except McDonalds",
"target_id": "crd_dba7tjsh7utufgid7yety4gnxq",
"fail_if": "all_fail",
"controls": [
{
"mcc_limit": {
"type": "allow",
"mcc_list": [
6789
]
},
"description": "Allow the card being used for restaurants",
"control_type": "mcc_limit"
},
{
"mid_limit": {
"type": "block",
"mid_list": [
9876
]
},
"description": "Block the card to be used at McDonalds",
"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"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.