Skip to main content
POST
Create a settlement rule

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,
TRON
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,
TRON
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