PUT//
Use this endpoint to update an MCC group. Include the token path parameter to identify the MCC group to update. You must pass all the merchant category codes you want included in the group, including existing ones you want to retain.
You must have the
program-manager role to use this endpoint.URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the MCC group. Send a GET request to /mccgroups to retrieve MCC group tokens.Allowable Values: Existing MCC group token |
Request body
| Fields | Description |
|---|---|
| active boolean Optional | Indicates whether the MCC group is active or inactive. Allowable Values: true, falseDefault value: false |
| config object Optional | Allows for configuration options for this group, including control over the expiration of authorizations and automatic increases to the authorization amount. Allowable Values: authorization_controls |
| config.authorization_controls object Optional | Controls the expiration of authorizations and automatic increases to the authorization amount for MCCs specified in this group. By default, these authorization controls apply program-wide, meaning that they apply to every card in your program. You can, however, exempt cards associated with any particular card product by setting that card product’s allow_mcc_group_authorization_controls field to false.Allowable Values: hold_expiration_days, hold_increase |
| config.authorization_controls.hold_expiration_days integer Optional | Specifies the number of days after which an authorization associated with this group expires. Allowable Values: 1–100 Default value: 7 |
| config.authorization_controls.hold_increase object Optional | Controls automatic increases to the authorization amount for MCCs specified in this group. Allowable Values: type, value |
| config.authorization_controls.hold_increase.type string Required | Controls whether the value field represents a fixed amount or a percentage of the authorization amount.Allowable Values: AMOUNT, PERCENT, UP_TO_LIMITDefault value: AMOUNT |
| config.authorization_controls.hold_increase.value decimal Required | Specifies the amount of the automatic increase to the authorization amount. The type field controls whether this amount is a fixed amount or a percentage.Allowable Values: Format: 0.00 |
| mccs array of strings Optional | Set of merchant category codes that you want to include in this group. For each element, valid characters are 0-9, and the length must be 4 digits. You can also specify a range such as “9876-9880”. An MCC can belong to more than one group. Updating the merchant category codes for the group completely replaces the group’s existing codes. For example, if the current MCC group is ["1234"] and you want to add the 2345 code (while retaining the existing code), you must specify ["1234", "2345"] in this field.Allowable Values: Valid merchant category codes |
| name string Optional | Name of the MCC group. Allowable Values: 255 char max |
Sample request body
JSON
{
"mccs": [
"0123",
"2224-2230"
]
}
Response body
| Fields | Description |
|---|---|
| active boolean Conditionally returned | Indicates whether the MCC group is active or inactive. Allowable Values: true, falseDefault value: false |
| config object Conditionally returned | Allows for configuration options for this group, including control over the expiration of authorizations and automatic increases to the authorization amount. Allowable Values: authorization_controls |
| config.authorization_controls object Conditionally returned | Controls the expiration of authorizations and automatic increases to the authorization amount for MCCs specified in this group. By default, these authorization controls apply program-wide, meaning that they apply to every card in your program. You can, however, exempt cards associated with any particular card product by setting that card product’s allow_mcc_group_authorization_controls field to false.Allowable Values: hold_expiration_days, hold_increase |
| config.authorization_controls.hold_expiration_days integer Conditionally returned | Specifies the number of days after which an authorization associated with this group expires. Allowable Values: 1–100 Default value: 7 |
| config.authorization_controls.hold_increase object Conditionally returned | Controls automatic increases to the authorization amount for MCCs specified in this group. Allowable Values: type, value |
| config.authorization_controls.hold_increase.type string Returned | Controls whether the value field represents a fixed amount or a percentage of the authorization amount.Allowable Values: AMOUNT, PERCENT, UP_TO_LIMITDefault value: AMOUNT |
| config.authorization_controls.hold_increase.value decimal Returned | Specifies the amount of the automatic increase to the authorization amount. The type field controls whether this amount is a fixed amount or a percentage.Allowable Values: Format: 0.00 |
| mccs array of strings Conditionally returned | Set of merchant category codes that you want to include in this group. For each element, valid characters are 0-9, and the length must be 4 digits. You can also specify a range such as “9876-9880”. An MCC can belong to more than one group. Updating the merchant category codes for the group completely replaces the group’s existing codes. For example, if the current MCC group is ["1234"] and you want to add the 2345 code (while retaining the existing code), you must specify ["1234", "2345"] in this field.Allowable Values: Valid merchant category codes |
| name string Conditionally returned | Name of the MCC group. Allowable Values: 255 char max |
Sample response body
JSON
{
"token": "my_mccgroup_02",
"name": "My MCC Group 02",
"mccs": [
"0123",
"2224-2230"
],
"active": true,
"config": {
"authorization_controls": {
"hold_increase": {
"type": "AMOUNT",
"value": 10
},
"hold_expiration_days": 3
}
}
}