Skip to main content
POST
Create 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.

Body

Creates a velocity control — a spend/usage limit over a rolling window. Omit Guid? CreateVelocityControlRequest.CardId for an organization-scoped control (the caller's resolved org); supply it for a card-scoped control.

id
string
required

Caller-supplied identifier, unique within the organization.

amountLimit
required

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

currencyCode
string
required

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

name
string
required

Human-readable name for the control.

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
active
boolean

Whether the control is active when created. Defaults to false.

cardId
null | string<uuid>

Set to scope the control to a single debit card; omit for an organization-scoped control.

mcc
null | string

Optional single MCC to narrow the control to.

mccGroup
null | string

Optional MCC group id to narrow the control to.

usageLimit

Maximum transactions in the window; -1 is unlimited. Must be omitted when VelocityWindow CreateVelocityControlRequest.VelocityWindow is VelocityWindow.TRANSACTION.

Response

Created

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