Skip to main content
GET
Retrieve a settlement rule

Authorizations

Authorization
string
header
required

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

Path Parameters

settlementRuleId
string
required

Public ID of the settlement rule (prefixed with sr_)

Response

Settlement rule retrieved.

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>