Set spending controls to limit how much can be spent over a given period of time.
Set spending controls to limit how much can be spent over a given period of time.
Creates a control and applies it to the specified target.
Pattern: ^[A-Za-z0-9._-]+$An optional idempotency key for safely retrying Issuing requests.
The control to create.
The control to create.
The control to create.
The control's type.
A velocity_limit determines how much can be spent over a given period of time. An mcc_limit determines the types of businesses from which transactions can be processed. A mid_limit specifies the merchants from whom transactions can be processed.
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.
The velocity limit, which determines how much a target card can spend over a given timeframe.
A description for the control.
Unauthorized
Target not found
Internal Server Error
Service Unavailable
curl 'https://{prefix}.api.sandbox.checkout.com/issuing/controls' \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"description": "Maximum spend of 500€ per week for restaurants",
"control_type": "velocity_limit",
"target_id": "crd_fa6psq42dcdd6fdn5gifcq1491",
"velocity_limit": {
"amount_limit": 50000,
"velocity_window": {
"type": "weekly"
},
"mcc_list": [
""
],
"mid_list": [
"1234567890"
]
}
}'
{
"id": "ctr_gp7vkmxayztufjz6top5bjcdra",
"description": "Maximum spend of 500€ per week for restaurants",
"control_type": "velocity_limit",
"target_id": "crd_fa6psq42dcdd6fdn5gifcq1491",
"is_editable": true,
"created_date": "2023-03-12T18:20:12Z",
"last_modified_date": "2023-03-12T18:20:12Z",
"velocity_limit": {
"amount_limit": 50000,
"velocity_window": {
"type": "weekly"
},
"mcc_list": [
"4121",
"4582"
]
},
"_links": {
"self": {
"href": "https://{prefix}.api.checkout.com/issuing/controls/ctr_gp7vkmxayztufjz6top5bjcdra",
"actions": [
"GET"
],
"types": [
"application/json"
]
}
}
}Retrieves a list of spending controls 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?target_id=crd_fa6psq42dcdd6fdn5gifcq1491' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
"controls": [
{
"id": "ctr_gp7vkmxayztufjz6top5bjcdra",
"target_id": "crd_fa6psq42dcdd6fdn5gifcq1491",
"description": "Maximum spend of 500€ per week for restaurants",
"control_type": "velocity_limit",
"is_editable": true,
"created_date": "2021-09-09T19:41:39Z",
"last_modified_date": "2021-09-09T19:41:39Z",
"velocity_limit": {
"amount_remaining": 45000,
"amount_limit": 50000,
"velocity_window": {
"type": "weekly"
},
"mcc_list": [
"4121",
"4582"
]
}
},
{
"id": "ctr_gp7vkmxayztufjz6top5bjcdra",
"target_id": "crd_fa6psq42dcdd6fdn5gifcq1491",
"description": "Allow the card to be used only in restaurants and supermarkets",
"control_type": "mcc_limit",
"is_editable": true,
"created_date": "2021-09-09T19:41:39Z",
"last_modified_date": "2021-09-09T19:41:39Z",
"mcc_limit": {
"type": "allow",
"mcc_list": [
"5932",
"5411"
]
}
},
{
"id": "ctr_gp7vkmxayztufjz6top5bjcdra",
"target_id": "crd_fa6psq42dcdd6fdn5gifcq1491",
"description": "Allow the card to be used only in AZ Pizza",
"control_type": "mid_limit",
"is_editable": true,
"created_date": "2021-09-09T19:41:39Z",
"last_modified_date": "2021-09-09T19:41:39Z",
"mid_limit": {
"type": "allow",
"mid_list": [
"593278",
"541114"
]
}
}
]
}Retrieves the details of an existing control.
Pattern: ^ctr_[a-z0-9]{26}$The control's unique identifier.
Pattern: ^crd_[a-z0-9]{26}$The unique identifier for the card you want to get the remaining cascading velocity control for.
The card's unique identifier.
Unauthorized
Control not found
Internal Server Error
curl 'https://{prefix}.api.sandbox.checkout.com/issuing/controls/ctr_gp7vkmxayztufjz6top5bjcdra' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
"id": "ctr_gp7vkmxayztufjz6top5bjcdra",
"target_id": "crd_fa6psq42dcdd6fdn5gifcq1491",
"description": "Maximum spend of 500€ per week for restaurants",
"control_type": "velocity_limit",
"is_editable": true,
"created_date": "2023-03-12T18:20:12Z",
"last_modified_date": "2023-03-12T18:20:12Z",
"velocity_limit": {
"amount_remaining": 45000,
"amount_limit": 50000,
"velocity_window": {
"type": "weekly"
},
"mcc_list": [
"4121",
"4582"
]
}
}Updates an existing control.
Pattern: ^ctr_[a-z0-9]{26}$The control's unique identifier.
The control you want to update.
You can update only one control per request.
A description for the control.
The merchant category code (MCC) rule, which determines the types of businesses transactions can be processed from.
Unauthorized
Control not found
Internal Server Error
Service Unavailable
curl 'https://{prefix}.api.sandbox.checkout.com/issuing/controls/ctr_gp7vkmxayztufjz6top5bjcdra' \
--request PUT \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"description": "Allow the card to be used only in restaurants and supermarkets",
"mcc_limit": {
"type": "allow",
"mcc_list": [
"5932",
"5411"
]
}
}'
{
"id": "ctr_gp7vkmxayztufjz6top5bjcdra",
"target_id": "crd_fa6psq42dcdd6fdn5gifcq1491",
"description": "Maximum spend of 500€ per week for restaurants",
"control_type": "velocity_limit",
"is_editable": true,
"created_date": "2023-03-12T18:20:12Z",
"last_modified_date": "2023-03-12T18:20:12Z",
"velocity_limit": {
"amount_remaining": 45000,
"amount_limit": 50000,
"velocity_window": {
"type": "weekly"
},
"mcc_list": [
"4121",
"4582"
]
}
}Removes an existing control from the target it was applied to.
If you want to reapply an equivalent control to the target, you must create a new control.
Pattern: ^ctr_[a-z0-9]{26}$The control's unique identifier.
Unauthorized
Control not found
Internal Server Error
Service Unavailable
curl 'https://{prefix}.api.sandbox.checkout.com/issuing/controls/ctr_gp7vkmxayztufjz6top5bjcdra' \
--request DELETE \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
"id": "ctr_gp7vkmxayztufjz6top5bjcdra"
}