Skip to main content

​
Affiliates

Affiliate profiles let you register a partner-scoped app-fee recipient with a payout destination on any supported chain under a stable affiliateId, then reference that id in quote requests.

​
PUT /v1/affiliates/:affiliateId

Create or update an affiliate profile. Headers: 
Authorization: Bearer fn_...
X-Idempotency-Key: <unique key>
Request (Solana USDC payout): 
{
  "feeBps": 50,
  "payoutChain": "solana",
  "payoutAsset": "USDC",
  "payoutAddress": "So1YourPayoutAddress"
}
Request (EVM USDC payout): 
{
  "feeBps": 50,
  "payoutChain": "base",
  "payoutAsset": "USDC",
  "payoutAddress": "0xYourBaseUsdcAddress"
}
All four fields are required. payoutAddress is where affiliate fee claims are settled, and it is validated against the chosen payoutChain’s address format. Supported (payoutChain, payoutAsset) combinations include:
ChainSupported assets
arbitrumUSDC, USDT, ETH
baseUSDC, cbBTC, ETH
bscUSDT, BNB
bitcoinBTC
ethereumDAI, USDC, USDT, WBTC, ETH
optimismUSDC, USDT, ETH
plasmaUSDT
polygonUSDC, USDC.e
solanaUSDC, SOL
sparkBTC, USDB
tempoUSDC, PathUSD
tronUSDT, TRX
Any (chain, asset) tuple in the live payout route table is accepted. This table lists the common ones. The full live list is available via GET /v1/affiliate-dashboard/payout-destinations. The server validates the pair on PUT /v1/affiliates/:affiliateId and rejects unsupported combinations with invalid_payout_destination. Lightning is intentionally excluded. Lightning invoices are single-use and amount-bound, so they do not fit a static payout-address model. Response: 
{
  "affiliate": {
    "affiliateId": "flashpartner",
    "feeBps": 50,
    "payoutChain": "solana",
    "payoutAsset": "USDC",
    "payoutAddress": "So1YourPayoutAddress",
    "enabled": true,
    "createdAt": "2026-02-12T18:00:00.000Z",
    "updatedAt": "2026-02-12T18:00:00.000Z"
  }
}

​
GET /v1/affiliates

List affiliate profiles for your partner. Headers: 
Authorization: Bearer fn_...
Query params:
  • includeDisabled (true|false, default false)
  • limit (default 200, max 1000)
  • offset (default 0)

​
DELETE /v1/affiliates/:affiliateId

Disable an affiliate profile. Headers: 
Authorization: Bearer fn_...
X-Idempotency-Key: <unique key>
Response: 
{ "ok": true }

​
POST /v1/affiliates/:affiliateId/claim

Create a claim for the full available affiliate fee balance. The available balance reflects the affiliate’s 80% share after Flashnet’s 20% platform cut. Minimum claim is $1 USDC. Headers: 
Authorization: Bearer fn_...
X-Idempotency-Key: <unique key>
No request body. The claim amount is the full available balance. Response: 
{
  "claimId": "acl_...",
  "affiliateId": "flashpartner",
  "amount": "5000000",
  "status": "processing",
  "createdAt": "2026-02-27T12:00:00.000Z"
}
Claims require a payout destination configured on the affiliate profile (payoutChain, payoutAsset, payoutAddress). Claims are settled out of the same ledger where fees accrued (solana:USDC or spark:USDB depending on the orders that generated them) and delivered to the configured payout destination. The worker pipeline depends on the source ledger and destination:
SourceDestinationPipeline
Solana USDCSolana USDCSingle deliver-solana-usdc step
Solana USDCEVM stablecoin (USDC, USDT, and so on, on Base, Ethereum, Arbitrum, Optimism, Polygon, BSC)Single delivery step from the Solana USDC float wallet
Spark USDBSpark USDBSingle deliver-spark-usdb step
Spark USDBSolana USDC or EVM stablecoinBridge USDB to USDC, then delivery
Spark USDBSpark BTC or Bitcoin BTCSwap USDB to BTC, then deliver or withdraw. No USDC hop.

​
GET /v1/affiliate-dashboard/payout-destinations

