This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 23:35 UTC.
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Velocity Handler configuration: how many transactions, and how much value, this merchant may
run inside each window.
Values
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
Field
Type
Description
enabledrequired
boolean
Whether this rule runs. False, the default, means the rule is skipped and never flags a
transaction. A rule that is enabled but has no usable settings also screens nothing.
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
What happens when this rule flags a transaction. `AuditOnly`, the default, records the
detection and lets the transaction continue. `Stop` halts the transaction before
authorization, and the caller receives HTTP 403 with the error code
`SCREENING_STOPPED`. `HoldForReview` parks the transaction on the fraud review
queue until a reviewer approves or declines it, or the merchant's hold deadline passes.
Whatever the action, the verdict is recorded on the transaction.
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
The velocity limits. Null leaves the rule unconfigured, which screens nothing.
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields of VelocitySettings:
Field
Type
Description
maxTxPerMinuterequired
integer (int32)
Maximum transactions allowed in a window of about a minute. Null or 0 leaves the per-minute
limit off. Minimum 0.nullablemin 0
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
maxTxPerHourrequired
integer (int32)
Maximum transactions allowed in a window of about an hour. Null or 0 leaves the per-hour
limit off. Minimum 0.nullablemin 0
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
maxTxPerDayrequired
integer (int32)
Maximum transactions allowed in a window of about a day. Null or 0 leaves the per-day
limit off. Minimum 0.nullablemin 0
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
maxAmountPerDayrequired
number (double)
Maximum total transaction amount, in the transaction currency, allowed in a window of about
a day. Only the base amount counts. Null or 0 leaves the daily amount limit off. Minimum 0.nullablemin 0
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
maxDeclinesPerHourrequired
integer (int32)
Maximum processor declines this merchant may receive in a window of about an hour before
the next screened transaction is flagged. Only a decline returned by the processor counts,
and it is counted when the authorization completes, so the transaction that reaches the
limit is not itself flagged. Null or 0 leaves the hourly decline limit off. Minimum 0.nullablemin 0
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
maxDeclinesPerDayrequired
integer (int32)
Maximum processor declines this merchant may receive in a window of about a day before the
next screened transaction is flagged. Counted the same way as
`maxDeclinesPerHour`. Null or 0 leaves the daily decline limit off. Minimum 0.nullablemin 0
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Limits counted separately for each card. A card is recognized by a keyed fingerprint of its
number, or of its token or check number when no card number is present; the number itself
is never stored. Null leaves every per-card limit off.
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Limits counted separately for each cardholder IP address. A transaction with no cardholder
IP address is not counted against these limits. Null leaves every per-IP limit off.
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Limits counted separately for each cardholder email address, compared without regard to
case or surrounding spaces. A transaction with no cardholder email is not counted against
these limits. Null leaves every per-email limit off.
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Limits counted separately for each cardholder device, recognized by the platform device
fingerprint stamped on the transaction when it is created. The fingerprint is coarse: it is
derived from the browser's user agent and language and the network the request came from,
so devices on one network running the same browser build share a count, and a device whose
network changes starts a new one. A transaction with no device fingerprint, such as one
created server to server with no browser involved, is not counted against these limits.
Null leaves every per-device limit off.
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
This body has no documented fields.
This model has no documented fields.
Reconnecting to the server
Could not reconnect
This session has ended
Attempt 1
Your work on this page is still here. Retrying keeps it; reloading starts the page again.
The server no longer holds this page's state, so it has to be loaded again.