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<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
rules
object[]
required
Required array length: 1 - 10 elements
chain
enum<string>
required
Available options:
BASE,
POLYGON,
ETHEREUM,
SOLANA,
TRON
includeHIFIFee
boolean
required

Response

Settlement rule created.

id
string

Public ID of the settlement rule (prefixed with sr_).

rules
object[]
Required array length: 1 - 10 elements
chain
enum<string>
Available options:
BASE,
POLYGON,
ETHEREUM,
SOLANA,
TRON
includeHIFIFee
boolean
createdAt
string<date-time>
updatedAt
string<date-time>