# List Current Usages

Retrieve the current usage for disbursements.

Endpoint: GET /disbursement_rules/current_usages
Version: 2022-02-01
Security: BasicAuth

## Query parameters:

  - `linked_to` (string, required)
    The ID of the Application or Platform that the Disbursement Rule belongs to.
    Example: "APc9vhYcPsRuTSpKD9KpMtPe"

  - `after_cursor` (string)
    Return every resource created after the cursor value.

  - `before_cursor` (string)
    Return every resource created before the cursor value.

  - `limit` (integer)
    The numbers of items to return.
    Example: 10

  - `updated_at.gte` (string)
    Filter where updated_at is after the given date.
    Example: "2022-09-27T11:21:23"

  - `updated_at.lte` (string)
    Filter where updated_at is before the given date.
    Example: "2026-09-27T11:21:23"

## Header parameters:

  - `Finix-Version` (string)
    Specify the API version of your request. For more details, see Versioning.
    Example: "2022-02-01"

## Response 200 fields (application/json):

  - `page` (object)
    Details the page that's returned.

  - `page.limit` (integer)
    The number of entries to return.

  - `page.next_cursor` (string,null)
    The cursor to use for the next page of results.

  - `_embedded` (object)

  - `_embedded.current_usages` (array)

  - `_embedded.current_usages.ach_velocity` (object)
    An object that contains the current usage and limits for ACH disbursements.

  - `_embedded.current_usages.ach_velocity.daily_velocity` (object)
    An object that contains the current usage and limits for disbursements.

  - `_embedded.current_usages.ach_velocity.daily_velocity.current_volume` (integer)
    The current volume of disbursements.

  - `_embedded.current_usages.ach_velocity.daily_velocity.current_count` (integer)
    The current count of disbursements.

  - `_embedded.current_usages.ach_velocity.daily_velocity.volume_limit` (integer)
    The volume limit for disbursements.

  - `_embedded.current_usages.ach_velocity.daily_velocity.count_limit` (integer)
    The count limit for disbursements.

  - `_embedded.current_usages.ach_velocity.daily_velocity.window_reset` (string)
    The date and time when the usage window resets.

  - `_embedded.current_usages.ach_velocity.monthly_velocity` (object)
    An object that contains the current usage and limits for disbursements.

  - `_embedded.current_usages.card_velocity` (object)
    An object that contains the current usage and limits for Card disbursements.

  - `_embedded.current_usages.balance_adjustment_velocity` (object)
    An object that contains the current usage and limits for balance adjustments.

  - `_embedded.current_usages.currency` (string)
    ISO 4217 3-letter currency code.
    Enum: "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL"

  - `_embedded.current_usages.linked_to` (string)
    The identifier for the Application or Platform resource associated with the Disbursement Rule.

  - `_embedded.current_usages.linked_type` (string)
    The type of the resource that is specified in the linked_to field.
    Enum: "APPLICATION", "PLATFORM"

  - `_embedded.current_usages.type` (string)
    The type will always be TOTAL.
    Enum: "TOTAL"

  - `_embedded.current_usages._links` (object)

  - `_embedded.current_usages._links.self` (object)
    Link to the resource that was used in the request.

  - `_embedded.current_usages._links.self.href` (string)

## Response 401 fields (application/json):

  - `total` (integer, required)
    Total number of errors returned.

  - `_embedded` (object, required)
    Container for embedded error objects.

  - `_embedded.errors` (array)
    List of individual error objects.

  - `_embedded.errors.code` (string)
    The error code. The UNKNOWN error code is returned for a 401 Unauthorized or 403 Forbidden request.

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)
    A human-friendly error message.

  - `_embedded.errors._links` (object)
    Links related to this error.

  - `_embedded.errors._links.source` (object)
    Link to the resource related to the error.

  - `_embedded.errors._links.source.href` (string)
    URL of the related resource.

## Response 403 fields (application/json):

  - `total` (integer, required)
    Total number of errors returned.

  - `_embedded` (object, required)
    Container for embedded error objects.

  - `_embedded.errors` (array)
    List of individual error objects.

  - `_embedded.errors.code` (string)
    The error code. The UNKNOWN error code is returned for a 401 Unauthorized or 403 Forbidden request.

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)
    A human-friendly error message.

  - `_embedded.errors._links` (object)
    Links related to this error.

  - `_embedded.errors._links.source` (object)
    Link to the resource related to the error.

  - `_embedded.errors._links.source.href` (string)
    URL of the related resource.

## Response 406 fields (application/json):

  - `total` (integer, required)
    Total number of errors returned.

  - `_embedded` (object, required)
    Container for embedded error objects.

  - `_embedded.errors` (array)
    List of individual error objects.

  - `_embedded.errors.code` (string)
    The error code. The UNKNOWN error code is returned for a 401 Unauthorized or 403 Forbidden request.

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)
    A human-friendly error message.

  - `_embedded.errors._links` (object)
    Links related to this error.

  - `_embedded.errors._links.source` (object)
    Link to the resource related to the error.

  - `_embedded.errors._links.source.href` (string)
    URL of the related resource.

## Response 422 fields (application/json):

  - `total` (integer, required)
    Total number of errors returned.

  - `_embedded` (object, required)
    Container for embedded error objects.

  - `_embedded.errors` (array)
    List of individual error objects.

  - `_embedded.errors.code` (string)
    The error code. The UNKNOWN error code is returned for a 401 Unauthorized or 403 Forbidden request.

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)
    A human-friendly error message.

  - `_embedded.errors._links` (object)
    Links related to this error.

  - `_embedded.errors._links.source` (object)
    Link to the resource related to the error.

  - `_embedded.errors._links.source.href` (string)
    URL of the related resource.