{
"amount_limit": 1,
"currency_code": "<string>",
"name": "<string>",
"token": "<string>",
"active": true,
"association": {
"user_token": "<string>",
"card_product_token": "<string>",
"account_template_token": "<string>"
},
"usage_limit": 49,
"approvals_only": true,
"merchant_scope": {
"mcc": "<string>",
"mid": "<string>",
"mcc_group": "<string>"
},
"include_credits": true,
"include_cashback": true,
"include_purchases": true,
"include_transfers": true,
"include_withdrawals": true,
"money_in_transaction": {
"include_credits_types": [
"<string>"
],
"include_network_load_types": [
"<string>"
]
}
}Velocity Controls Object
Describes the fields of the Velocity Controls object.
Maximum monetary sum that can be cleared within the time period defined by the velocity_window field.
Refunds and reversals cannot exceed this limit.
x > 0Three-character ISO 4217 currency code.
Defines the time period to which the amount_limit and usage_limit fields apply:
- DAY – one day; days begin at 00:00:00 UTC.
- WEEK – one week; weeks begin Sundays at 00:00:00 UTC.
- MONTH – one month; months begin on the first day of month at 00:00:00 UTC.
- LIFETIME – forever; time period never expires.
- TRANSACTION – a single transaction.
DAY, WEEK, MONTH, LIFETIME, TRANSACTION Description of how the velocity control restricts spending. For example, "Max spend of $500 per day" or "Max spend of $5000 per month for non-exempt employees".
255Unique identifier of the velocity control.
1 - 36Indicates whether the velocity control is active.
Defines the group of users to which the velocity control applies.
Show child attributes
Show child attributes
Maximum number of times a card can be used within the time period defined by the velocity_window field.
-1 <= x <= 100If set to true, only approved transactions are subject to control.
If set to false, only declined transactions are subject to control.
Defines the group of merchants to which the velocity control applies.
Populate no more than one field of the merchant_scope object.
If no fields are populated, the velocity control applies to all merchants.
Show child attributes
Show child attributes
If set to true, original credit transactions (OCT) are subject to control.
If set to true, the cashback components of point-of-sale transactions are subject to control.
If set to true, the following transactions are subject to control:
- Account funding: All account funding transactions
- Cashback: Only the purchase component of cashback transactions
- Purchase transactions: All authorizations, PIN debit transactions, and incremental transactions
- Quasi-cash: All quasi-cash transactions
- Refunds: All refund transactions (see <</developer-guides/controlling-spending#_controls_to_limit_amount_and_frequency_of_spending, Controls to limit amount and frequency of spending>> for more information)
- Reversals: All reversal transactions
If set to true, account-to-account transfers are subject to control.
Account-to-account transfers are not currently supported.
If set to true, ATM withdrawals are subject to control.
Defines the original credit transaction (OCT) types that are subject to velocity control.
Your request can contain either a money_in_transaction object or the include_credits field, not both.
Show child attributes
Show child attributes
Was this page helpful?