curl --request GET \
--url https://production.hifibridge.com/v2/virtual-accounts/settlement-rules \
--header 'Authorization: Bearer <token>'{
"count": 123,
"rules": [
{
"id": "15c786fb-de7a-520c-a4b3-f312d4a122d2",
"chain": "BASE",
"includeHIFIFee": false,
"rules": [
{
"type": "PERCENTAGE",
"calculationModel": "FIXED",
"walletAddress": "0x15FB50680fEB2f726413416665c25f9B397b047b",
"value": 0.001,
"tiers": [
{
"min": "1000",
"max": "2000",
"value": 0.0005
}
]
}
]
}
],
"nextCursor": "<string>"
}List all settlement rules
List all settlement rules available for virtual accounts.
curl --request GET \
--url https://production.hifibridge.com/v2/virtual-accounts/settlement-rules \
--header 'Authorization: Bearer <token>'{
"count": 123,
"rules": [
{
"id": "15c786fb-de7a-520c-a4b3-f312d4a122d2",
"chain": "BASE",
"includeHIFIFee": false,
"rules": [
{
"type": "PERCENTAGE",
"calculationModel": "FIXED",
"walletAddress": "0x15FB50680fEB2f726413416665c25f9B397b047b",
"value": 0.001,
"tiers": [
{
"min": "1000",
"max": "2000",
"value": 0.0005
}
]
}
]
}
],
"nextCursor": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Number of settlement rules to return, default to 10 maximum to 100
Return the settlement rules that created before this date
Return the settlement rules that created after this date
Return the settlement rules that are created on this chain
BASE, POLYGON, ETHEREUM, SOLANA Response
Success
Total number of settlement rules
Array of settlement rules
Show child attributes
Show child attributes
Unique identifier for the settlement rule
"15c786fb-de7a-520c-a4b3-f312d4a122d2"
Blockchain network for the settlement rule
BASE, POLYGON, ETHEREUM, SOLANA "BASE"
Whether to include HiFi's fee in addition to custom rules, please contact HiFi support if you want to include HiFi's fee
false
Array of settlement rules
Show child attributes
Show child attributes
Type of fee calculation
PERCENTAGE, FIXED "PERCENTAGE"
Model for calculating the fee
FIXED, TIERED "FIXED"
Wallet address to receive the fee
"0x15FB50680fEB2f726413416665c25f9B397b047b"
Fixed fee value (omit for tiered calculation model)
0.001
Tiered fee structure (omit for fixed calculation model)
Show child attributes
Show child attributes
Minimum value for this tier (empty string is required for first tier)
"1000"
Maximum value for this tier (empty string is required for last tier)
"2000"
Fee value for this tier
0.0005
Cursor for pagination to the next page of results