Get a card velocity limit
Retrieve a rule managed by your platform. Rules owned by other platforms or Lightspark return 404.
Authorizations
API token authentication using format <api token id>:<api client secret>
Path Parameters
System-generated card velocity rule identifier.
Response
The requested rule.
A platform-managed card velocity rule.
A descriptive label for this rule. Whitespace-only names are rejected.
1 - 255"Weekly card spending cap"
ATTEMPTS counts every real-time authorization request, including declined requests. APPROVED counts distinct approved authorizations, including zero-amount authorizations, and can also cap the amount they hold.
ATTEMPTS, APPROVED AUTHORIZATION caps one authorization amount. ROLLING covers the trailing windowSeconds. Calendar windows use UTC: DAY starts at midnight, WEEK on Monday, MONTH on the first, QUARTER in January/April/July/October, and YEAR on January 1.
AUTHORIZATION, ROLLING, DAY, WEEK, MONTH, QUARTER, YEAR System-generated identifier for the rule.
"CardVelocityRule:019542f5-b3e7-1d02-0000-000000000004"
Card to restrict. Omit or send null to apply the rule separately to every eligible card on your platform, including cards issued later. A platform rule does not pool usage across cards.
"Card:019542f5-b3e7-1d02-0000-000000000003"
Required for ROLLING and absent or null for other windows. The maximum rolling window is 31 days.
1 <= x <= 2678400600
Maximum count within the window. Required for ATTEMPTS. Cannot be set for AUTHORIZATION. Omit or send null to leave the count uncapped.
0 <= x <= 1000005
Maximum amount in the smallest unit of the card's currency. Supported for APPROVED only. Platform rules apply this amount separately to each eligible card in that card's currency, without foreign-exchange conversion. USD- and USDB-funded USD cards both use USD cents. The amount is holds less releases for transactions opened within the window. Releases restore capacity; clearing against a hold does not. Omit or send null to leave the amount uncapped. At least one of maxCount or maxAmount must be set. A zero cap blocks applicable new authorizations, including zero-amount checks.
0 <= x <= 900719925474099150000