VelocitySettings
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Velocity limits. Each limit is counted in its own window, which starts with the first counted transaction and expires a fixed time later rather than aligning to the clock. Every screened transaction counts toward the transaction and amount limits, including one a processor later declines. The limits on this object are counted across all of the merchant's transactions; `perCard`, `perIpAddress`, `perEmail` and `perDevice` add limits counted separately for each card, cardholder IP address, cardholder email and cardholder device.
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 | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
maxTxPerMinute
required |
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.
| |||||||||||||||
maxTxPerHour
required |
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.
| |||||||||||||||
maxTxPerDay
required |
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.
| |||||||||||||||
maxAmountPerDay
required |
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.
| |||||||||||||||
maxDeclinesPerHour
required |
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.
| |||||||||||||||
maxDeclinesPerDay
required |
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.
| |||||||||||||||
perCard
required |
VelocityCardLimits VelocityCardLimits | 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.
| |||||||||||||||
Fields of VelocityCardLimits: This body has no documented fields. | |||||||||||||||||
perIpAddress
required |
VelocityDimensionLimits VelocityDimensionLimits | 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.
| |||||||||||||||
Fields of VelocityDimensionLimits:
This body has no documented fields. | |||||||||||||||||
perEmail
required |
VelocityDimensionLimits VelocityDimensionLimits | 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.
| |||||||||||||||
Fields of VelocityDimensionLimits:
This body has no documented fields. | |||||||||||||||||
perDevice
required |
VelocityDimensionLimits VelocityDimensionLimits | 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.
| |||||||||||||||
Fields of VelocityDimensionLimits:
This body has no documented fields. | |||||||||||||||||
This model has no documented fields.