Skip to main content
POST
/
v2
/
virtual-accounts
/
settlement-rules
Create a settlement rule
curl --request POST \
  --url https://production.hifibridge.com/v2/virtual-accounts/settlement-rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "requestId": "{{$guid}}",
  "chain": "BASE",
  "includeHIFIFee": false,
  "rules": [
    {
      "type": "PERCENTAGE",
      "calculationModel": "FIXED",
      "walletAddress": "0x15FB50680fEB2f726413416665c25f9B397b047b",
      "value": 0.001,
      "tiers": [
        {
          "min": "1000",
          "max": "2000",
          "value": 0.0005
        }
      ]
    }
  ]
}
'
{
  "id": "15c786fb-de7a-520c-a4b3-f312d4a122d2",
  "chain": "BASE",
  "includeHIFIFee": false,
  "rules": [
    {
      "type": "PERCENTAGE",
      "calculationModel": "FIXED",
      "value": 0.001,
      "tiers": null,
      "walletAddress": "0x15FB50680fEB2f726413416665c25f9B397b047b"
    },
    {
      "type": "FIXED",
      "calculationModel": "FIXED",
      "value": 0.5,
      "tiers": null,
      "walletAddress": "0x15FB50680fEB2f726413416665c25f9B397b047b"
    },
    {
      "type": "PERCENTAGE",
      "calculationModel": "TIERED",
      "value": null,
      "tiers": [
        {
          "max": "1000",
          "min": "",
          "value": 0.0007
        },
        {
          "max": "2000",
          "min": "1000",
          "value": 0.0005
        },
        {
          "max": "",
          "min": "2000",
          "value": 0.0002
        }
      ],
      "walletAddress": "0x15FB50680fEB2f726413416665c25f9B397b047b"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
requestId
string
required

Unique identifier for the request (recommend using uuid v4)

Example:

"{{$guid}}"

​
chain
enum<string>
required

Blockchain network for the settlement rule, this should be the same as the blockchain network of the virtual account

Available options:
BASE,
POLYGON,
ETHEREUM,
SOLANA
Example:

"BASE"

​
includeHIFIFee
boolean
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:

false

​
rules
Settlement Rule · object[]
required

Array of settlement rules

Minimum array length: 1

Response

Success

​
id
string
required

Unique identifier for the settlement rule

Example:

"15c786fb-de7a-520c-a4b3-f312d4a122d2"

​
chain
enum<string>
required

Blockchain network for the settlement rule

Available options:
BASE,
POLYGON,
ETHEREUM,
SOLANA
Example:

"BASE"

​
includeHIFIFee
boolean
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:

false

​
rules
Settlement Rule · object[]
required

Array of settlement rules