HIhifi
Settlement Rules

List all settlement rules

Changed on

List all settlement rules available for virtual accounts.

get/v2/virtual-accounts/settlement-rules

Request

  • Base URL
    https://production.hifibridge.com
  • URL
    https://production.hifibridge.com/v2/virtual-accounts/settlement-rules
  • Auth
    HTTP bearer

Query parameters

limitstring

Number of settlement rules to return, default to 10 maximum to 100

createdBeforestring

Return the settlement rules that created before this date

createdAfterstring

Return the settlement rules that created after this date

chain'BASE' | 'POLYGON' | 'ETHEREUM' | 'SOLANA' | 'TRON'

Return the settlement rules that are created on this chain

Response

Success

countinteger required

Total number of settlement rules

nextCursorstring nullable

Cursor for pagination to the next page of results

Example response

{
  "rules": [
    {
      "id": "15c786fb-de7a-520c-a4b3-f312d4a122d2",
      "chain": "BASE",
      "rules": [
        {
          "type": "PERCENTAGE",
          "calculationModel": "FIXED",
          "value": 0.001,
          "tiers": [
            {
              "min": "1000",
              "max": "2000",
              "value": 0.0005
            }
          ],
          "walletAddress": "0x15FB50680fEB2f726413416665c25f9B397b047b",
          "trigger": {
            "paymentRail": [
              "ACH"
            ]
          }
        }
      ]
    }
  ]
}

Changes

  • 319fa6bd5bc6Revision changes
    • warning

      added the new ARC enum value to the // response property for the response status

    • info

      added the optional property //// to the response with the status