Skip to main content
POST
Initiate a fee claim

Authorizations

Authorization
string
header
required

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

Path Parameters

environmentId
string
required

ID of the environment

Required string length: 36
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Body

application/json

Request to initiate a fee claim. Provider-agnostic: the caller only supplies the recipient address and the backend looks up unclaimed fee balances across every provider, returning a signing step for each. chainId and tokenAddress are optional filters to narrow the claim to a specific balance.

recipientAddress
string
required

Valid blockchain wallet address, must be an alphanumeric string (underscores allowed for chains like Midnight, hyphens allowed for chains using base64url-encoded addresses like TON)

Maximum string length: 255
Pattern: ^[A-Za-z0-9_-]{18,100}$
Example:

"0xbF394748301603f18d953C90F0b087CBEC0E1834"

chainId
string

Optional filter — only claim balances settled on this chain

tokenAddress
string

Optional filter — only claim balances for this token contract address

Response

Claim initiation instructions

Instructions to complete a fee claim. Contains an opaque requestId that correlates the initiated claim on submit, and the steps the recipient must complete (one per claimable balance across all providers).

requestId
string
required

Opaque identifier correlating this initiated claim; echoed back on submit so the backend can resolve the provider(s) internally

steps
object[]
required
Last modified on July 29, 2026