List every (chain, asset) tuple supported as a payout destination. The list is derived live from the orchestrator’s pipeline route table, so it stays in sync with backend reality without doc updates whenever new supported chains are added. Use this for discovery instead of GET /v1/orchestration/routes (which only returns user-facing orchestration routes, not payout routes). Headers: 
Authorization: Bearer fn_...
Response: 
{
  "destinations": [
    { "chain": "arbitrum", "asset": "ETH" },
    { "chain": "arbitrum", "asset": "USDC" },
    { "chain": "arbitrum", "asset": "USDT" },
    { "chain": "base", "asset": "cbBTC" },
    { "chain": "base", "asset": "ETH" },
    { "chain": "base", "asset": "USDC" },
    { "chain": "bitcoin", "asset": "BTC" },
    { "chain": "bsc", "asset": "BNB" },
    { "chain": "bsc", "asset": "USDT" },
    { "chain": "ethereum", "asset": "DAI" },
    { "chain": "ethereum", "asset": "ETH" },
    { "chain": "ethereum", "asset": "USDC" },
    { "chain": "ethereum", "asset": "USDT" },
    { "chain": "ethereum", "asset": "WBTC" },
    { "chain": "optimism", "asset": "ETH" },
    { "chain": "optimism", "asset": "USDC" },
    { "chain": "optimism", "asset": "USDT" },
    { "chain": "plasma", "asset": "USDT" },
    { "chain": "polygon", "asset": "USDC" },
    { "chain": "polygon", "asset": "USDC.e" },
    { "chain": "solana", "asset": "SOL" },
    { "chain": "solana", "asset": "USDC" },
    { "chain": "spark", "asset": "BTC" },
    { "chain": "spark", "asset": "USDB" },
    { "chain": "tempo", "asset": "PathUSD" },
    { "chain": "tempo", "asset": "USDC" },
    { "chain": "tron", "asset": "TRX" },
    { "chain": "tron", "asset": "USDT" }
  ]
}
Entries are sorted alphabetically (case-insensitive) by (chain, asset). Lightning is intentionally excluded. The list above is the live snapshot at the time of writing. Call the endpoint for the current canonical set.

​
GET /v1/affiliates/:affiliateId/claims

List claims for an affiliate. Headers: 
Authorization: Bearer fn_...
Query params:
  • limit (default 50, max 200)
  • offset (default 0)

​
Partner webhooks

Webhooks deliver order status changes for your partner account.

​
POST /v1/webhooks

Register an endpoint. Headers: 
Authorization: Bearer fn_...
X-Idempotency-Key: <unique key>

{ "url": "https://example.com/flashnet/webhooks" }
Response: 
{
  "webhookId": "wh_...",
  "secret": "hex string"
}
secret is only returned at creation time. Store it.

​
DELETE /v1/webhooks/:id

Disable an endpoint. Headers: 
Authorization: Bearer fn_...
X-Idempotency-Key: <unique key>
Response: 
{ "ok": true }
See Webhooks for signature verification, payload shape, and retry behavior.

​
Accumulation addresses

Accumulation addresses are reusable deposit addresses on Solana and any supported chain. Each deposit automatically creates an order that delivers BTC or USDB on Spark.

​
POST /v1/accumulation-addresses

Create an accumulation address. Headers: 
Authorization: Bearer fn_...
X-Idempotency-Key: <unique key>
Inline app fee recipients: 
{
  "label": "optional",
  "sourceChain": "solana",
  "sourceAsset": "USDC",
  "destinationAsset": "BTC",
  "recipientSparkAddress": "spark1...",
  "feeBps": 5,
  "slippageBps": 50,
  "appFees": [
    { "recipient": "So1FeeRecipient...", "fee": 50 }
  ]
}
Registered affiliates with per-address bps override: 
{
  "label": "optional",
  "sourceChain": "solana",
  "sourceAsset": "USDC",
  "destinationAsset": "BTC",
  "recipientSparkAddress": "spark1...",
  "feeBps": 5,
  "slippageBps": 50,
  "affiliateIds": [
    "referrer-alice",
    { "affiliateId": "platform-fee", "feeBps": 25 }
  ]
}
appFees and affiliateIds are both optional and mutually exclusive (use one or the other, not both). affiliateIds entries accept the same string | { affiliateId, feeBps } union shape as POST /v1/orchestration/quote. The fee plan you submit is validated at creation time and frozen onto the address. Every deposit processed through this address replays the same plan without re-evaluating affiliate profiles. See Reusable Addresses for details. Response: 
{
  "accumulationAddressId": "acu_...",
  "sourceChain": "solana",
  "sourceAsset": "USDC",
  "destinationAsset": "BTC",
  "recipientSparkAddress": "spark1...",
  "feeBps": 5,
  "slippageBps": 50,
  "enabled": true,
  "depositAddress": "So1...",
  "createdAt": "2026-02-04T01:00:00.000Z",
  "appFees": [
    {
      "affiliateId": "platform-fee",
      "recipient": "So1PlatformPayoutAddress...",
      "feeBps": 25
    }
  ],
  "subscriptions": []
}
The response appFees array reflects the frozen fee plan. Each entry always has recipient and feeBps. affiliateId is present for entries backed by a registered affiliate profile (the recipient is pulled from the profile’s payoutAddress); inline appFees entries omit affiliateId. The array is omitted from the response when no fee plan was configured at creation.

