Lithic · Schema

Velocity Limit Parameters

FinTechBaaSCard IssuingPaymentsEmbedded Finance

Properties

Name Type Description
scope object
period object
filters object
limit_amount object
limit_count object
View JSON Schema on GitHub

JSON Schema

lithic-velocity-limit-parameters-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/velocity-limit-parameters",
  "title": "Velocity Limit Parameters",
  "type": "object",
  "properties": {
    "scope": {
      "$ref": "#/components/schemas/velocity-scope"
    },
    "period": {
      "$ref": "#/components/schemas/velocity-limit-period"
    },
    "filters": {
      "$ref": "#/components/schemas/velocity-limit-filters"
    },
    "limit_amount": {
      "anyOf": [
        {
          "title": "Null (no amount limit)",
          "type": "null",
          "description": "No velocity limit on amount is applied to the transaction."
        },
        {
          "title": "Limit",
          "type": "integer",
          "format": "int64",
          "minimum": 0,
          "description": "The maximum amount of spend velocity allowed in the period in minor units (the smallest unit of a currency, e.g. cents for USD). Transactions exceeding this limit will be declined.",
          "example": 10000
        }
      ]
    },
    "limit_count": {
      "anyOf": [
        {
          "title": "Null (no limit)",
          "type": "null",
          "description": "No limit on the number of velocity impacting events is applied."
        },
        {
          "title": "Limit",
          "type": "integer",
          "format": "int64",
          "minimum": 0,
          "description": "The number of spend velocity impacting transactions may not exceed this limit in the period. Transactions exceeding this limit will be declined.\nA spend velocity impacting transaction is a transaction that has been authorized, and optionally settled, or a force post (a transaction that settled without prior authorization)."
        }
      ]
    }
  },
  "required": [
    "scope",
    "period"
  ]
}