v1

latestOpenAPI 3.0.22026-08-061303782.1 MB

Disbursement Rules

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.

get/disbursement_rules

Query parameters

linked_tostring required

The ID of the Application or Platform that the Disbursement Rule belongs to.

after_cursorstring

Return every resource created after the cursor value.

before_cursorstring

Return every resource created before the cursor value.

created_at.gtestring date-time

Example:2022-09-27T11:21:23

Filter where created_at is after the given date.

created_at.ltestring date-time

Example:2026-09-27T11:21:23

Filter where created_at is before the given date.

limitinteger

Example:10

The numbers of items to return.

tags.keystring

Example:card_type

Filter by the tag's key. For more information, see Tags.

tags.valuestring

Example:business_card

Filter by the tag's value. For more information, see Tags.

updated_at.gtestring date-time

Example:2022-09-27T11:21:23

Filter where updated_at is after the given date.

updated_at.ltestring date-time

Example:2026-09-27T11:21:23

Filter where updated_at is before the given date.

Headers

Finix-Versionstring

Example:2022-02-01

Specify the API version of your request. For more details, see Versioning.

Response

List of Disbursement Rule resources

Example response

{
  "_embedded": {
    "disbursement_rules": [
      {
        "application_details": {
          "ach_rules": [
            {
              "type": "TIME_RANGE",
              "time_frame": "DAILY",
              "start_time": 11
            }
          ],
          "card_rules": [
            {
              "type": "TIME_RANGE",
              "time_frame": "DAILY",
              "start_time": 11
            }
          ],
          "balance_adjustment_rules": [
            {
              "type": "TIME_RANGE",
              "time_frame": "DAILY",
              "start_time": 11
            }
          ]
        },
        "recipient_details": {
          "ach_rules": [
            {
              "type": "TIME_RANGE",
              "time_frame": "DAILY",
              "start_time": 11
            }
          ],
          "card_rules": [
            {
              "type": "TIME_RANGE",
              "time_frame": "DAILY",
              "start_time": 11
            }
          ],
          "balance_adjustment_rules": [
            {
              "type": "TIME_RANGE",
              "time_frame": "DAILY",
              "start_time": 11
            }
          ]
        },
        "sender_details": {
          "ach_rules": [
            {
              "type": "TIME_RANGE",
              "time_frame": "DAILY",
              "start_time": 11
            }
          ],
          "card_rules": [
            {
              "type": "TIME_RANGE",
              "time_frame": "DAILY",
              "start_time": 11
            }
          ],
          "balance_adjustment_rules": [
            {
              "type": "TIME_RANGE",
              "time_frame": "DAILY",
              "start_time": 11
            }
          ]
        }
      }
    ]
  }
}