​
POST /v1/accumulation-addresses/sync

Re-sync all enabled accumulation addresses into the configured deposit detection webhooks. Headers: 
Authorization: Bearer fn_...
X-Idempotency-Key: <unique key>

​
GET /v1/accumulation-addresses

List accumulation addresses.

​
GET /v1/accumulation-addresses/:id

Get a single accumulation address, including subscription status.

​
DELETE /v1/accumulation-addresses/:id

Disable an accumulation address. Headers: 
Authorization: Bearer fn_...
X-Idempotency-Key: <unique key>

​
Liquidation addresses

Liquidation addresses are reusable Bitcoin L1 deposit addresses. Each deposit automatically creates an order that delivers to any supported chain and asset.

​
POST /v1/liquidation-addresses

Create a liquidation address. Headers: 
Authorization: Bearer fn_...
X-Idempotency-Key: <unique key>
Inline app fee recipients: 
{
  "label": "optional",
  "destinationChain": "ethereum",
  "destinationAsset": "USDC",
  "destinationAddress": "0x...",
  "slippageBps": 50,
  "feeBps": 5,
  "appFees": [
    { "recipient": "So1FeeRecipient...", "fee": 50 }
  ]
}
Registered affiliates with per-address bps override: 
{
  "label": "optional",
  "destinationChain": "ethereum",
  "destinationAsset": "USDC",
  "destinationAddress": "0x...",
  "slippageBps": 50,
  "feeBps": 5,
  "affiliateIds": [
    "referrer-alice",
    { "affiliateId": "platform-fee", "feeBps": 25 }
  ]
}
appFees and affiliateIds are both optional and mutually exclusive. affiliateIds entries accept the same string | { affiliateId, feeBps } union shape as POST /v1/orchestration/quote. The fee plan is frozen at creation time and replayed into every Bitcoin L1 deposit processed through the address. appFees inline recipients must be valid addresses on the fee settlement chain (Solana USDC for most routes, Spark USDB for USDB destinations), not the destination chain. See Reusable Addresses for details. Response: 
{
  "liquidationAddressId": "liq_...",
  "sparkAddress": "spark1...",
  "l1DepositAddress": "bc1...",
  "destination": { "chain": "ethereum", "asset": "USDC", "address": "0x..." },
  "feeBps": 5,
  "slippageBps": 50,
  "enabled": true,
  "createdAt": "2026-02-04T01:00:00.000Z",
  "appFees": [
    {
      "affiliateId": "platform-fee",
      "recipient": "So1PlatformPayoutAddress...",
      "feeBps": 25
    }
  ]
}
The response appFees array reflects the frozen fee plan. Each entry always has recipient and feeBps. affiliateId is present for entries backed by a registered affiliate profile; inline appFees entries omit it. The array is omitted when no fee plan was configured.

​
GET /v1/liquidation-addresses

List enabled liquidation addresses.

​
GET /v1/liquidation-addresses/:id

Get a single liquidation address (enabled or disabled).

​
DELETE /v1/liquidation-addresses/:id

Disable a liquidation address. Headers: 
Authorization: Bearer fn_...
X-Idempotency-Key: <unique key>

​
POST /v1/liquidation-addresses/sync-blockdaemon

Synchronize enabled liquidation addresses into Blockdaemon Streaming watchlists. Headers: 
Authorization: Bearer fn_...
X-Idempotency-Key: <unique key>