# List Disbursement Rules

Retrieve a list of Disbursement Rule resources linked to an Application / Platform. Currently, there is only one Disbursement Rule object per application / platform.

For details on how to query endpoints using the available parameters, see Query Parameters.

Endpoint: GET /disbursement_rules
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.

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

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

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

  - `tags.key` (string)
    Filter by the tag's key. For more information, see Tags.
    Example: "card_type"

  - `tags.value` (string)
    Filter by the tag's value. For more information, see Tags.
    Example: "business_card"

  - `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.disbursement_rules` (array)

  - `_embedded.disbursement_rules.id` (string)
    The ID of the resource.

  - `_embedded.disbursement_rules.created_at` (string)
    Timestamp of when the object was created.

  - `_embedded.disbursement_rules.updated_at` (string)
    Timestamp of when the object was last updated.

  - `_embedded.disbursement_rules.application_details` (object)
    A container for rule configurations.

  - `_embedded.disbursement_rules.application_details.ach_rules` (array)
    List of configurations for ACH rules. Each rule can be a DAILY TIME_RANGE rule, MONTHLY TIME_RANGE rule, or GLOBAL rule.

  - `_embedded.disbursement_rules.application_details.card_rules` (array)
    List of configurations for card rules. Each rule can be a DAILY TIME_RANGE rule, MONTHLY TIME_RANGE rule, or GLOBAL rule.

  - `_embedded.disbursement_rules.application_details.balance_adjustment_rules` (array)
    List of configurations for balance adjustment rules. Each rule can be a DAILY TIME_RANGE rule, MONTHLY TIME_RANGE rule, or GLOBAL rule.

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

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

  - `_embedded.disbursement_rules.recipient_details` (object)
    A container for rule configurations.

  - `_embedded.disbursement_rules.recipient_details.ach_rules` (array)
    List of configurations for ACH rules. Each rule can be a DAILY TIME_RANGE rule, MONTHLY TIME_RANGE rule, or GLOBAL rule.

  - `_embedded.disbursement_rules.recipient_details.card_rules` (array)
    List of configurations for card rules. Each rule can be a DAILY TIME_RANGE rule, MONTHLY TIME_RANGE rule, or GLOBAL rule.

  - `_embedded.disbursement_rules.recipient_details.balance_adjustment_rules` (array)
    List of configurations for balance adjustment rules. Each rule can be a DAILY TIME_RANGE rule, MONTHLY TIME_RANGE rule, or GLOBAL rule.

  - `_embedded.disbursement_rules.sender_details` (object)
    A container for rule configurations.

  - `_embedded.disbursement_rules.sender_details.ach_rules` (array)
    List of configurations for ACH rules. Each rule can be a DAILY TIME_RANGE rule, MONTHLY TIME_RANGE rule, or GLOBAL rule.

  - `_embedded.disbursement_rules.sender_details.card_rules` (array)
    List of configurations for card rules. Each rule can be a DAILY TIME_RANGE rule, MONTHLY TIME_RANGE rule, or GLOBAL rule.

  - `_embedded.disbursement_rules.sender_details.balance_adjustment_rules` (array)
    List of configurations for balance adjustment rules. Each rule can be a DAILY TIME_RANGE rule, MONTHLY TIME_RANGE rule, or GLOBAL rule.

  - `_embedded.disbursement_rules.tags` (object,null)
    Include up to 50 key: value pairs to annotate requests with custom metadata.
- Maximum character length for individual keys is 40.
- Maximum character length for individual values is 500.
(For example, order_number: 25, item_type: produce, department: sales)

  - `_embedded.disbursement_rules._links` (object)

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

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

  - `_links` (object)

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

  - `_links.self.href` (string)

  - `_links.next` (object)
    Link to the next page of entries.

  - `_links.next.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` (string)
    A log reference identifier for the error, useful for debugging and support purposes.

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

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

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

  - `_embedded.errors._links.self.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` (string)
    A log reference identifier for the error, useful for debugging and support purposes.

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

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

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

  - `_embedded.errors._links.self.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` (string)
    A log reference identifier for the error, useful for debugging and support purposes.

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

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

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

  - `_embedded.errors._links.self.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` (string)
    A log reference identifier for the error, useful for debugging and support purposes.

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

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

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

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