Skip to main content
PUT
Update velocity control
This feature is in Beta and not ready for production integration.

Authorizations

Authorization
string
header
required

Application (M2M) OAuth2 access token (client credentials).

Headers

X-Organization-ID
string<uuid>

ID of the organization to perform this operation on behalf of. Required for BANK and PLATFORM app token callers targeting a specific organization. If omitted, the request uses the authenticated caller's own organization. Must be a valid non-empty UUID. Present but malformed values return 400.

Path Parameters

id
string
required

Body

A partial update to a velocity control. Only supplied fields are applied. When long? UpdateVelocityControlRequest.AmountLimit is supplied, string? UpdateVelocityControlRequest.CurrencyCode must be supplied too.

active
null | boolean
amountLimit

Maximum spend within the window, in the currency's minor units (e.g. cents).

cardId
null | string<uuid>
currencyCode
null | string

ISO 4217 currency code (e.g. USD). Required when long? UpdateVelocityControlRequest.AmountLimit is set.

mcc
null | string
mccGroup
null | string
name
null | string
usageLimit
velocityWindow
null | enum<string>

The rolling period a velocity control's amount and usage limits are evaluated over. TRANSACTION applies the limit per-transaction and therefore carries no usage limit.

Available options:
DAY,
LIFETIME,
MONTH,
TRANSACTION,
WEEK

Response

OK

A velocity control. Exactly one of Guid? VelocityControlResponse.OrganizationId (organization-scoped) or Guid? VelocityControlResponse.CardId (card-scoped) is set.

id
string
required
active
boolean
required
amountLimit
required

Maximum spend within the window, in the currency's minor units (e.g. cents).

createdAt
string<date-time>
required
currencyCode
string
required

ISO 4217 currency code (e.g. USD).

name
string
required
updatedAt
string<date-time>
required
velocityWindow
enum<string>
required

The rolling period a velocity control's amount and usage limits are evaluated over. TRANSACTION applies the limit per-transaction and therefore carries no usage limit.

Available options:
DAY,
LIFETIME,
MONTH,
TRANSACTION,
WEEK
cardId
null | string<uuid>
mcc
null | string
mccGroup
null | string
organizationId
null | string<uuid>
usageLimit