Sign in

v1

latestOpenAPI 3.0.02026-07-26103425558.9 KB
Settlement Rules

Update a settlement rule

Update an existing settlement rule. This will replace all existing rules with the new configuration.

post/v2/virtual-accounts/settlement-rules/{ruleId}/update

Path parameters

ruleIdstring required

ID of the settlement rule

Request body

requestIdstring required

Unique identifier for the request (recommend using uuid v4)

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

Blockchain network for the settlement rule

includeHIFIFeeboolean required

Whether to include HiFi's fee in addition to custom rules

Example request

{
  "requestId": "{{$guid}}",
  "chain": "BASE",
  "rules": [
    {
      "type": "PERCENTAGE",
      "calculationModel": "FIXED",
      "value": 0.001,
      "tiers": [
        {
          "min": "1000",
          "max": "2000",
          "value": 0.0005
        }
      ],
      "walletAddress": "0x15FB50680fEB2f726413416665c25f9B397b047b"
    }
  ]
}

Response

Success

idstring required

Unique identifier for the settlement rule

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

Blockchain network for the settlement rule

includeHIFIFeeboolean required

Whether to include HiFi's fee in addition to custom rules, please contact HiFi support if you want to include HiFi's fee

Example response

{
  "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"
    }
  ]
}