> ## Documentation Index
> Fetch the complete documentation index at: https://nextgen-docs.enfuce.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get velocity bucket

> Returns velocity buckets containing the current utilization of every cumulative rule for a given card.
The returned counter and amount represent used capacity, not remaining capacity: they increase when a new transaction
falls under an active rule and decrease after an authorization is purged or reversed.
Note that only buckets for the rule's configured cumulative interval are returned; this means that for example
only the bucket for the current month is presented if a rule's type is CUMULATIVE_AMOUNT and the default parameters
specify that it's MONTHLY. Buckets for previous intervals will not be returned.




## OpenAPI

````yaml json-files/velocity-buckets-v1.openapi.json get /v1/velocity-buckets
openapi: 3.0.3
info:
  title: Velocity buckets API
  version: 1.0.0
servers:
  - url: https://api.{{tenant}}.ext-uat1-sandbox.mycore.enfuce.com/processor
    description: UAT Sandbox
  - url: https://api.{{tenant}}.eu.live.prod.mycore.enfuce.com/processor
    description: Production
security: []
tags:
  - name: Velocity buckets
paths:
  /v1/velocity-buckets:
    get:
      tags:
        - Velocity buckets
      description: >
        Returns velocity buckets containing the current utilization of every
        cumulative rule for a given card.

        The returned counter and amount represent used capacity, not remaining
        capacity: they increase when a new transaction

        falls under an active rule and decrease after an authorization is purged
        or reversed.

        Note that only buckets for the rule's configured cumulative interval are
        returned; this means that for example

        only the bucket for the current month is presented if a rule's type is
        CUMULATIVE_AMOUNT and the default parameters

        specify that it's MONTHLY. Buckets for previous intervals will not be
        returned.
      operationId: getVelocityBuckets
      parameters:
        - $ref: '#/components/parameters/CardId'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/VelocityBucket'
              example:
                - ruleId: 1234
                  cardId: a3f2c1d4-0b5e-4f6a-9c8d-7e1b2a3f4c5d
                  counter: 3
                  amount: 300
                - ruleId: 1344
                  cardId: a3f2c1d4-0b5e-4f6a-9c8d-7e1b2a3f4c5d
                  counter: 7
                  amount: 520
components:
  parameters:
    CardId:
      name: card-id
      in: query
      required: true
      schema:
        $ref: '#/components/schemas/uuid'
      description: Id of the card.
      example: a8d8374f-0fd2-444d-a331-c345bf4948da
  schemas:
    VelocityBucket:
      type: object
      required:
        - ruleId
        - counter
        - amount
      properties:
        ruleId:
          type: integer
          format: int64
          description: Id of the rule.
          example: 1234
        cardId:
          $ref: '#/components/schemas/uuid'
        counter:
          type: integer
          description: Total number of transactions in the velocity bucket.
          example: 10
        amount:
          type: number
          description: Total amount in the velocity bucket.
          example: 100
    uuid:
      type: string
      format: uuid

````