--- title: "List Disbursement Rules" method: GET path: "/disbursement_rules" tags: ["Disbursement Rules"] --- # List Disbursement Rules `GET /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](/api/overview/#section/Query-Parameters). ## Query parameters - `linked_to` string, required - `after_cursor` string - `before_cursor` string - `created_at.gte` string, date-time - `created_at.lte` string, date-time - `limit` integer - `tags.key` string - `tags.value` string - `updated_at.gte` string, date-time - `updated_at.lte` string, date-time ## Headers - `Finix-Version` string ## Response `200` List of `Disbursement Rule` resources - object - `page` Page — Details the page that's returned. - `limit` integer — The number of entries to return. - `next_cursor` string, nullable — The cursor to use for the next page of results. - `_embedded` object - `disbursement_rules` DisbursementRule[] - `id` string — The ID of the resource. - `created_at` string, date-time — Timestamp of when the object was created. - `updated_at` string, date-time — Timestamp of when the object was last updated. - `application_details` RecipientSenderRuleDetails — A container for rule configurations. - `ach_rules` union[] — List of configurations for ACH rules. Each rule can be a DAILY TIME_RANGE rule, MONTHLY TIME_RANGE rule, or GLOBAL rule. - union - DailyRuleConfiguration — Configuration settings for a DAILY rule. - … - MonthlyRuleConfiguration — Configuration settings for a MONTHLY rule. - … - MaximumTransactionAmount — An object that contains settings for volume limits on individual transactions. This is a GLOBAL rule type that applies universally without time-based resets. - … - `card_rules` union[] — List of configurations for card rules. Each rule can be a DAILY TIME_RANGE rule, MONTHLY TIME_RANGE rule, or GLOBAL rule. - union - DailyRuleConfiguration — Configuration settings for a DAILY rule. - … - MonthlyRuleConfiguration — Configuration settings for a MONTHLY rule. - … - MaximumTransactionAmount — An object that contains settings for volume limits on individual transactions. This is a GLOBAL rule type that applies universally without time-based resets. - … - `balance_adjustment_rules` union[] — List of configurations for balance adjustment rules. Each rule can be a DAILY TIME_RANGE rule, MONTHLY TIME_RANGE rule, or GLOBAL rule. - union - DailyRuleConfiguration — Configuration settings for a DAILY rule. - … - MonthlyRuleConfiguration — Configuration settings for a MONTHLY rule. - … - MaximumTransactionAmount — An object that contains settings for volume limits on individual transactions. This is a GLOBAL rule type that applies universally without time-based resets. - … - `linked_to` string — The identifier for the `Application` or `Platform` resource associated with the `Disbursement Rule`. - `linked_type` 'APPLICATION' | 'PLATFORM' — The type of the resource that is specified in the `linked_to` field. - `recipient_details` RecipientSenderRuleDetails — A container for rule configurations. - `ach_rules` union[] — List of configurations for ACH rules. Each rule can be a DAILY TIME_RANGE rule, MONTHLY TIME_RANGE rule, or GLOBAL rule. - union - DailyRuleConfiguration — Configuration settings for a DAILY rule. - … - MonthlyRuleConfiguration — Configuration settings for a MONTHLY rule. - … - MaximumTransactionAmount — An object that contains settings for volume limits on individual transactions. This is a GLOBAL rule type that applies universally without time-based resets. - … - `card_rules` union[] — List of configurations for card rules. Each rule can be a DAILY TIME_RANGE rule, MONTHLY TIME_RANGE rule, or GLOBAL rule. - union - DailyRuleConfiguration — Configuration settings for a DAILY rule. - … - MonthlyRuleConfiguration — Configuration settings for a MONTHLY rule. - … - MaximumTransactionAmount — An object that contains settings for volume limits on individual transactions. This is a GLOBAL rule type that applies universally without time-based resets. - … - `balance_adjustment_rules` union[] — List of configurations for balance adjustment rules. Each rule can be a DAILY TIME_RANGE rule, MONTHLY TIME_RANGE rule, or GLOBAL rule. - union - DailyRuleConfiguration — Configuration settings for a DAILY rule. - … - MonthlyRuleConfiguration — Configuration settings for a MONTHLY rule. - … - MaximumTransactionAmount — An object that contains settings for volume limits on individual transactions. This is a GLOBAL rule type that applies universally without time-based resets. - … - `sender_details` RecipientSenderRuleDetails — A container for rule configurations. - `ach_rules` union[] — List of configurations for ACH rules. Each rule can be a DAILY TIME_RANGE rule, MONTHLY TIME_RANGE rule, or GLOBAL rule. - union - DailyRuleConfiguration — Configuration settings for a DAILY rule. - … - MonthlyRuleConfiguration — Configuration settings for a MONTHLY rule. - … - MaximumTransactionAmount — An object that contains settings for volume limits on individual transactions. This is a GLOBAL rule type that applies universally without time-based resets. - … - `card_rules` union[] — List of configurations for card rules. Each rule can be a DAILY TIME_RANGE rule, MONTHLY TIME_RANGE rule, or GLOBAL rule. - union - DailyRuleConfiguration — Configuration settings for a DAILY rule. - … - MonthlyRuleConfiguration — Configuration settings for a MONTHLY rule. - … - MaximumTransactionAmount — An object that contains settings for volume limits on individual transactions. This is a GLOBAL rule type that applies universally without time-based resets. - … - `balance_adjustment_rules` union[] — List of configurations for balance adjustment rules. Each rule can be a DAILY TIME_RANGE rule, MONTHLY TIME_RANGE rule, or GLOBAL rule. - union - DailyRuleConfiguration — Configuration settings for a DAILY rule. - … - MonthlyRuleConfiguration — Configuration settings for a MONTHLY rule. - … - MaximumTransactionAmount — An object that contains settings for volume limits on individual transactions. This is a GLOBAL rule type that applies universally without time-based resets. - … - `tags` Tags, nullable — 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`) - `_links` object - `self` Self — Link to the resource that was used in the request. - `href` string - `_links` object - `self` Self — Link to the resource that was used in the request. - `href` string - `next` Next — Link to the next page of entries. - `href` string ## Other responses - `401` — Unauthorized. Authentication is required and has failed or has not been provided. - `403` — Forbidden. The client is authenticated but does not have permission to access the resource. - `406` — Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted. - `422` — Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed. --- [API](https://skmtc.net/finix/apis/finix-api-reference.md) · [All operations](https://skmtc.net/finix/apis/finix-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/finix/finix-api-reference/versions/5426f6f99c52/schema)