Parameter | Type | Description |
---|---|---|
name | string | Name for the card controls. |
controls | array[objects] | An array of control configurations, as outlined below |
Parameter | Type | Description |
---|---|---|
type | string | The type of control configuration, e.g. merchant_restriction . |
version | number | A version number. |
merchant_restriction
configurations allow you to allow
or disallow
the use of a Card or Card Product at specific categories of merchants.
When a merchant restriction is created to allow
certain merchant category codes (MCCs) or merchant IDs (MIDs), only transaction at vendors listed with those MCCs or MIDs in the card network will be approved. All other transactions will be declined. The call must have an array of MCCs or MIDs passed, or a combination of the two.
Parameter | Type | Required? | Description |
---|---|---|---|
type | string | Required | Name of this card controls object. |
version | number | Required | Version of configuration (currently: 2) |
restriction | string | Required | Either allow or disallow , for allowing or disallowing the list of mccs |
mccs | array[string] | An array of four digit numeric strings, representing the merchant categories to allow or disallow. Required if mids are not passed. | |
mids | array[string] | An array of alphanumeric strings, representing the merchant id to allow or disallow. Required if mccs are not passed. |
spend_limit
configurations allow you to configure a maximum spending amount within a timeframe (e.g. no more than $1000 in authorized transactions within 24 hours).
Parameter | Type | Required? | Description |
---|---|---|---|
type | string | Required | Name of this card controls object. |
version | number | Required | Version of configuration (currently: 1). |
amount | string | Required | Total amount of authorizated transactions to allow within the window. |
interval | string | Required | Type of interval for calculating total amount of transactions. One of: rolling , daily , or monthly . |
window | number | Number of hours for calculating rolling window. Required if interval is rolling . | |
timezone | string | Timezone for when rollover_time should reset. Acceptable values are tz database timezones and can be found here. Commonly one of America/Los_Angeles , America/Chicago , America/New_York , and UTC . Required if interval is daily or monthly . | |
rollover_time | string | Timestamp of when daily or monthly limits reset. Timestamp is in military time and only accepts hours and minutes such as 18:30 . Required if interval is daily or monthly . |
withdrawal_limit
configurations allow you to configure a maximum amount of ATM withdrawals within a timeframe (e.g. not more than $400 in ATM transactions within 24 hours).
Parameter | Type | Required? | Description |
---|---|---|---|
type | string | Required | Name of this card controls object. |
version | number | Required | Version of configuration (currently: 1). |
amount | string | Required | Total amount of ATM transactions to allow within the window. |
interval | string | Required | Type of interval for calculating total amount of transactions. One of: rolling , daily , or monthly . |
window | number | Number of hours for calculating rolling window. Required if interval is rolling . | |
timezone | string | Timezone for when rollover_time should reset. Acceptable values are tz database timezones and can be found here. Commonly one of America/Los_Angeles , America/Chicago , America/New_York , and UTC . Required if interval is daily or monthly . | |
rollover_time | string | Timestamp of when daily or monthly limits reset. Timestamp is in military time and only accepts hours and minutes such as 18:30 . Required if interval is daily or monthly . |
create
and update
endpoints for Card and Card Product objects accept a card_controls
attribute and will associate them with the resource being created or updated.
mccs
and mids
on a specific card.