Skip to main content

List Disbursement Rules

Suggest Edits

Overview​

Retrieve a list of Disbursement Rule resources linked to an Application or Platform. The Disbursement Rule resource defines velocity and balance limits for ACH and card transactions for payouts. Rules are checked when a payout is executed, and transactions are rejected if any limit is exceeded. Currently, there is only one Disbursement Rule object per application/platform.

Resource Access​

Production (api.ahrvo.network)

GET https://api.ahrvo.network/payments/na/disbursement_rules

Staging (gateway.ahrvo.network)

GET http://gateway.ahrvo.network/payments/na/disbursement_rules

Arguments​

AttributeMandatory / OptionalDescription
Finix-VersionMandatorySpecify the API version of your request (e.g., 2022-02-01)
linked_toMandatoryThe ID of the Application or Platform that the Disbursement Rule belongs to
limitOptionalThe number of items to return (default: 5)
after_cursorOptionalReturn every resource created after the cursor value

Example Request​

curl -X GET "https://gateway.ahrvo.network/payments/na/disbursement_rules?linked_to=APxxxxxxxxxxxxxxxxxx&limit=5" \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic <base64_encoded_credentials>" \
  -H "Finix-Version: 2022-02-01"

Example Response​

{
  "_embedded": {
    "disbursement_rules": [
      {
        "id": "DRxxxxxxxxxxxxxxxxxx",
        "created_at": "2025-12-10T10:30:00Z",
        "updated_at": "2025-12-10T10:30:00Z",
        "linked_to": "APxxxxxxxxxxxxxxxxxx",
        "linked_type": "APPLICATION",
        "application_details": {
          "ach_rules": [
            {
              "type": "TIME_RANGE",
              "currency": "USD",
              "time_frame": "DAILY",
              "start_time": 0,
              "time_zone": "America/New_York",
              "rules": [
                {
                  "volume_limit": 1000001,
                  "count_limit": 100,
                  "enabled": true,
                  "day": "ALL"
                }
              ]
            },
            {
              "type": "TIME_RANGE",
              "currency": "USD",
              "time_frame": "MONTHLY",
              "start_time": 0,
              "time_zone": "America/New_York",
              "start_date": 1,
              "rules": [
                {
                  "volume_limit": 10000001,
                  "count_limit": 1000,
                  "enabled": true,
                  "day": "ALL"
                }
              ]
            },
            {
              "type": "GLOBAL",
              "currency": "USD",
              "max_transaction_amount": 500001
            }
          ],
          "card_rules": [
            {
              "type": "TIME_RANGE",
              "currency": "USD",
              "time_frame": "DAILY",
              "start_time": 0,
              "time_zone": "America/New_York",
              "rules": [
                {
                  "volume_limit": 500001,
                  "count_limit": 50,
                  "enabled": true,
                  "day": "ALL"
                }
              ]
            },
            {
              "type": "GLOBAL",
              "currency": "USD",
              "max_transaction_amount": 250001
            }
          ],
          "balance_adjustment_rules": [
            {
              "type": "GLOBAL",
              "currency": "USD",
              "max_transaction_amount": 1000001
            }
          ]
        },
        "recipient_details": {
          "ach_rules": [
            {
              "type": "TIME_RANGE",
              "currency": "USD",
              "time_frame": "DAILY",
              "start_time": 0,
              "time_zone": "America/New_York",
              "rules": [
                {
                  "volume_limit": 750001,
                  "count_limit": 75,
                  "enabled": true,
                  "day": "ALL"
                }
              ]
            }
          ],
          "card_rules": []
        },
        "sender_details": {
          "ach_rules": [],
          "card_rules": [
            {
              "type": "TIME_RANGE",
              "currency": "USD",
              "time_frame": "DAILY",
              "start_time": 0,
              "time_zone": "America/New_York",
              "rules": [
                {
                  "volume_limit": 300001,
                  "count_limit": 30,
                  "enabled": true,
                  "day": "ALL"
                }
              ]
            }
          ]
        },
        "tags": {},
        "_links": {
          "self": {
            "href": "https://api.ahrvo.network/payments/na/disbursement_rules/DRxxxxxxxxxxxxxxxxxx"
          }
        }
      }
    ]
  },
  "page": {
    "limit": 5,
    "next_cursor": null
  },
  "_links": {
    "self": {
      "href": "https://api.ahrvo.network/payments/na/disbursement_rules?linked_to=APxxxxxxxxxxxxxxxxxx&limit=5"
    }
  }
}

Understanding Disbursement Rules​

Disbursement rules are organized into three main categories:

Application Details​

Rules applied to every transaction set by the platform:

  • ACH Rules: Limits for ACH transactions (daily/monthly volume and count limits)
  • Card Rules: Limits for card transactions
  • Balance Adjustment Rules: Limits for balance adjustments (platform-level only)

Recipient Details​

Rules applied when a party is a recipient (e.g., PUSH_TO_CARD scenarios):

  • Controls limits for receiving funds

Sender Details​

Rules applied when a party is a sender (e.g., PULL_FROM_CARD scenarios):

  • Controls limits for sending funds

Each rule can include:

  • TIME_RANGE: Velocity limits over a period (daily/monthly)

    • volume_limit: Maximum total amount in cents
    • count_limit: Maximum number of transactions
    • time_frame: DAILY or MONTHLY
    • start_time: Hour when the time frame starts (0-23)
    • time_zone: Timezone for calculations

  • GLOBAL: Single transaction limits

    • max_transaction_amount: Maximum amount per transaction in cents

API Documentation​