Replace a card group's spending constraint

Authorizations

X-API-Key

string

header

required

Authentication from public API requests

Path Parameters

cardGroupId

string

required

Body

application/json

A constraint that can be applied to a CardGroupSpendingRule

countryRule

object | null

countryRule.countries

string[]

required

A 2 digit country code

countryRule.restriction

enum<string>

required

Available options:

allowlist,

blacklist

merchantCategoryCodeRule

object | null

merchantCategoryCodeRule.merchantCategoryCodes

string[]

required

merchantCategoryCodeRule.restriction

enum<string>

required

Available options:

allowlist,

blacklist

merchantCategoryRule

object | null

merchantCategoryRule.merchantCategories

string[]

required

merchantCategoryRule.restriction

enum<string>

required

Available options:

allowlist,

blacklist

merchantRule

object | null

merchantRule.merchants

string[]

required

merchantRule.restriction

enum<string>

required

Available options:

allowlist,

blacklist

spendingRule

object | null

spendingRule.transactionSizeLimit

object

spendingRule.transactionSizeLimit.maximum

object

Represents a monetary value

spendingRule.transactionSizeLimit.maximum.amountCents

integer

required

The amount in cents

spendingRule.transactionSizeLimit.minimum

object

Represents a monetary value

spendingRule.transactionSizeLimit.minimum.amountCents

integer

required

The amount in cents

spendingRule.utilizationLimit

object

spendingRule.utilizationLimit.limitAmount

object

required

Represents a monetary value

spendingRule.utilizationLimit.limitAmount.amountCents

integer

required

The amount in cents

spendingRule.utilizationLimit.preset

enum<string>

required

Available options:

daily,

weekly,

monthly,

yearly,

collective

spendingRule.utilizationLimit.startDate

string

Format ISO-8601. A day that equals today or the past. This is optional.If the preset is "daily", this value is ignored. If the preset is "weekly", "monthly" or "yearly", then the this value is used to compute when the limit should start limit.

spendingRule.utilizationLimit.timezone

string

IANA timezone string. Limits always reset at midnight of the timezone specified. If no timezone is specified, then UTC time is used.

spendingRule.utilizationLimitV2

object[]

spendingRule.utilizationLimitV2.limitAmount

object

required

Represents a monetary value

spendingRule.utilizationLimitV2.limitAmount.amountCents

integer

required

The amount in cents

spendingRule.utilizationLimitV2.preset

enum<string>

required

Available options:

daily,

weekly,

monthly,

yearly,

collective

spendingRule.utilizationLimitV2.startDate

string

spendingRule.utilizationLimitV2.timezone

string

IANA timezone string. Limits always reset at midnight of the timezone specified. If no timezone is specified, then UTC time is used.

Response

200 - application/json

A constraint that can be applied to a CardGroupSpendingRule

countryRule

object | null

countryRule.countries

string[]

required

A 2 digit country code

countryRule.restriction

enum<string>

required

Available options:

allowlist,

blacklist

merchantCategoryCodeRule

object | null

merchantCategoryCodeRule.merchantCategoryCodes

string[]

required

merchantCategoryCodeRule.restriction

enum<string>

required

Available options:

allowlist,

blacklist

merchantCategoryRule

object | null

merchantCategoryRule.merchantCategories

string[]

required

merchantCategoryRule.restriction

enum<string>

required

Available options:

allowlist,

blacklist

merchantRule

object | null

merchantRule.merchants

string[]

required

merchantRule.restriction

enum<string>

required

Available options:

allowlist,

blacklist

spendingRule

object | null

spendingRule.transactionSizeLimit

object

spendingRule.transactionSizeLimit.maximum

object

Represents a monetary value

spendingRule.transactionSizeLimit.maximum.amountCents

integer

required

The amount in cents

spendingRule.transactionSizeLimit.minimum

object

Represents a monetary value

spendingRule.transactionSizeLimit.minimum.amountCents

integer

required

The amount in cents

spendingRule.utilizationLimit

object

spendingRule.utilizationLimit.limitAmount

object

required

Represents a monetary value

spendingRule.utilizationLimit.limitAmount.amountCents

integer

required

The amount in cents

spendingRule.utilizationLimit.preset

enum<string>

required

Available options:

daily,

weekly,

monthly,

yearly,

collective

spendingRule.utilizationLimit.startDate

string

spendingRule.utilizationLimit.timezone

string

IANA timezone string. Limits always reset at midnight of the timezone specified. If no timezone is specified, then UTC time is used.

spendingRule.utilizationLimitV2

object[]

spendingRule.utilizationLimitV2.limitAmount

object

required

Represents a monetary value

spendingRule.utilizationLimitV2.limitAmount.amountCents

integer

required

The amount in cents

spendingRule.utilizationLimitV2.preset

enum<string>

required

Available options:

daily,

weekly,

monthly,

yearly,

collective

spendingRule.utilizationLimitV2.startDate

string

spendingRule.utilizationLimitV2.timezone

string

IANA timezone string. Limits always reset at midnight of the timezone specified. If no timezone is specified, then UTC time is used.

Overview

Entities

Legal Entity

Account

Virtual Account

Transaction

Slash Pay

Card

Card Group

Merchant

Webhooks

Replace a card group's spending constraint

Authorizations

Path Parameters

Body

Response