Group multiple spending controls together and specify how to apply the combined outcome.
Group multiple spending controls together and specify how to apply the combined outcome.
Creates a control group and applies it to the specified target.
The control group to create.
Pattern: ^(crd|cpr)_[a-z0-9]{26}$The ID of the card or control profile to apply the control to. Note that control profiles cannot be a target for velocity_limit controls.
Sets how to determine the result of the group.
The controls that belong to the group.
The control to create.
A description for the control group.
Unauthorized
Target not found
Internal Server Error
Service Unavailable
curl 'https://{prefix}.api.sandbox.checkout.com/issuing/controls/control-groups' \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"description": "Block grocery shopping except Walmart",
"fail_if": "all_fail",
"target_id": "crd_fa6psq42dcdd6fdn5gifcq1491",
"controls": [
{
"description": "Block the card being used for groceries",
"control_type": "mcc_limit",
"mcc_limit": {
"type": "block",
"mcc_list": [
"5422"
]
}
},
{
"description": "Allow the card to be used at Walmart",
"control_type": "mid_limit",
"mid_limit": {
"type": "allow",
"mid_list": [
"1234"
]
}
}
]
}'
{
"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.7155085Z",
"last_modified_date": "2023-12-06T14:01:31.7155085Z",
"_links": {
"self": {
"href": "https://{prefix}.api.checkout.com/issuing/controls/control-groups/cgr_oemoyd3otivelkhf4zcnimwdva",
"actions": [
"GET"
],
"types": [
"application/json"
]
}
}
}Retrieves a list of control groups applied to the specified target.
Pattern: ^(crd|cpr)_[a-z0-9]{26}$The ID of the card or control profile.
Unauthorized
Target not found
Internal Server Error
curl 'https://{prefix}.api.sandbox.checkout.com/issuing/controls/control-groups?target_id=crd_fa6psq42dcdd6fdn5gifcq1491' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
"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.7155085Z",
"last_modified_date": "2023-12-06T14:01:31.7155085Z"
},
{
"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.7155085Z",
"last_modified_date": "2023-12-06T14:01:31.7155085Z"
}
]
}Retrieves the details of a control group you created previously.
Pattern: ^cgr_[a-z0-9]{26}$The control group's unique identifier.
Unauthorized
Control group not found
Internal Server Error
curl 'https://{prefix}.api.sandbox.checkout.com/issuing/controls/control-groups/cgr_oemoyd3otivelkhf4zcnimwdva' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
"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.7155085Z",
"last_modified_date": "2023-12-06T14:01:31.7155085Z",
"_links": {
"self": {
"href": "https://{prefix}.api.checkout.com/issuing/controls/control-groups/cgr_oemoyd3otivelkhf4zcnimwdva",
"actions": [
"GET"
],
"types": [
"application/json"
]
}
}
}Removes the control group and all the controls it contains.
If you want to reapply an equivalent control group to the card, you'll need to create a new control group.
Pattern: ^cgr_[a-z0-9]{26}$The control group's unique identifier.
Unauthorized
Control group not found
Internal Server Error
Service Unavailable
curl 'https://{prefix}.api.sandbox.checkout.com/issuing/controls/control-groups/cgr_oemoyd3otivelkhf4zcnimwdva' \
--request DELETE \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
"id": "cgr_oemoyd3otivelkhf4zcnimwdva"
}