# List Disbursement Rules

Retrieve a list of  resources linked to an  / . Currently, there is only one  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

## Header parameters:

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

## Query parameters:

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

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

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

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

## Response 200 fields (application/json):

  - `_embedded` (object)
    List of  objects.

  - `_embedded.disbursement_rules` (array)
    objects.

  - `_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, required)
    List of configurations for ACH rules.

  - `_embedded.disbursement_rules.application_details.card_rules` (array, required)
    List of configurations for card rules.

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

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

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

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

  - `_embedded.disbursement_rules.tags` (object,null)
    Include up to 50  pairs to annotate requests with custom metadata.
- Maximum character length for individual  is 40.
- Maximum character length for individual  is 500.
(For example, , , )

  - `_links` (object)
    For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these  to make your follow-up requests and quickly access relevant IDs.

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

  - `_links.next.href` (string)

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

  - `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.

## Response 401 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "UNKNOWN"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.self` (object)

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

  - `_embedded.errors._links.source` (object)

## Response 403 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "FORBIDDEN"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.source` (object)

  - `_embedded.errors._links.source.href` (string)

## Response 404 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "NOT_FOUND"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.source` (object)

  - `_embedded.errors._links.source.href` (string)

## Response 422 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "INVALID_FIELD"

  - `_embedded.errors.field` (string)

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.source` (object)

  - `_embedded.errors._links.source.href` (string)