For the complete documentation index, see llms.txt. This page is also available as Markdown.

Referral

Caller's referral overview — `referralCode`, total-users-referred count, lifetime borrow + swap rewards earned, and claimable swap rewards. No mid-week accrual is exposed (stat-hiding invariant). FE composes the share link itself (its own URL + `?ref=<referralCode>`).

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200Success

No content

get/api/referral/me
200Success

No content

Build an unsigned PSBT to claim bUSD rewards

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
payFeeAddressstringRequired

Referrer's 2-of-2 trading wallet address. Funds the claim tx (fee + dust) AND receives the claimed bUSD. Must be the calling referrer's own tradingAddress — the BE validates this against walletService before building.

Example: tb1pegd26fnpkgd95s432c8mmnnxa890xadnhq5ctgk48ruh979c9k4sf6mr3y
Responses
201Success

No content

post/api/referral/claim/build
201Success

No content

Submit a signed referral bUSD-claim PSBT for broadcast

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
signedBase64TxstringRequired

Base64-encoded PSBT signed by the referrer

Responses
201Success

No content

post/api/referral/claim/sign
201Success

No content

Get an account's referrer (public)

get
Path parameters
accountIdstringRequired
Responses
200Success

No content

get/api/referral/users/{accountId}/referrer
200Success

No content

Last updated