{"openapi":"3.1.0","info":{"title":"Flashnet Orchestrator API","version":"0.1.0","description":"Partner API for quotes, orders, standing deposits, webhooks, and affiliates. Operations marked x-excluded are omitted from the documentation navigation; internal, pay-link, SSE, and provider-integration routes are outside this registry."},"servers":[{"url":"https://orchestration.flashnet.xyz"}],"tags":[{"name":"Lightning","description":"Read-only Lightning invoice inspection."},{"name":"Orchestration","description":"Routes, limits, estimates, quotes, orders, onramp, and ZeroConf decisions for one-off swaps."},{"name":"Standing Deposit Addresses","description":"Permanent per-customer deposit addresses bound to one immutable conversion instruction."},{"name":"Webhooks","description":"Registration of HTTPS endpoints for order status events and recovery events."},{"name":"Affiliates","description":"Registered fee recipients, their accrued balances, and claims."},{"name":"Accumulation Addresses","description":"Legacy reusable addresses that convert one source asset into Spark BTC or USDB."},{"name":"Liquidations","description":"Legacy Bitcoin L1 deposit addresses that convert each output to a configured destination."},{"name":"System"},{"name":"Explorer"},{"name":"Dashboard"},{"name":"Affiliate Dashboard"}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Partner API key in the form `Authorization: Bearer fn_...`."}},"schemas":{"LightningDecodeRequest":{"type":"object","properties":{"invoice":{"type":"string","minLength":1,"maxLength":16384}},"required":["invoice"],"additionalProperties":false},"LightningInvoiceDetails":{"type":"object","properties":{"network":{"type":"string","enum":["mainnet","testnet","signet","regtest","simnet"]},"amountMsats":{"type":["string","null"],"pattern":"^\\d+$","description":"Null for amountless invoices."},"amountSats":{"type":["string","null"],"pattern":"^\\d+$","description":"Null for amountless invoices or amounts containing fractional sats."},"paymentHash":{"type":"string","pattern":"^[0-9a-f]{64}$"},"timestamp":{"type":"integer","minimum":0,"description":"Invoice creation time in Unix seconds."},"expiry":{"type":"integer","minimum":0,"description":"Expiry duration in seconds; defaults to 3600."},"expiresAt":{"type":"integer","minimum":0,"description":"timestamp + expiry, in Unix seconds."},"expired":{"type":"boolean","description":"Whether expiresAt has passed according to the server clock."},"description":{"type":["string","null"]},"descriptionHash":{"type":["string","null"],"pattern":"^[0-9a-f]{64}$"},"signatureVerified":{"type":"boolean","enum":[false],"description":"Signature is not verified. Inspection does not establish payability."}},"required":["network","amountMsats","amountSats","paymentHash","timestamp","expiry","expiresAt","expired","description","descriptionHash","signatureVerified"],"additionalProperties":false},"ErrorDetail":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false},"ErrorResponse":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/ErrorDetail"}},"required":["error"],"additionalProperties":false},"BlockedAddress":{"type":"object","properties":{"scope":{"type":"string","minLength":1,"description":"Canonical policy scope; evm covers all EVM chains."},"address":{"type":"string","minLength":1,"description":"Canonical stored address; case-sensitive where applicable."},"updatedAt":{"type":"string","format":"date-time","description":"Last policy-decision write in UTC ISO 8601, not screening time."}},"required":["scope","address","updatedAt"],"additionalProperties":false},"OrchestrationBlockedAddressesResponse":{"type":"object","properties":{"addresses":{"type":"array","items":{"$ref":"#/components/schemas/BlockedAddress"}}},"required":["addresses"],"additionalProperties":false},"OkResponse":{"type":"object","properties":{"ok":{"type":"boolean"}},"required":["ok"],"additionalProperties":false},"HealthzResponse":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true]}},"required":["ok"],"additionalProperties":false},"HealthzUnavailableResponse":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false]},"db":{"type":"string","enum":["unreachable"]}},"required":["ok","db"],"additionalProperties":false},"LivezResponse":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true]},"tee":{"type":"string","enum":["ok"]}},"required":["ok","tee"],"additionalProperties":false},"LivezUnavailableResponse":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false]},"tee":{"type":"string","enum":["unreachable"]}},"required":["ok","tee"],"additionalProperties":false},"Chain":{"type":"string","enum":["arbitrum","arc","avalanche","base","bitcoin","bsc","ethereum","hedera","hypercore","hyperevm","lightning","litecoin","monad","monero","optimism","plasma","polygon","robinhood","sei","solana","spark","tempo","ton","tron","xrp","zcash"]},"ReviewedAssetIdentity":{"type":"object","properties":{"version":{"type":"number","enum":[1]},"catalogVersion":{"type":"string","pattern":"^sha256:[0-9a-f]{64}$"},"chain":{"type":"string","enum":["solana","ethereum","bsc","arbitrum"]},"asset":{"type":"string","minLength":1,"maxLength":32},"address":{"type":"string","minLength":32,"maxLength":44},"decimals":{"type":"integer","minimum":0,"maximum":255},"tokenProgram":{"type":"string","enum":["erc20","spl","token-2022"]},"mechanic":{"type":"string","enum":["standard","scaled-ui","rebasing","accumulating"]},"mechanicHash":{"type":"string","pattern":"^sha256:[0-9a-f]{64}$"}},"required":["version","catalogVersion","chain","asset","address","decimals","tokenProgram","mechanic","mechanicHash"],"additionalProperties":false},"FrozenAssetDisplayMetadata":{"type":"object","properties":{"version":{"type":"number","enum":[1]},"chain":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,63}$"},"asset":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9._-]{0,95}$"},"address":{"type":["string","null"]},"decimals":{"type":"integer","minimum":0,"maximum":255},"tokenProgram":{"type":"string","enum":["native","erc20","spl","token-2022","external"]},"amountModel":{"type":"string","enum":["raw","scaled-ui","rebasing","accumulating","unknown"]}},"required":["version","chain","asset","address","decimals","tokenProgram","amountModel"],"additionalProperties":false},"PublicAssetDetails":{"type":"object","properties":{"chain":{"$ref":"#/components/schemas/Chain"},"asset":{"type":"string"},"assetDisplayName":{"type":"string"},"assetDisplaySymbol":{"type":"string"},"contractAddress":{"type":["string","null"]},"decimals":{"type":"integer"},"tokenProgram":{"type":"string","enum":["erc20","spl","token-2022"]},"reviewedIdentity":{"$ref":"#/components/schemas/ReviewedAssetIdentity"},"chainId":{"type":["string","null"]},"chainDisplayName":{"type":"string"},"chainIcon":{"type":["string","null"]},"assetIcon":{"type":"string","format":"uri","description":"Absolute https logo URL served from the asset registry. Absent when the asset has no registry logo; clients keep their bundled artwork."},"listing":{"type":"string","enum":["listed","unlisted"],"description":"unlisted for a source or destination named by a token address the asset registry does not list; absent means listed. Unlisted details come from the token contract or mint and are display data only; asset and contractAddress are the canonical address, and a Solana mint carries tokenProgram."}},"required":["chain","asset","assetDisplayName","assetDisplaySymbol","contractAddress","decimals","chainId","chainDisplayName","chainIcon"],"additionalProperties":false},"Asset":{"type":"string","enum":["AAPL","AI","AMD","AMZN","BNB","BONER","BTC","CASHCAT","COIN","COST","DAI","DELTA","DJT","ETH","GLD","GME","GOOGL","GRAM","HIMS","HSUSD","HYPE","IF","LTC","META","MON","MSFT","MSTR","MU","NVDA","OUSD","PIPEDOG","PLTR","POL","PONS","PYUSD","PathUSD","QQQ","RDDT","SHX","SKHY","SLV","SNDK","SOL","SPCX","SPY","STONKBROKER","TENDIES","TRX","TSLA","TSM","UP","USDB","USDC","USDC.e","USDG","USDT","USDe","USD₮0","USO","WBNB","WBTC","WEN","XMR","XO","XPL","XRP","ZEC","cbBTC","tBTC"],"description":"Legacy asset symbol. OUSD identifies Open Standard Open USD issued by Bridge, not Origin Dollar. Use route discovery for supported chains and directions."},"RegistryAssetKey":{"type":"string","minLength":1,"maxLength":96,"pattern":"^[A-Za-z0-9][A-Za-z0-9._-]*$","description":"Routing key of an asset served from the shared asset registry, as advertised by GET /v2/orchestration/routes (for example asset_<sha256>). Accepted only while the registry serves the asset; any other value fails validation."},"AssetInput":{"anyOf":[{"$ref":"#/components/schemas/Asset"},{"type":"string","enum":["TON"]},{"$ref":"#/components/schemas/RegistryAssetKey"}],"description":"A canonical public asset symbol or a registry asset routing key. TON is a legacy input alias for ton:GRAM only; responses use GRAM."},"TokenAddress":{"type":"string","pattern":"^(0x[0-9a-fA-F]{40}|[1-9A-HJ-NP-Za-km-z]{32,44})$","description":"A token named by its on-chain address: an ERC-20 contract on an EVM chain (lowercase or EIP-55 checksummed, for example 0x6982508145454ce325ddbe47a25d4ec3d2311933), or an SPL mint on solana (base58, case-sensitive and kept exactly, for example DezXAZ8z7PnrnRJjz3wXBoRgixCa6xjnB7YaB1pPB263). An address the registry lists is served as that asset; any other is an unlisted token, admitted per partner and per end on chains listed in tokenSupport of GET /v2/orchestration/routes. Unlisted tokens support exact_in with variable delivery only."},"SourceAssetInput":{"anyOf":[{"$ref":"#/components/schemas/Asset"},{"type":"string","enum":["TON"]},{"$ref":"#/components/schemas/RegistryAssetKey"},{"$ref":"#/components/schemas/TokenAddress"}],"description":"An AssetInput, or a token address. A quote whose source is an unlisted token requires refundAddress: a deposit that cannot be sold is refunded in kind there."},"DestinationAssetInput":{"anyOf":[{"$ref":"#/components/schemas/Asset"},{"type":"string","enum":["TON"]},{"$ref":"#/components/schemas/RegistryAssetKey"},{"$ref":"#/components/schemas/TokenAddress"}],"description":"An AssetInput, or a token address. An unlisted destination adds minAmountOut and fallback to the quote."},"UnlistedFallback":{"type":"object","properties":{"chain":{"$ref":"#/components/schemas/Chain"},"asset":{"type":"string","description":"Hub asset delivered instead of the token."},"minAmount":{"type":"string","description":"Least amount of the hub the recipient receives, in its smallest units."}},"required":["chain","asset","minAmount"],"additionalProperties":false,"description":"Unlisted destinations only: what the recipient receives if the swap into the token cannot deliver minAmountOut."},"OperationStage":{"type":"object","properties":{"name":{"type":"string"},"status":{"type":"string","enum":["completed"]},"completedAt":{"type":"string"}},"required":["name","status","completedAt"],"additionalProperties":false},"OperationRecord":{"type":"object","properties":{"id":{"type":"string"},"reviewedAssets":{"type":"array","items":{"$ref":"#/components/schemas/ReviewedAssetIdentity"},"minItems":1,"maxItems":32,"description":"Exact immutable reviewed token identities frozen by the native quote. Omitted for legacy or invalid snapshots; caller metadata cannot set these pins."},"frozenAssets":{"type":"array","items":{"$ref":"#/components/schemas/FrozenAssetDisplayMetadata"},"minItems":1,"maxItems":32,"description":"Additive display metadata derived from the validated order-frozen plan. Amounts remain integer smallest units; scaled-ui and other non-raw models require an explicit semantic label."},"type":{"type":"string","enum":["order"]},"quoteId":{"type":["string","null"]},"tag":{"type":["string","null"],"description":"Partner tag from the quote that funded this order; null when untagged."},"status":{"type":"string","description":"Partner-visible order status. Internal paused orders are reported as processing. fallback_delivered is terminal: an unlisted-token order whose swap could not meet minAmountOut delivered the quoted fallback hub instead (fallbackAsset, fallbackAmount, fallbackTxHash), and amountOut is null."},"sourceChain":{"allOf":[{"$ref":"#/components/schemas/Chain"},{"type":["string","null"]}]},"sourceAsset":{"type":["string","null"]},"sourceAddress":{"type":["string","null"]},"sourceTxHash":{"type":["string","null"]},"sourceTxVout":{"type":["integer","null"]},"sourceTxKey":{"type":["string","null"]},"sweepTxHash":{"type":["string","null"]},"destinationChain":{"allOf":[{"$ref":"#/components/schemas/Chain"},{"type":["string","null"]}]},"destinationAsset":{"type":["string","null"]},"destinationAddress":{"type":["string","null"]},"destinationTxHash":{"type":["string","null"]},"depositAddress":{"type":["string","null"]},"recipientAddress":{"type":["string","null"]},"supersededByOperationId":{"type":["string","null"],"description":"Successor order ID for a recovered deposit; follow it for the delivered result."},"recoveredFromOperationId":{"type":["string","null"],"description":"Original order ID whose replaced deposit this order recovered."},"amountIn":{"type":["string","null"]},"amountOut":{"type":["string","null"],"description":"Delivered destination amount in smallest units, after delivery fees; null until completion."},"amountInUsd":{"type":"string","description":"USD settlement notional on completed orders, independently optional. Stable inputs use their amount; supported nonstable inputs use executed stable proceeds, which can exclude ingress fees. Not a live market valuation."},"amountOutUsd":{"type":"string","description":"USD settlement notional on completed orders, independently optional. Stable outputs use their amount; supported nonstable outputs use the stable cost of acquisition. Omitted when execution or delivery evidence is insufficient. Not a live market valuation."},"amountFiatUsd":{"type":"string","description":"Requested USD amount, present when the order used amountFiatUsd."},"amountFiatCurrency":{"type":"string","description":"Currency for amountFiatUsd. Always \"USD\" today."},"spotUsdPerBtc":{"type":"string","description":"BTC/USD spot used to convert amountFiatUsd to sats at order creation."},"feeBps":{"type":["integer","null"]},"feeAmount":{"type":["string","null"]},"feeAsset":{"type":["string","null"]},"feeAssetDetails":{"$ref":"#/components/schemas/PublicAssetDetails"},"feeAmountUsd":{"type":"string"},"totalFeeAmountUsd":{"type":"string"},"roundingFeeAmount":{"type":["string","null"]},"slippageBps":{"type":["integer","null"]},"flashnetRequestId":{"type":["string","null"]},"sparkTxHash":{"type":["string","null"]},"refundAsset":{"type":["string","null"]},"refundAmount":{"type":["string","null"]},"refundTxHash":{"type":["string","null"]},"fallbackAsset":{"type":["string","null"],"description":"fallback_delivered orders only: the hub asset delivered on destinationChain instead of the token."},"fallbackAmount":{"type":["string","null"],"description":"fallback_delivered orders only: delivered fallbackAsset amount in smallest units."},"fallbackTxHash":{"type":["string","null"],"description":"fallback_delivered orders only: transaction that delivered fallbackAsset, a 0x hash on EVM or a base58 signature on Solana."},"errorCode":{"type":["string","null"],"description":"Partner-safe error code."},"errorMessage":{"type":["string","null"],"description":"Partner-safe error message."},"swap":{"type":"object","properties":{}},"ingressSwap":{"type":"object","properties":{}},"egressSwap":{"type":"object","properties":{}},"feePlan":{"type":"object","properties":{}},"feePayouts":{"type":"object","properties":{}},"priceLock":{"type":"object","properties":{}},"reprice":{"type":"object","properties":{}},"paymentIntent":{"type":"object","properties":{}},"zeroconfOffer":{"type":"object","properties":{},"description":"Bitcoin ZeroConf outcome; denied outcomes require a valid readToken or X-Read-Token."},"totalFeeBps":{"type":"integer"},"totalFeeAmount":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"completedAt":{"type":["string","null"]}},"required":["id","type","status","createdAt","updatedAt"]},"ExplorerRef":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"},"chain":{"type":["string","null"]},"vout":{"type":["integer","null"]},"leg":{"type":["string","null"]}},"required":["type","value","chain","vout","leg"],"additionalProperties":false},"DashboardOperationRecord":{"allOf":[{"$ref":"#/components/schemas/OperationRecord"},{"type":"object","properties":{"sourceAssetAddress":{"type":["string","null"],"description":"Token contract, mint, or jetton master address for sourceAsset when applicable."},"destinationAssetAddress":{"type":["string","null"],"description":"Token contract, mint, or jetton master address for destinationAsset when applicable."},"affiliateIds":{"type":"array","items":{"type":"string"},"description":"Affiliate ids associated with this operation via operation_affiliate_fees. Present on the list endpoint (empty when none); omitted on the single-operation detail endpoint."}},"additionalProperties":false}]},"PublicExplorerOperationRecord":{"type":"object","properties":{"id":{"type":"string"},"reviewedAssets":{"type":"array","items":{"$ref":"#/components/schemas/ReviewedAssetIdentity"},"minItems":1,"maxItems":32,"description":"Exact immutable reviewed token identities frozen by the native quote. Omitted for legacy or invalid snapshots; caller metadata cannot set these pins."},"frozenAssets":{"type":"array","items":{"$ref":"#/components/schemas/FrozenAssetDisplayMetadata"},"minItems":1,"maxItems":32,"description":"Additive display metadata derived from the validated order-frozen plan. Amounts remain integer smallest units; scaled-ui and other non-raw models require an explicit semantic label."},"type":{"type":"string","enum":["order"]},"status":{"type":"string","description":"Partner-visible order status. Internal paused orders are reported as processing. fallback_delivered is terminal: an unlisted-token order whose swap could not meet minAmountOut delivered the quoted fallback hub instead (fallbackAsset, fallbackAmount, fallbackTxHash), and amountOut is null."},"sourceChain":{"allOf":[{"$ref":"#/components/schemas/Chain"},{"type":["string","null"]}]},"sourceAsset":{"type":["string","null"]},"sourceTxHash":{"type":["string","null"]},"sourceTxVout":{"type":["integer","null"]},"destinationChain":{"allOf":[{"$ref":"#/components/schemas/Chain"},{"type":["string","null"]}]},"destinationAsset":{"type":["string","null"]},"destinationTxHash":{"type":["string","null"]},"amountIn":{"type":["string","null"]},"amountOut":{"type":["string","null"]},"sourceToken":{"type":"object","properties":{}},"destinationToken":{"type":"object","properties":{}},"sparkTxHash":{"type":["string","null"]},"refundAsset":{"type":["string","null"]},"refundAmount":{"type":["string","null"]},"refundTxHash":{"type":["string","null"]},"fallbackAsset":{"type":["string","null"],"description":"fallback_delivered orders only: the hub asset delivered on destinationChain instead of the token."},"fallbackAmount":{"type":["string","null"],"description":"fallback_delivered orders only: delivered fallbackAsset amount in smallest units."},"fallbackTxHash":{"type":["string","null"],"description":"fallback_delivered orders only: transaction that delivered fallbackAsset, a 0x hash on EVM or a base58 signature on Solana."},"errorCode":{"type":["string","null"]},"errorMessage":{"type":["string","null"]},"slippageBps":{"type":["integer","null"]},"supersededByOperationId":{"type":["string","null"],"description":"Successor order id that recovered this order's deposit, if any (issue #669)."},"recoveredFromOperationId":{"type":["string","null"],"description":"Original order id this order recovered, if any (issue #669)."},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"completedAt":{"type":["string","null"]}},"required":["id","type","status","createdAt","updatedAt"]},"PublicExplorerOperationResult":{"type":"object","properties":{"operation":{"$ref":"#/components/schemas/PublicExplorerOperationRecord"},"partner":{"type":"null"},"refs":{"type":"array","items":{"$ref":"#/components/schemas/ExplorerRef"}}},"required":["operation","partner","refs"],"additionalProperties":false},"PublicExplorerOperationsResponse":{"type":"object","properties":{"operations":{"type":"array","items":{"$ref":"#/components/schemas/PublicExplorerOperationResult"}},"nextOffset":{"type":"null"}},"required":["operations","nextOffset"],"additionalProperties":false},"PublicExplorerOperationDetailResponse":{"type":"object","properties":{"operation":{"$ref":"#/components/schemas/PublicExplorerOperationRecord"},"partner":{"type":"null"},"refs":{"type":"array","items":{"$ref":"#/components/schemas/ExplorerRef"}},"stages":{"type":"array","items":{"$ref":"#/components/schemas/OperationStage"}}},"required":["operation","partner","refs","stages"],"additionalProperties":false},"ShieldedRouteCapability":{"type":"object","properties":{"mode":{"type":"string","enum":["shielded"]},"addressType":{"type":"string","enum":["unified"]},"receiverPools":{"type":"array","prefixItems":[{"type":"string","enum":["orchard"]}]},"amountModes":{"type":"array","prefixItems":[{"type":"string","enum":["exact_in"]}]},"deliveryModes":{"type":"array","prefixItems":[{"type":"string","enum":["variable"]}]},"requiresRefundAddress":{"type":"boolean","enum":[true]},"requiredConfirmations":{"type":"integer","exclusiveMinimum":0},"maxSourceFeeZats":{"type":"string"},"maxRefundFeeZats":{"type":"string","description":"Maximum network cost in zatoshis for each refund transaction; multiple refund transactions may each incur this cap."}},"required":["mode","addressType","receiverPools","amountModes","deliveryModes","requiresRefundAddress","requiredConfirmations","maxSourceFeeZats","maxRefundFeeZats"],"additionalProperties":false},"ShieldedFundingStatus":{"type":"string","enum":["awaiting_payment","detected","confirming","ready","provider_funding","provider_processing","settling","delivering","completed","recovery_required","refunding","refunded"]},"ShieldedFundingDetails":{"oneOf":[{"type":"object","properties":{"version":{"type":"number","enum":[1]},"sourcePaymentMode":{"type":"string","enum":["shielded"]},"senderVisibility":{"type":"string","enum":["shielded"],"description":"Receipt proof does not identify the sender or originating wallet software."},"sourceHistoryScreening":{"type":"string","enum":["unavailable"],"description":"Hidden source history is unavailable. Screening of visible counterparties is separate from receipt verification."},"amountExpected":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"amountReceived":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"amountConfirmed":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"amountAllocated":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"confirmations":{"type":"integer","minimum":0},"requiredConfirmations":{"type":"integer","exclusiveMinimum":0},"payBy":{"type":"string","format":"date-time"},"selectedProvider":{"type":["string","null"],"enum":["near-intents","hyperunit"],"description":"Provider committed in the immutable execution attempt; null before commitment."},"providerLocked":{"type":"boolean","description":"Whether an execution attempt has committed a provider."},"recoveryReason":{"type":"object","properties":{"code":{"type":"string","enum":["allocation_reorg","excess_payment","late_payment","funding_expired","too_many_notes","mixed_pools","provider_failed","provider_released","reconciliation_required","additional_payment"]}},"required":["code"],"additionalProperties":false,"description":"Safe recovery category; never raw provider errors or private receipt evidence."},"refundLastVerifiedAt":{"type":"string","format":"date-time","description":"For refunded: oldest latest owned-node canonical check across all customer refund obligations. Status is as of these checks, not a guarantee of continuous canonicality; failed rechecks invalidate it."}},"required":["version","sourcePaymentMode","senderVisibility","sourceHistoryScreening","amountExpected","amountReceived","amountConfirmed","amountAllocated","confirmations","requiredConfirmations","payBy"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"number","enum":[2]},"sourcePaymentMode":{"type":"string","enum":["shielded"]},"senderVisibility":{"type":"string","enum":["shielded"],"description":"Receipt proof does not identify the sender or originating wallet software."},"sourceHistoryScreening":{"type":"string","enum":["unavailable"],"description":"Hidden source history is unavailable. Screening of visible counterparties is separate from receipt verification."},"amountExpected":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"amountReceived":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"amountConfirmed":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"amountAllocated":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"confirmations":{"type":"integer","minimum":0},"requiredConfirmations":{"type":"integer","exclusiveMinimum":0},"payBy":{"type":"string","format":"date-time"},"selectedProvider":{"type":["string","null"],"enum":["near-intents","hyperunit"],"description":"Provider committed in the immutable execution attempt; null before commitment."},"providerLocked":{"type":"boolean","description":"Whether an execution attempt has committed a provider."},"recoveryReason":{"type":"object","properties":{"code":{"type":"string","enum":["allocation_reorg","excess_payment","late_payment","funding_expired","too_many_notes","mixed_pools","provider_failed","provider_released","reconciliation_required","additional_payment"]}},"required":["code"],"additionalProperties":false,"description":"Safe recovery category; never raw provider errors or private receipt evidence."},"refundLastVerifiedAt":{"type":"string","format":"date-time","description":"For refunded: oldest latest owned-node canonical check across all customer refund obligations. Status is as of these checks, not a guarantee of continuous canonicality; failed rechecks invalidate it."},"amountMode":{"type":"string","enum":["actual-input"]},"pricing":{"type":"string","enum":["market-at-funding"]},"amountActual":{"type":["string","null"],"pattern":"^(0|[1-9][0-9]*)$","description":"Frozen gross input; null before materialization."},"committedMinAmountOut":{"type":["string","null"],"pattern":"^(0|[1-9][0-9]*)$","description":"Destination floor frozen at execution; null before commitment."}},"required":["version","sourcePaymentMode","senderVisibility","sourceHistoryScreening","amountExpected","amountReceived","amountConfirmed","amountAllocated","confirmations","requiredConfirmations","payBy","amountMode","pricing","amountActual","committedMinAmountOut"],"additionalProperties":false}]},"RoutePair":{"type":"object","properties":{"sourceChain":{"$ref":"#/components/schemas/Chain"},"sourceAsset":{"type":"string"},"destinationChain":{"$ref":"#/components/schemas/Chain"},"destinationAsset":{"type":"string"},"exactOutEligible":{"type":"boolean"},"fixedEligible":{"type":"boolean"},"source":{"$ref":"#/components/schemas/PublicAssetDetails"},"destination":{"$ref":"#/components/schemas/PublicAssetDetails"}},"required":["sourceChain","sourceAsset","destinationChain","destinationAsset","exactOutEligible","fixedEligible","source","destination"],"additionalProperties":false},"OrchestrationRoutesResponse":{"type":"object","properties":{"routes":{"type":"array","items":{"type":"object","properties":{"sourceChain":{"$ref":"#/components/schemas/Chain"},"sourceAsset":{"type":"string"},"destinationChain":{"$ref":"#/components/schemas/Chain"},"destinationAsset":{"type":"string"},"exactOutEligible":{"type":"boolean"},"fixedEligible":{"type":"boolean"},"source":{"$ref":"#/components/schemas/PublicAssetDetails"},"destination":{"$ref":"#/components/schemas/PublicAssetDetails"},"sourcePaymentModes":{"type":"array","items":{"$ref":"#/components/schemas/ShieldedRouteCapability"}}},"required":["sourceChain","sourceAsset","destinationChain","destinationAsset","exactOutEligible","fixedEligible","source","destination"],"additionalProperties":false}},"sourcePaymentMode":{"type":"string","enum":["shielded"]},"validForMs":{"type":"integer","minimum":0,"maximum":10000,"description":"Usable catalog lifetime in milliseconds from request start, at most 10 seconds; shortened only by a reviewed lane's qualification expiry."}},"required":["routes"],"additionalProperties":false},"RouteSet":{"anyOf":[{"type":"string","enum":["all"]},{"type":"array","items":{"type":"string"}},{"type":"object","properties":{"except":{"type":"array","items":{"type":"string"}}},"required":["except"],"additionalProperties":false}],"description":"Destination IDs from this response: \"all\" means all other assets, an array lists destinations, and {except: [...]} excludes IDs from all other assets; [] means none."},"PublicRouteAsset":{"type":"object","properties":{"id":{"type":"string","description":"Asset ID in <publicChain>:<canonical request asset> form."},"chain":{"$ref":"#/components/schemas/Chain"},"asset":{"type":"string"},"assetDisplayName":{"type":"string"},"assetDisplaySymbol":{"type":"string"},"contractAddress":{"type":["string","null"]},"decimals":{"type":"integer"},"tokenProgram":{"type":"string","enum":["erc20","spl","token-2022"]},"reviewedIdentity":{"$ref":"#/components/schemas/ReviewedAssetIdentity"},"chainId":{"type":["string","null"]},"chainDisplayName":{"type":"string"},"chainIcon":{"type":["string","null"]},"assetIcon":{"type":"string","format":"uri","description":"Absolute https logo URL served from the asset registry. Absent when the asset has no registry logo; clients keep their bundled artwork."},"listing":{"type":"string","enum":["listed","unlisted"],"description":"unlisted for a source or destination named by a token address the asset registry does not list; absent means listed. Unlisted details come from the token contract or mint and are display data only; asset and contractAddress are the canonical address, and a Solana mint carries tokenProgram."},"route":{"type":"object","properties":{"to":{"allOf":[{"$ref":"#/components/schemas/RouteSet"},{"description":"Admitted directed destinations from this asset."}]},"exactOutTo":{"allOf":[{"$ref":"#/components/schemas/RouteSet"},{"description":"Destinations in to supporting amountMode=exact_out."}]},"fixedTo":{"allOf":[{"$ref":"#/components/schemas/RouteSet"},{"description":"Destinations in to supporting fixed delivery, subject to partner configuration."}]}},"required":["to","exactOutTo","fixedTo"],"additionalProperties":false}},"required":["id","chain","asset","assetDisplayName","assetDisplaySymbol","contractAddress","decimals","chainId","chainDisplayName","chainIcon","route"],"additionalProperties":false},"TokenSupport":{"type":"object","properties":{"chain":{"$ref":"#/components/schemas/Chain"},"destination":{"type":"string","enum":["any","listed"],"description":"any: any token on chain (an ERC-20 address, or an SPL mint on solana) may be requested as destinationAsset. listed: only assets in this response."},"source":{"type":"string","enum":["any","listed"],"description":"any: any token on chain may be requested as sourceAsset by its address; the quote then requires refundAddress. listed: only assets in this response."},"via":{"type":"array","items":{"type":"string"},"minItems":1,"description":"Hub asset IDs from this response. A token on chain is reachable as a destination from asset A when A is one of via or A.route.to contains one of via; as a source it reaches asset B when B is one of via or one of via has B in route.to."}},"required":["chain","destination","source","via"],"additionalProperties":false},"OrchestrationRoutesV2Response":{"type":"object","properties":{"validForMs":{"type":"integer","minimum":0,"maximum":10000,"description":"Usable catalog lifetime in milliseconds from request start, at most 10 seconds; shortened only by a reviewed lane's qualification expiry."},"assets":{"type":"array","items":{"$ref":"#/components/schemas/PublicRouteAsset"},"description":"Admitted assets in chain-priority order; destination-only assets have empty outbound sets."},"tokenSupport":{"type":"array","items":{"$ref":"#/components/schemas/TokenSupport"},"description":"Chains where this caller may name a destination by token address. Absent when there are none."}},"required":["assets"],"additionalProperties":false},"OrchestrationLimitConstraint":{"type":"object","properties":{"id":{"type":"string"},"amountMode":{"type":"string","enum":["all","exact_in","exact_out"]},"leg":{"type":"string","enum":["source","destination","route"]},"source":{"type":"string","enum":["runtime_order_bounds","flashnet_static_limit","bitcoin_l1_delivery","provider_quote","fiat_amount"]},"description":{"type":"string"},"chain":{"allOf":[{"$ref":"#/components/schemas/Chain"},{"type":["string","null"]}]},"asset":{"type":["string","null"]},"minAmountSmallest":{"type":["string","null"]},"maxAmountSmallest":{"type":["string","null"]},"minUsdCents":{"type":["string","null"]},"maxUsdCents":{"type":["string","null"]}},"required":["id","amountMode","leg","source","description","chain","asset","minAmountSmallest","maxAmountSmallest","minUsdCents","maxUsdCents"],"additionalProperties":false},"OrchestrationLimitRequestAmount":{"type":"object","properties":{"leg":{"type":"string","enum":["source","destination"]},"chain":{"$ref":"#/components/schemas/Chain"},"asset":{"type":"string"},"minAmountSmallest":{"type":["string","null"]},"maxAmountSmallest":{"type":["string","null"]},"minUsdCents":{"type":["string","null"]},"maxUsdCents":{"type":["string","null"]}},"required":["leg","chain","asset","minAmountSmallest","maxAmountSmallest","minUsdCents","maxUsdCents"],"additionalProperties":false},"OrchestrationLimitMode":{"type":"object","properties":{"supported":{"type":"boolean"},"requestAmount":{"allOf":[{"$ref":"#/components/schemas/OrchestrationLimitRequestAmount"},{"type":["object","null"]}]},"constraints":{"type":"array","items":{"type":"string"}}},"required":["supported","requestAmount","constraints"],"additionalProperties":false},"OrchestrationLimitRoute":{"allOf":[{"$ref":"#/components/schemas/RoutePair"},{"type":"object","properties":{"sourcePaymentModes":{"type":"array","items":{"$ref":"#/components/schemas/ShieldedRouteCapability"}},"direction":{"type":"string","enum":["buy","sell","xchain"]},"limits":{"type":"object","properties":{"orderNotionalUsd":{"type":"object","properties":{"minCents":{"type":["string","null"]},"maxCents":{"type":["string","null"]},"source":{"type":"string","enum":["runtime_order_bounds"]}},"required":["minCents","maxCents","source"],"additionalProperties":false},"exactIn":{"$ref":"#/components/schemas/OrchestrationLimitMode"},"exactOut":{"$ref":"#/components/schemas/OrchestrationLimitMode"},"fiatUsd":{"type":["object","null"],"properties":{"supported":{"type":"boolean"},"min":{"type":"string"},"max":{"type":"string"},"surfaces":{"type":"array","items":{"type":"string"}}},"required":["supported","min","max","surfaces"],"additionalProperties":false},"dynamicProviderLimits":{"type":"object","properties":{"possible":{"type":"boolean"},"components":{"type":"array","items":{"type":"string"}},"description":{"type":["string","null"]}},"required":["possible","components","description"],"additionalProperties":false},"constraints":{"type":"array","items":{"$ref":"#/components/schemas/OrchestrationLimitConstraint"}}},"required":["orderNotionalUsd","exactIn","exactOut","fiatUsd","dynamicProviderLimits","constraints"],"additionalProperties":false}},"required":["direction","limits"],"additionalProperties":false}]},"OrchestrationLimitsResponse":{"type":"object","properties":{"generatedAt":{"type":"string"},"routes":{"type":"array","items":{"$ref":"#/components/schemas/OrchestrationLimitRoute"}},"sourcePaymentMode":{"type":"string","enum":["shielded"]}},"required":["generatedAt","routes"],"additionalProperties":false},"OrchestrationAppFeeRequest":{"type":"object","properties":{"recipient":{"type":"string","minLength":1,"description":"Fee recipient address; sanctioned addresses are rejected."},"fee":{"type":"integer","minimum":1,"maximum":9999}},"required":["recipient","fee"],"description":"Unknown top-level fields are ignored rather than rejected."},"OrchestrationAffiliateIdEntry":{"anyOf":[{"type":"string","minLength":1,"description":"Registered affiliate id. Uses the profile's static feeBps."},{"type":"object","properties":{"affiliateId":{"type":"string","minLength":1},"feeBps":{"type":"integer","minimum":1,"maximum":9999,"description":"Fee override for this quote only; the stored affiliate profile is unchanged."}},"required":["affiliateId","feeBps"],"additionalProperties":false}],"description":"Registered affiliate ID or { affiliateId, feeBps } override."},"OrchestrationAppFeeQuote":{"type":"object","properties":{"affiliateId":{"type":"string"},"recipient":{"type":"string","minLength":1},"feeBps":{"type":"integer","minimum":1,"maximum":9999},"amount":{"type":"string"},"platformCutAmount":{"type":"string"},"recipientAmount":{"type":"string"}},"required":["recipient","feeBps","amount","platformCutAmount","recipientAmount"],"additionalProperties":false},"OrchestrationNetworkCost":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["solana_associated_token_account"]},"nativeAmount":{"type":"string"},"nativeAsset":{"type":"string","enum":["SOL"]},"amount":{"type":"string"},"asset":{"type":"string"},"assumption":{"type":"string","enum":["assumed_missing","observed_missing","observed_exists"]}},"required":["type","nativeAmount","nativeAsset","amount","asset","assumption"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["solana_mayan_order_accounts"]},"nativeAmount":{"type":"string"},"nativeAsset":{"type":"string","enum":["SOL"]},"amount":{"type":"string"},"asset":{"type":"string","enum":["USDC"]}},"required":["type","nativeAmount","nativeAsset","amount","asset"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["tron_execution"]},"nativeAmount":{"type":"string"},"nativeAsset":{"type":"string","enum":["TRX"]},"amount":{"type":"string"},"asset":{"type":"string","enum":["TRX"]}},"required":["type","nativeAmount","nativeAsset","amount","asset"],"additionalProperties":false}]},"ShieldedExecutionPolicy":{"type":"object","properties":{"routing":{"type":"string","enum":["best_return"]},"allowedProviders":{"type":"array","items":{"type":"string","enum":["near-intents","hyperunit"]},"minItems":1,"maxItems":2},"maxEstimatedSettlementSeconds":{"type":"integer","exclusiveMinimum":0,"minimum":-9007199254740991,"maximum":9007199254740991}},"additionalProperties":false},"ShieldedExecution":{"type":"object","properties":{"policy":{"$ref":"#/components/schemas/ShieldedExecutionPolicy"},"quotedProvider":{"type":"string","enum":["near-intents","hyperunit"]},"eligibleProviders":{"type":"array","items":{"type":"string","enum":["near-intents","hyperunit"]},"minItems":1,"maxItems":2},"estimatedSettlementSeconds":{"type":"integer","exclusiveMinimum":0},"providerLocked":{"type":"boolean","enum":[false]}},"required":["policy","quotedProvider","eligibleProviders","estimatedSettlementSeconds","providerLocked"],"additionalProperties":false},"ShieldedDestinationQuoteExecution":{"type":"object","properties":{"policy":{"$ref":"#/components/schemas/ShieldedExecutionPolicy"},"quotedProvider":{"type":"string","enum":["near-intents","hyperunit"]},"eligibleProviders":{"type":"array","items":{"type":"string","enum":["near-intents","hyperunit"]},"minItems":1,"maxItems":2},"estimatedSettlementSeconds":{"type":"integer","exclusiveMinimum":0},"providerLocked":{"type":"boolean","enum":[true],"description":"Executable outbound quote freezes the terminal ZEC provider."}},"required":["policy","quotedProvider","eligibleProviders","estimatedSettlementSeconds","providerLocked"],"additionalProperties":false},"ShieldedFunding":{"type":"object","properties":{"senderVisibility":{"type":"string","enum":["shielded"],"description":"Receipt proof does not identify the sender or originating wallet software."},"sourceHistoryScreening":{"type":"string","enum":["unavailable"],"description":"Hidden source history is unavailable. Screening of visible counterparties is separate from receipt verification."},"type":{"type":"string","enum":["zcash_shielded"]},"version":{"anyOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]}]},"amountMode":{"type":"string","enum":["actual-input"]},"pricing":{"type":"string","enum":["market-at-funding"]},"network":{"type":"string","enum":["mainnet"]},"receiverPool":{"type":"string","enum":["orchard"]},"address":{"type":"string"},"amount":{"type":"string"},"payBy":{"type":"string","format":"date-time","description":"30-minute funding deadline, also returned as expiresAt. This does not extend price validity."},"requiredConfirmations":{"type":"integer","exclusiveMinimum":0},"refundAddress":{"type":"string"},"refundFeePolicy":{"type":"string","enum":["actual_network_cost_up_to_per_transaction_cap"]},"maxSourceFeeZats":{"type":"string"},"maxRefundFeeZats":{"type":"string","description":"Maximum network cost in zatoshis for each refund transaction; multiple refund transactions may each incur this cap."}},"required":["senderVisibility","sourceHistoryScreening","type","version","network","receiverPool","address","amount","payBy","requiredConfirmations","refundAddress","refundFeePolicy","maxSourceFeeZats","maxRefundFeeZats"],"additionalProperties":false,"oneOf":[{"properties":{"version":{"enum":[1]}},"not":{"anyOf":[{"required":["amountMode"]},{"required":["pricing"]}]}},{"properties":{"version":{"enum":[2]}},"required":["amountMode","pricing"]}]},"ShieldedDestinationDelivery":{"type":"object","properties":{"mode":{"type":"string","enum":["shielded"]},"recipientAddress":{"type":"string","minLength":1},"feeReserveZats":{"type":"string","pattern":"^(0|[1-9][0-9]{0,77})$"},"requiredConfirmations":{"type":"integer","minimum":1,"maximum":10000}},"required":["mode","feeReserveZats","requiredConfirmations"],"additionalProperties":false,"description":"Customer shielded delivery terms. feeReserveZats is already deducted from estimatedOut; requiredConfirmations is the final outbound transaction depth. recipientAddress, when supplied, is the original customer UA, never internal custody."},"OrchestrationEstimateResponse":{"type":"object","properties":{"delivery":{"$ref":"#/components/schemas/ShieldedDestinationDelivery"},"destinationPaymentMode":{"type":"string","enum":["shielded"],"description":"Explicit shielded destination acknowledgement; omission must never acknowledge shielded delivery."},"sourcePaymentMode":{"type":"string","enum":["shielded"]},"priceValidUntil":{"type":"string","format":"date-time","description":"Indicative pricing deadline, distinct from the source funding expiry. Shielded execution must preserve the frozen net recipient minimum."},"execution":{"$ref":"#/components/schemas/ShieldedExecution"},"amountMode":{"type":"string","enum":["exact_in","exact_out"]},"targetAmountOut":{"type":"string"},"requiredAmountIn":{"type":"string"},"maxAcceptedAmountIn":{"type":"string"},"inputBufferBps":{"type":"integer"},"deliveryMode":{"type":"string","enum":["fixed","variable"]},"estimatedOut":{"type":"string","description":"Estimated net recipient amount in destination smallest units."},"minimumAmountOut":{"type":"string","description":"Enforced net recipient minimum when supplied by this route."},"lightningDeliveryFeeReserveSats":{"type":"string","description":"Conservative Lightning delivery reserve already deducted from estimatedOut; not an actual fee."},"feeAmount":{"type":"string"},"roundingFeeAmount":{"type":"string"},"feeBps":{"type":"integer"},"totalFeeAmount":{"type":"string"},"sweepFeeAmount":{"type":"string"},"networkCostAmount":{"type":"string","description":"Quoted network cost in smallest units of networkCostAsset."},"networkCostAsset":{"type":"string","description":"Asset used to pay the quoted network cost."},"networkCostRequired":{"type":"boolean","description":"Whether the quoted network cost must be paid."},"networkCosts":{"type":"array","items":{"$ref":"#/components/schemas/OrchestrationNetworkCost"},"description":"Itemized network costs and quote-time assumptions."},"appFeeAmount":{"type":"string"},"appFeePlatformCutAmount":{"type":"string"},"appFees":{"type":"array","items":{"$ref":"#/components/schemas/OrchestrationAppFeeQuote"}},"feeAsset":{"type":"string"},"feeAssetDetails":{"$ref":"#/components/schemas/PublicAssetDetails"},"feeAmountUsd":{"type":"string"},"totalFeeAmountUsd":{"type":"string"},"route":{"type":"array","items":{"type":"string"}},"minAmountOut":{"type":"string","description":"Unlisted destinations only: the least amount of the token, in its smallest units, the recipient receives when the swap succeeds. Enforced on chain at the recipient."},"fallback":{"$ref":"#/components/schemas/UnlistedFallback"},"source":{"$ref":"#/components/schemas/PublicAssetDetails"},"destination":{"$ref":"#/components/schemas/PublicAssetDetails"}},"required":["estimatedOut","feeAmount","feeBps","feeAsset","route","source","destination"],"additionalProperties":false,"allOf":[{"anyOf":[{"not":{"required":["destinationPaymentMode"]},"properties":{"execution":{"$ref":"#/components/schemas/ShieldedExecution"}}},{"required":["destinationPaymentMode","delivery","execution","priceValidUntil"],"properties":{"execution":{"$ref":"#/components/schemas/ShieldedExecution"},"amountMode":{"enum":["exact_in"]},"deliveryMode":{"enum":["variable"]}},"not":{"anyOf":[{"required":["funding"]},{"required":["sourcePaymentMode"]},{"required":["flexibleAmount"]}]}}]}]},"ResolvedTokenAddressResponse":{"type":"object","properties":{"asset":{"allOf":[{"$ref":"#/components/schemas/PublicAssetDetails"},{"type":"object","properties":{"listing":{"type":"string","enum":["listed","unlisted"]}},"required":["listing"]}]},"destination":{"type":"boolean","description":"Whether this caller may request the token as destinationAsset."},"source":{"type":"boolean","description":"Whether this caller may request the token as sourceAsset."}},"required":["asset","destination","source"],"additionalProperties":false},"OrchestrationQuoteRequest":{"type":"object","properties":{"sourcePaymentMode":{"type":"string","enum":["default","shielded"],"description":"Opt in to Orchard funding for zcash:ZEC, exact_in and variable only. Omitted/default preserves transparent funding. Requires an admitted partner and refund address."},"destinationPaymentMode":{"type":"string","enum":["default","shielded"],"description":"Opt-in for native zcash:ZEC exact_in variable shielded delivery to a mainnet Unified Address with an Orchard receiver. Omitted/default leaves destination delivery unchanged. Unsupported combinations must be rejected, including same-asset ZEC and combined shielded source/destination. Available to authenticated partners and appropriately scoped client keys. Changing the selector requires a new idempotency key."},"executionPolicy":{"allOf":[{"$ref":"#/components/schemas/ShieldedExecutionPolicy"},{"description":"Provider policy for explicit shielded source or destination. near-intents and hyperunit only; ignored when both payment modes are omitted/default."}]},"sourceChain":{"$ref":"#/components/schemas/Chain"},"sourceAsset":{"$ref":"#/components/schemas/SourceAssetInput"},"destinationChain":{"$ref":"#/components/schemas/Chain"},"destinationAsset":{"$ref":"#/components/schemas/DestinationAssetInput"},"amount":{"type":"string","pattern":"^[0-9]+$","description":"Amount in smallest units of the source asset, or destination asset for exact_out; stablecoin exact_out amounts require whole cents."},"amountMode":{"type":"string","enum":["exact_in","exact_out"],"description":"exact_out pins the destination amount and requires whole cents for stablecoins."},"deliveryMode":{"type":"string","enum":["variable","fixed"],"description":"Fixed-output quotes require exact_in, an eligible route, and partner approval. A route accepts fixed only where /v2/orchestration/routes reports fixedEligible (fixedTo); other routes return 400 fixed_delivery_unsupported_route. Fixed estimates are indicative; quotes validate exact-output affordability before returning deposit instructions. Fixed stablecoin routes to Solana USDC include recipient token-account creation costs upfront and preserve the quoted payout."},"flexibleAmount":{"type":"boolean","description":"lightning:BTC exact-in variable only: mint an amountless invoice. `amount` prices an indicative size; the order runs on whatever amount is paid."},"descriptionHash":{"type":"string","pattern":"^[0-9a-fA-F]{64}$","description":"lightning:BTC sources only: SHA-256 hex of your LNURL-pay metadata string. The minted BOLT11 carries it as the description hash (h tag) instead of a memo, for wallets that still verify LUD-06. Rejected on other sources."},"includeCalldata":{"type":"boolean","description":"Include transaction calldata to fund the order. Supported for EVM native and ERC-20 sources only; unsupported sources return calldata_unsupported_source. Defaults to false."},"recipientAddress":{"type":"string","minLength":1,"description":"Destination recipient; use the owner address for Solana tokens, or a Lightning address or compatible BOLT11 invoice for Lightning. A BOLT11 invoice needs at least 20 seconds of life left when quoted: an expired invoice returns 400 destination_bolt11_expired, and one with less time left returns 400 invoice_expiring_soon. Fund quotes for short-lived invoices immediately."},"refundChain":{"$ref":"#/components/schemas/Chain"},"refundAddress":{"type":"string","minLength":1,"description":"Source-chain refund address where required by the route; sanctioned addresses are rejected. Required when sourceAsset is an unlisted token (invalid_request otherwise): a deposit that cannot be sold is refunded there in the source token. For default zcash:ZEC funding, a supplied nonblank refund address must be a checksum-valid mainnet transparent t1 or t3 address. With sourcePaymentMode=shielded, refundAddress is required and accepts explicit mainnet t1/t3 or a supported Orchard Unified Address validated by custody before publication. Transparent refunds expose the return output; a Unified refund never falls back to a transparent receiver. TEX refunds are unsupported. Invalid transparent targets return invalid_refund_address."},"slippageBps":{"type":"integer","minimum":0,"maximum":1000,"description":"Slippage tolerance in basis points, subject to the route minimum."},"appFees":{"type":"array","items":{"$ref":"#/components/schemas/OrchestrationAppFeeRequest"},"minItems":1,"maxItems":16,"description":"Inline app fees, requiring a server key or dashboard session."},"affiliateErrorMode":{"type":"string","enum":["legacy","specific"],"description":"Opt in to affiliate_not_found / affiliate_disabled for registered affiliate lookup failures. Omitted or legacy preserves invalid_request. HTTP 400 in either mode. Changing this field requires a new idempotency key."},"affiliateId":{"type":"string","description":"Registered affiliate ID for accrued fees, also accepted from client keys."},"affiliateIds":{"type":"array","items":{"$ref":"#/components/schemas/OrchestrationAffiliateIdEntry"},"minItems":1,"maxItems":16,"description":"Registered affiliate IDs or fee overrides; mutually exclusive with appFees, with overrides requiring a server key or dashboard session."},"tag":{"type":["string","null"],"pattern":"^[A-Za-z0-9._:-]{1,64}$","description":"Your own reporting label, such as an integrator ID. Every order this quote funds carries it, and the dashboard filters and groups by it. Self-reported: anyone holding the key that creates the quote chooses it."}},"required":["sourceChain","sourceAsset","destinationChain","destinationAsset","amount","recipientAddress"],"description":"Unknown top-level fields are ignored rather than rejected.","allOf":[{"not":{"allOf":[{"properties":{"sourceAsset":{"const":"TON"}},"required":["sourceAsset"]},{"properties":{"sourceChain":{"not":{"const":"ton"}}},"required":["sourceChain"]}]}},{"not":{"allOf":[{"properties":{"destinationAsset":{"const":"TON"}},"required":["destinationAsset"]},{"properties":{"destinationChain":{"not":{"const":"ton"}}},"required":["destinationChain"]}]}},{"anyOf":[{"not":{"required":["destinationPaymentMode"],"properties":{"destinationPaymentMode":{"enum":["shielded"]}}}},{"required":["destinationChain","destinationAsset"],"properties":{"destinationChain":{"enum":["zcash"]},"destinationAsset":{"enum":["ZEC"]},"amountMode":{"enum":["exact_in"]},"deliveryMode":{"enum":["variable"]},"flexibleAmount":{"enum":[false]},"sourcePaymentMode":{"enum":["default"]}},"not":{"required":["sourceChain","sourceAsset"],"properties":{"sourceChain":{"enum":["zcash"]},"sourceAsset":{"enum":["ZEC"]}}}}]}]},"OrchestrationOfframpRequest":{"type":"object","properties":{"sourceChain":{"$ref":"#/components/schemas/Chain"},"sourceAsset":{"$ref":"#/components/schemas/SourceAssetInput"},"amount":{"type":"string","pattern":"^[0-9]+$","description":"Amount in smallest units of the source asset."},"includeCalldata":{"type":"boolean","description":"Include transaction calldata to fund the order. Supported for EVM native and ERC-20 sources only; unsupported sources return calldata_unsupported_source. Defaults to false."},"recipientAddress":{"type":"string","minLength":1,"description":"Cash App username (username or $username), or Lightning address (username@domain). Cash App usernames resolve to username@cash.app. BOLT11 invoices and URLs are not accepted."},"refundChain":{"$ref":"#/components/schemas/Chain"},"refundAddress":{"type":"string","minLength":1,"description":"Required refund address on the source chain, or the supplied refundChain."},"slippageBps":{"type":"integer","minimum":0,"maximum":1000,"description":"Slippage tolerance in basis points, subject to the route minimum."},"appFees":{"type":"array","items":{"$ref":"#/components/schemas/OrchestrationAppFeeRequest"},"minItems":1,"maxItems":16,"description":"Inline app fees, requiring a server key or dashboard session."},"affiliateErrorMode":{"type":"string","enum":["legacy","specific"],"description":"Opt in to affiliate_not_found / affiliate_disabled for registered affiliate lookup failures. Omitted or legacy preserves invalid_request. HTTP 400 in either mode. Changing this field requires a new idempotency key."},"affiliateId":{"type":"string","description":"Registered affiliate ID for accrued fees, also accepted from client keys."},"affiliateIds":{"type":"array","items":{"$ref":"#/components/schemas/OrchestrationAffiliateIdEntry"},"minItems":1,"maxItems":16,"description":"Registered affiliate IDs or fee overrides; mutually exclusive with appFees, with overrides requiring a server key or dashboard session."},"tag":{"type":["string","null"],"pattern":"^[A-Za-z0-9._:-]{1,64}$","description":"Your own reporting label, such as an integrator ID. Every order this quote funds carries it, and the dashboard filters and groups by it. Self-reported: anyone holding the key that creates the quote chooses it."}},"required":["sourceChain","sourceAsset","amount","recipientAddress","refundAddress"],"additionalProperties":false,"description":"Exact-in variable Lightning payout. Unknown fields are rejected.","allOf":[{"not":{"allOf":[{"properties":{"sourceAsset":{"const":"TON"}},"required":["sourceAsset"]},{"properties":{"sourceChain":{"not":{"const":"ton"}}},"required":["sourceChain"]}]}}]},"OrchestrationQuoteResponse":{"type":"object","properties":{"delivery":{"type":"object","properties":{"mode":{"type":"string","enum":["shielded"]},"recipientAddress":{"type":"string","minLength":1},"feeReserveZats":{"type":"string","pattern":"^(0|[1-9][0-9]{0,77})$"},"requiredConfirmations":{"type":"integer","minimum":1,"maximum":10000}},"required":["mode","recipientAddress","feeReserveZats","requiredConfirmations"],"additionalProperties":false},"destinationPaymentMode":{"type":"string","enum":["shielded"],"description":"Explicit shielded destination acknowledgement; omission must never acknowledge shielded delivery."},"sourcePaymentMode":{"type":"string","enum":["shielded"]},"priceValidUntil":{"type":"string","format":"date-time","description":"Indicative pricing deadline, distinct from the source funding expiry. Shielded execution must preserve the frozen net recipient minimum."},"execution":{"anyOf":[{"$ref":"#/components/schemas/ShieldedExecution"},{"$ref":"#/components/schemas/ShieldedDestinationQuoteExecution"}]},"funding":{"$ref":"#/components/schemas/ShieldedFunding"},"quoteId":{"type":"string"},"reviewedAssets":{"type":"array","items":{"$ref":"#/components/schemas/ReviewedAssetIdentity"},"minItems":1,"maxItems":32,"description":"Exact immutable reviewed token identities frozen by the native quote. Omitted for legacy or invalid snapshots; caller metadata cannot set these pins."},"depositAddress":{"type":"string"},"transaction":{"type":"object","properties":{"chainId":{"type":"integer","exclusiveMinimum":0},"to":{"type":"string","description":"Token contract for ERC-20; deposit address for native input."},"data":{"type":"string","description":"ERC-20 transfer(depositAddress, amountIn) calldata, or 0x for native input."},"value":{"type":"string","description":"Native value in smallest units: amountIn for native input, otherwise 0."}},"required":["chainId","to","data","value"],"description":"Unsigned deposit transfer, returned only with includeCalldata=true on supported EVM sources. No approval is needed. This funds the deposit; it does not execute the swap."},"depositMemo":{"type":"string","description":"Memo or tag required with the deposit when present."},"lightningReceiveRequestId":{"type":"string"},"flexibleAmount":{"type":"boolean","enum":[true],"description":"The invoice is amountless. amountIn and estimatedOut price the indicative amount and are rescaled to the amount actually paid."},"amountMode":{"type":"string","enum":["exact_in","exact_out"]},"targetAmountOut":{"type":"string"},"requiredAmountIn":{"type":"string"},"maxAcceptedAmountIn":{"type":"string"},"inputBufferBps":{"type":"integer"},"deliveryMode":{"type":"string","enum":["fixed","variable"]},"priceLockMode":{"type":"string","enum":["strict_requote","approval_required"],"description":"Action required when the locked price can no longer be honored."},"indicativeMinAmountOut":{"type":"string","description":"Indicative minimum for the requested input. Actual-input shielded funding is repriced at market before commitment."},"lockedMinAmountOut":{"type":"string","description":"Minimum locked destination amount in smallest units."},"amountIn":{"type":"string"},"estimatedOut":{"type":"string","description":"Estimated net recipient amount in destination smallest units."},"minimumAmountOut":{"type":"string","description":"Enforced net recipient minimum when supplied by this route."},"lightningDeliveryFeeReserveSats":{"type":"string","description":"Conservative Lightning delivery reserve already deducted from estimatedOut; not an actual fee."},"feeAmount":{"type":"string"},"roundingFeeAmount":{"type":"string"},"totalFeeAmount":{"type":"string"},"networkCostAmount":{"type":"string","description":"Quoted network cost in smallest units of networkCostAsset."},"networkCostAsset":{"type":"string","description":"Asset used to pay the quoted network cost."},"networkCostRequired":{"type":"boolean","description":"Whether the quoted network cost must be paid."},"networkCosts":{"type":"array","items":{"$ref":"#/components/schemas/OrchestrationNetworkCost"},"description":"Itemized network costs and quote-time assumptions."},"sweepFeeAmount":{"type":"string"},"appFeeAmount":{"type":"string"},"appFeePlatformCutAmount":{"type":"string"},"appFees":{"type":"array","items":{"$ref":"#/components/schemas/OrchestrationAppFeeQuote"}},"feeAsset":{"type":"string"},"feeAssetDetails":{"$ref":"#/components/schemas/PublicAssetDetails"},"feeAmountUsd":{"type":"string"},"totalFeeAmountUsd":{"type":"string"},"feeBps":{"type":"integer"},"route":{"type":"array","items":{"type":"string"}},"minAmountOut":{"type":"string","description":"Unlisted destinations only: the least amount of the token, in its smallest units, the recipient receives when the swap succeeds. Enforced on chain at the recipient."},"fallback":{"$ref":"#/components/schemas/UnlistedFallback"},"source":{"$ref":"#/components/schemas/PublicAssetDetails"},"destination":{"$ref":"#/components/schemas/PublicAssetDetails"},"expiresAt":{"type":"string"},"tag":{"type":["string","null"],"description":"The request's tag; null when none was sent."},"readToken":{"type":"string","description":"Client-key read token for this quote and its order, including private ZeroConf outcomes."}},"required":["quoteId","depositAddress","amountIn","estimatedOut","feeAmount","totalFeeAmount","feeAsset","feeBps","route","expiresAt"],"additionalProperties":false,"allOf":[{"anyOf":[{"not":{"required":["destinationPaymentMode"]},"properties":{"execution":{"$ref":"#/components/schemas/ShieldedExecution"}}},{"required":["destinationPaymentMode","delivery","execution","priceValidUntil"],"properties":{"execution":{"$ref":"#/components/schemas/ShieldedDestinationQuoteExecution"},"amountMode":{"enum":["exact_in"]},"deliveryMode":{"enum":["variable"]}},"not":{"anyOf":[{"required":["funding"]},{"required":["sourcePaymentMode"]},{"required":["flexibleAmount"]}]}}]},{"anyOf":[{"not":{"required":["funding"]}},{"required":["funding","lockedMinAmountOut"],"properties":{"funding":{"properties":{"version":{"enum":[1]}},"required":["version"]},"lockedMinAmountOut":{"type":"string","pattern":"^[1-9][0-9]{0,77}$"}},"not":{"required":["indicativeMinAmountOut"]}},{"required":["funding","indicativeMinAmountOut"],"properties":{"funding":{"properties":{"version":{"enum":[2]}},"required":["version"]},"indicativeMinAmountOut":{"type":"string","pattern":"^[1-9][0-9]{0,77}$"}},"not":{"required":["lockedMinAmountOut"]}}]}]},"OrchestrationSubmitRequest":{"type":"object","properties":{"quoteId":{"type":"string","minLength":1},"txHash":{"type":"string","minLength":1,"description":"Source transaction reference; native Hedera transfers require their native transaction ID."},"sourceAddress":{"type":"string","minLength":1,"description":"Expected source-chain sender; a verified mismatch pauses the order for review."},"sparkTxHash":{"type":"string","minLength":1},"sourceSparkAddress":{"type":"string","minLength":1,"description":"Expected Spark sender address; sanctioned addresses are rejected."},"bitcoinTxid":{"type":"string","minLength":1},"bitcoinVout":{"type":"integer","minimum":0},"lightningReceiveRequestId":{"type":"string","minLength":1}},"required":["quoteId"],"description":"Source-specific deposit references; unknown top-level fields are ignored."},"OrchestrationSubmitResponse":{"type":"object","properties":{"orderId":{"type":"string"},"status":{"type":"string","description":"Partner-visible order status. Internal paused orders are reported as processing."}},"required":["orderId","status"],"additionalProperties":false},"OrchestrationOnrampRequest":{"type":"object","properties":{"destinationChain":{"$ref":"#/components/schemas/Chain"},"destinationAsset":{"$ref":"#/components/schemas/AssetInput"},"recipientAddress":{"type":"string","minLength":1,"description":"Destination recipient; use the owner address for Solana tokens; sanctioned addresses are rejected."},"amount":{"type":"string","pattern":"^[0-9]+$","description":"Amount in smallest units; exact_out uses the destination asset and whole cents for stablecoins; mutually exclusive with amountFiatUsd."},"amountFiatUsd":{"type":"string","pattern":"^(?:0|[1-9][0-9]*)(?:\\.[0-9]{1,2})?$","description":"USD amount paid through Cash App or Strike, converted to sats at request time; read current bounds from /v1/orchestration/limits."},"amountMode":{"type":"string","enum":["exact_in","exact_out"],"description":"exact_out pins the destination amount and requires whole cents for stablecoins."},"deliveryMode":{"type":"string","enum":["variable","fixed"],"description":"Requested delivery mode; fixed applies only to eligible exact_in onramps and is echoed when applied."},"slippageBps":{"type":"integer","minimum":0,"maximum":1000,"description":"Slippage tolerance in basis points, subject to the route minimum."},"descriptionHash":{"type":"string","pattern":"^[0-9a-fA-F]{64}$","description":"SHA-256 hex of your LNURL-pay metadata string. The Lightning invoice carries it as the description hash (h tag) instead of the Cash App memo, for wallets that still verify LUD-06."},"refundAddress":{"type":"string","minLength":1,"description":"Lightning address or amountless BOLT11 refund invoice; unsupported values appear in ignoredFields, and pre-swap failures without a target report refund_address_missing."},"refundChain":{"allOf":[{"$ref":"#/components/schemas/Chain"},{"description":"Lightning refund chain, inferred when omitted; unsupported values appear in ignoredFields."}]},"appFees":{"type":"array","items":{"$ref":"#/components/schemas/OrchestrationAppFeeRequest"},"minItems":1,"maxItems":16,"description":"Inline app fees, requiring a server key or dashboard session."},"affiliateId":{"type":"string","description":"Registered affiliate ID for accrued fees, also accepted from client keys."},"affiliateIds":{"type":"array","items":{"$ref":"#/components/schemas/OrchestrationAffiliateIdEntry"},"minItems":1,"maxItems":16,"description":"Registered affiliate IDs or fee overrides; mutually exclusive with appFees, with overrides requiring a server key or dashboard session."},"tag":{"type":["string","null"],"pattern":"^[A-Za-z0-9._:-]{1,64}$","description":"Your own reporting label, such as an integrator ID. The order carries it, and the dashboard filters and groups by it. Self-reported: anyone holding the key that creates the order chooses it."}},"required":["destinationChain","destinationAsset","recipientAddress"],"description":"Unsupported top-level and refund fields are ignored and returned in ignoredFields.","allOf":[{"not":{"allOf":[{"properties":{"destinationAsset":{"const":"TON"}},"required":["destinationAsset"]},{"properties":{"destinationChain":{"not":{"const":"ton"}}},"required":["destinationChain"]}]}}]},"PaymentLinks":{"type":"object","properties":{"cashApp":{"type":"string","format":"uri"},"shortUrl":{"type":"string","format":"uri"}},"required":["cashApp"],"additionalProperties":false},"OrchestrationOnrampResponse":{"type":"object","properties":{"delivery":{"type":"object","properties":{"mode":{"type":"string","enum":["shielded"]},"recipientAddress":{"type":"string","minLength":1},"feeReserveZats":{"type":"string","pattern":"^(0|[1-9][0-9]{0,77})$"},"requiredConfirmations":{"type":"integer","minimum":1,"maximum":10000}},"required":["mode","recipientAddress","feeReserveZats","requiredConfirmations"],"additionalProperties":false},"destinationPaymentMode":{"type":"string","enum":["shielded"],"description":"Explicit shielded destination acknowledgement; omission must never acknowledge shielded delivery."},"sourcePaymentMode":{"type":"string","enum":["shielded"]},"priceValidUntil":{"type":"string","format":"date-time","description":"Indicative pricing deadline, distinct from the source funding expiry. Shielded execution must preserve the frozen net recipient minimum."},"execution":{"anyOf":[{"$ref":"#/components/schemas/ShieldedExecution"},{"$ref":"#/components/schemas/ShieldedDestinationQuoteExecution"}]},"funding":{"$ref":"#/components/schemas/ShieldedFunding"},"quoteId":{"type":"string"},"reviewedAssets":{"type":"array","items":{"$ref":"#/components/schemas/ReviewedAssetIdentity"},"minItems":1,"maxItems":32,"description":"Exact immutable reviewed token identities frozen by the native quote. Omitted for legacy or invalid snapshots; caller metadata cannot set these pins."},"depositAddress":{"type":"string"},"transaction":{"type":"object","properties":{"chainId":{"type":"integer","exclusiveMinimum":0},"to":{"type":"string","description":"Token contract for ERC-20; deposit address for native input."},"data":{"type":"string","description":"ERC-20 transfer(depositAddress, amountIn) calldata, or 0x for native input."},"value":{"type":"string","description":"Native value in smallest units: amountIn for native input, otherwise 0."}},"required":["chainId","to","data","value"],"description":"Unsigned deposit transfer, returned only with includeCalldata=true on supported EVM sources. No approval is needed. This funds the deposit; it does not execute the swap."},"depositMemo":{"type":"string","description":"Memo or tag required with the deposit when present."},"lightningReceiveRequestId":{"type":"string"},"flexibleAmount":{"type":"boolean","enum":[true],"description":"The invoice is amountless. amountIn and estimatedOut price the indicative amount and are rescaled to the amount actually paid."},"amountMode":{"type":"string","enum":["exact_in","exact_out"]},"targetAmountOut":{"type":"string"},"requiredAmountIn":{"type":"string"},"maxAcceptedAmountIn":{"type":"string"},"inputBufferBps":{"type":"integer"},"deliveryMode":{"type":"string","enum":["fixed","variable"]},"priceLockMode":{"type":"string","enum":["strict_requote","approval_required"],"description":"Action required when the locked price can no longer be honored."},"indicativeMinAmountOut":{"type":"string","description":"Indicative minimum for the requested input. Actual-input shielded funding is repriced at market before commitment."},"lockedMinAmountOut":{"type":"string","description":"Minimum locked destination amount in smallest units."},"amountIn":{"type":"string"},"estimatedOut":{"type":"string","description":"Estimated net recipient amount in destination smallest units."},"minimumAmountOut":{"type":"string","description":"Enforced net recipient minimum when supplied by this route."},"lightningDeliveryFeeReserveSats":{"type":"string","description":"Conservative Lightning delivery reserve already deducted from estimatedOut; not an actual fee."},"feeAmount":{"type":"string"},"roundingFeeAmount":{"type":"string"},"totalFeeAmount":{"type":"string"},"networkCostAmount":{"type":"string","description":"Quoted network cost in smallest units of networkCostAsset."},"networkCostAsset":{"type":"string","description":"Asset used to pay the quoted network cost."},"networkCostRequired":{"type":"boolean","description":"Whether the quoted network cost must be paid."},"networkCosts":{"type":"array","items":{"$ref":"#/components/schemas/OrchestrationNetworkCost"},"description":"Itemized network costs and quote-time assumptions."},"sweepFeeAmount":{"type":"string"},"appFeeAmount":{"type":"string"},"appFeePlatformCutAmount":{"type":"string"},"appFees":{"type":"array","items":{"$ref":"#/components/schemas/OrchestrationAppFeeQuote"}},"feeAsset":{"type":"string"},"feeAssetDetails":{"$ref":"#/components/schemas/PublicAssetDetails"},"feeAmountUsd":{"type":"string"},"totalFeeAmountUsd":{"type":"string"},"feeBps":{"type":"integer"},"route":{"type":"array","items":{"type":"string"}},"minAmountOut":{"type":"string","description":"Unlisted destinations only: the least amount of the token, in its smallest units, the recipient receives when the swap succeeds. Enforced on chain at the recipient."},"fallback":{"$ref":"#/components/schemas/UnlistedFallback"},"source":{"$ref":"#/components/schemas/PublicAssetDetails"},"destination":{"$ref":"#/components/schemas/PublicAssetDetails"},"expiresAt":{"type":"string"},"tag":{"type":["string","null"],"description":"The request's tag; null when none was sent."},"readToken":{"type":"string","description":"Client-key read token for this quote and its order, including private ZeroConf outcomes."},"orderId":{"type":"string"},"paymentLinks":{"$ref":"#/components/schemas/PaymentLinks"},"effectiveSlippageBps":{"type":"integer","description":"Slippage tolerance applied to the order, in basis points."},"ignoredFields":{"type":"array","items":{"type":"string"},"description":"Names of ignored request fields, including unsupported refundAddress or refundChain values."}},"required":["quoteId","depositAddress","amountIn","estimatedOut","feeAmount","totalFeeAmount","feeAsset","feeBps","route","expiresAt","orderId"],"additionalProperties":false},"OrchestrationZeroconfAcceptRequest":{"type":"object","properties":{"orderId":{"type":"string","minLength":1}},"required":["orderId"],"description":"Unknown top-level fields are ignored rather than rejected."},"OrchestrationZeroconfDeclineRequest":{"type":"object","properties":{"orderId":{"type":"string","minLength":1},"reason":{"type":"string","minLength":1,"maxLength":300}},"required":["orderId"],"description":"Unknown top-level fields are ignored rather than rejected."},"QuoteSummary":{"type":"object","properties":{"id":{"type":"string"},"reviewedAssets":{"type":"array","items":{"$ref":"#/components/schemas/ReviewedAssetIdentity"},"minItems":1,"maxItems":32,"description":"Exact immutable reviewed token identities frozen by the native quote. Omitted for legacy or invalid snapshots; caller metadata cannot set these pins."},"kind":{"type":"string"},"sourceChain":{"$ref":"#/components/schemas/Chain"},"sourceAsset":{"type":"string"},"destinationChain":{"$ref":"#/components/schemas/Chain"},"destinationAsset":{"type":"string"},"amountIn":{"type":"string"},"estimatedOut":{"type":"string","description":"Estimated net recipient amount in destination smallest units."},"minimumAmountOut":{"type":"string","description":"Enforced net recipient minimum when supplied by this route."},"lightningDeliveryFeeReserveSats":{"type":"string","description":"Conservative Lightning delivery reserve already deducted from estimatedOut; not an actual fee."},"feeBps":{"type":"integer"},"feeAmount":{"type":"string"},"feeAsset":{"type":"string"},"feeAssetDetails":{"$ref":"#/components/schemas/PublicAssetDetails"},"feeAmountUsd":{"type":"string"},"roundingFeeAmount":{"type":"string"},"depositAddress":{"type":["string","null"]},"recipientAddress":{"type":"string"},"slippageBps":{"type":"integer"},"expiresAt":{"type":"string"},"expired":{"type":"boolean"},"createdAt":{"type":"string"}},"required":["id","kind","sourceChain","sourceAsset","destinationChain","destinationAsset","amountIn","estimatedOut","feeBps","feeAmount","roundingFeeAmount","depositAddress","recipientAddress","slippageBps","expiresAt","expired","createdAt"],"additionalProperties":false},"QuoteFundingOutcome":{"type":"object","properties":{"id":{"type":"string"},"quoteId":{"type":"string"},"state":{"type":"string","enum":["refund_reported","needs_review"]},"provider":{"type":"string","enum":["near","relay"]},"providerStatus":{"type":"string"},"reason":{"type":"string","enum":["fee_estimation_failed","provider_refund","provider_failure"]},"source":{"type":"object","properties":{"chain":{"type":"string"},"asset":{"type":"string"}},"required":["chain","asset"]},"destination":{"type":"object","properties":{"chain":{"type":"string"},"asset":{"type":"string"}},"required":["chain","asset"]},"quotedAmountIn":{"type":["string","null"],"pattern":"^\\d{1,78}$"},"quotedEstimatedOut":{"type":["string","null"],"pattern":"^\\d{1,78}$"},"providerReported":{"type":"object","properties":{"depositedAmount":{"type":["string","null"],"pattern":"^\\d{1,78}$"},"refundedAmount":{"type":["string","null"],"pattern":"^\\d{1,78}$"}},"required":["depositedAmount","refundedAmount"]},"providerOriginTxHashes":{"type":"array","items":{"type":"string"},"maxItems":16},"refundDestination":{"type":"string","enum":["customer_provided","internal_recovery","unknown"]},"customerRefundVerified":{"type":"boolean","enum":[false]},"observedAt":{"type":"string","format":"date-time"}},"required":["id","quoteId","state","provider","providerStatus","reason","source","destination","quotedAmountIn","quotedEstimatedOut","providerReported","providerOriginTxHashes","refundDestination","customerRefundVerified","observedAt"]},"OrchestrationStatusResponse":{"type":"object","properties":{"order":{"allOf":[{"$ref":"#/components/schemas/OperationRecord"},{"type":["object","null"],"description":"Null when explicit includeFunding or includeShieldedFunding resolves pre-operation funding."}]},"stages":{"type":"array","items":{"$ref":"#/components/schemas/OperationStage"}},"funding":{"type":"array","items":{"$ref":"#/components/schemas/QuoteFundingOutcome"}},"fundingStatus":{"allOf":[{"$ref":"#/components/schemas/ShieldedFundingStatus"},{"description":"Only with includeShieldedFunding=true."}]},"fundingDetails":{"allOf":[{"$ref":"#/components/schemas/ShieldedFundingDetails"},{"description":"Aggregate zatoshi amounts only; no private receipt or transaction identities."}]}},"required":["order","stages"],"additionalProperties":false},"OrchestrationOrderResponse":{"type":"object","properties":{"quote":{"allOf":[{"$ref":"#/components/schemas/QuoteSummary"},{"type":["object","null"],"description":"Null when only a retained provider outcome survives quote cleanup."}]},"order":{"allOf":[{"$ref":"#/components/schemas/OperationRecord"},{"type":["object","null"]}]},"stages":{"type":"array","items":{"$ref":"#/components/schemas/OperationStage"}},"funding":{"type":"array","items":{"$ref":"#/components/schemas/QuoteFundingOutcome"}}},"required":["quote","order","stages"],"additionalProperties":false},"OrchestrationHistoryResponse":{"type":"object","properties":{"orders":{"type":"array","items":{"$ref":"#/components/schemas/OperationRecord"}}},"required":["orders"],"additionalProperties":false},"AffiliateUpsertRequest":{"type":"object","properties":{"feeBps":{"type":"integer","minimum":1,"maximum":9999},"payoutChain":{"$ref":"#/components/schemas/Chain"},"payoutAsset":{"type":"string","minLength":1},"payoutAddress":{"type":"string","minLength":1,"description":"Affiliate payout address; sanctioned addresses are rejected."}},"required":["feeBps","payoutChain","payoutAsset","payoutAddress"],"additionalProperties":false},"AffiliateProfile":{"type":"object","properties":{"affiliateId":{"type":"string"},"feeBps":{"type":"integer","minimum":1,"maximum":9999},"payoutChain":{"allOf":[{"$ref":"#/components/schemas/Chain"},{"type":["string","null"]}]},"payoutAsset":{"type":["string","null"]},"payoutAddress":{"type":["string","null"]},"enabled":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"disabledAt":{"type":["string","null"]}},"required":["affiliateId","feeBps","payoutChain","payoutAsset","payoutAddress","enabled","createdAt","updatedAt"],"additionalProperties":false},"AffiliateUpsertResponse":{"type":"object","properties":{"affiliate":{"$ref":"#/components/schemas/AffiliateProfile"}},"required":["affiliate"],"additionalProperties":false},"AffiliateListResponse":{"type":"object","properties":{"affiliates":{"type":"array","items":{"$ref":"#/components/schemas/AffiliateProfile"}}},"required":["affiliates"],"additionalProperties":false},"AffiliateClaim":{"type":"object","properties":{"id":{"type":"string"},"affiliateId":{"type":"string"},"amount":{"type":"string"},"settlementChain":{"type":"string"},"settlementAsset":{"type":"string"},"payoutChain":{"$ref":"#/components/schemas/Chain"},"payoutAsset":{"type":"string"},"payoutAddress":{"type":"string"},"status":{"type":"string","enum":["processing","completed","failed"]},"txHash":{"type":["string","null"]},"relayRequestId":{"type":["string","null"]},"operationId":{"type":["string","null"]},"errorMessage":{"type":["string","null"]},"nextAttemptAt":{"type":"string"},"attempts":{"type":"integer"},"createdAt":{"type":"string"},"completedAt":{"type":["string","null"]}},"required":["id","affiliateId","amount","settlementChain","settlementAsset","payoutChain","payoutAsset","payoutAddress","status","txHash","relayRequestId","operationId","errorMessage","nextAttemptAt","attempts","createdAt","completedAt"],"additionalProperties":false},"AffiliateClaimCreateRequest":{"type":"object","properties":{"claimBucketId":{"type":"string","pattern":"^[a-f0-9]{64}$","description":"Opaque balance ID returned by affiliate stats. Selects one custody and frozen payout bucket."},"settlementChain":{"type":"string","minLength":1},"settlementAsset":{"type":"string","minLength":1},"payoutChain":{"$ref":"#/components/schemas/Chain"},"payoutAsset":{"type":"string","minLength":1},"payoutAddress":{"type":"string","minLength":1,"description":"Server canonicalizes by trimming leading/trailing whitespace; case is preserved."}},"additionalProperties":false},"AffiliateClaimResponse":{"type":"object","properties":{"claim":{"$ref":"#/components/schemas/AffiliateClaim"}},"required":["claim"],"additionalProperties":false},"AffiliateClaimListResponse":{"type":"object","properties":{"claims":{"type":"array","items":{"$ref":"#/components/schemas/AffiliateClaim"}},"nextOffset":{"type":["integer","null"]}},"required":["claims","nextOffset"],"additionalProperties":false},"WebhookCreateRequest":{"type":"object","properties":{"url":{"type":"string","minLength":1,"description":"Server canonicalizes by trimming leading/trailing whitespace; case is preserved."}},"required":["url"],"description":"Unknown top-level fields are ignored rather than rejected."},"WebhookCreateResponse":{"type":"object","properties":{"webhookId":{"type":"string"},"secret":{"type":"string"}},"required":["webhookId","secret"],"additionalProperties":false},"WebhookEndpoint":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"enabled":{"type":"boolean"},"createdAt":{"type":"string"}},"required":["id","url","enabled","createdAt"],"additionalProperties":false},"WebhookListResponse":{"type":"object","properties":{"webhooks":{"type":"array","items":{"$ref":"#/components/schemas/WebhookEndpoint"}}},"required":["webhooks"],"additionalProperties":false},"LiquidationDestination":{"type":"object","properties":{"chain":{"$ref":"#/components/schemas/Chain"},"asset":{"type":"string"},"address":{"type":"string"}},"required":["chain","asset","address"],"additionalProperties":false},"AddressAppFee":{"type":"object","properties":{"affiliateId":{"type":"string"},"recipient":{"type":"string","minLength":1,"description":"Fee recipient address; sanctioned addresses are rejected."},"feeBps":{"type":"integer","minimum":1,"maximum":9999}},"required":["recipient","feeBps"],"additionalProperties":false},"LiquidationAddressCreateRequest":{"type":"object","properties":{"label":{"type":"string","maxLength":255,"pattern":"^[^\\x00-\\x1F\\x7F]*$"},"destinationChain":{"$ref":"#/components/schemas/Chain"},"destinationAsset":{"type":"string","minLength":1},"destinationAddress":{"type":"string","minLength":1,"description":"Server canonicalizes by trimming leading/trailing whitespace; case is preserved."},"slippageBps":{"type":"integer","minimum":0,"maximum":10000},"feeBps":{"type":"integer","minimum":0,"maximum":9999},"appFees":{"type":"array","items":{"$ref":"#/components/schemas/OrchestrationAppFeeRequest"},"minItems":1,"maxItems":16},"affiliateIds":{"type":"array","items":{"$ref":"#/components/schemas/OrchestrationAffiliateIdEntry"},"minItems":1,"maxItems":16,"description":"Registered affiliate IDs or fee overrides for each deposit; mutually exclusive with appFees, with overrides requiring a server key or dashboard session."}},"required":["destinationChain","destinationAddress"],"description":"Unknown top-level fields are ignored rather than rejected."},"LiquidationAddressRecord":{"type":"object","properties":{"liquidationAddressId":{"type":"string"},"label":{"type":"string"},"sparkAddress":{"type":"string"},"l1DepositAddress":{"type":"string"},"destination":{"$ref":"#/components/schemas/LiquidationDestination"},"feeBps":{"type":"integer"},"slippageBps":{"type":"integer"},"enabled":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"disabledAt":{"type":["string","null"]},"appFees":{"type":"array","items":{"$ref":"#/components/schemas/AddressAppFee"}}},"required":["liquidationAddressId","label","sparkAddress","l1DepositAddress","destination","feeBps","slippageBps","enabled","createdAt"],"additionalProperties":false},"LiquidationAddressListResponse":{"type":"object","properties":{"liquidationAddresses":{"type":"array","items":{"$ref":"#/components/schemas/LiquidationAddressRecord"}}},"required":["liquidationAddresses"],"additionalProperties":false},"LiquidationOrdersResponse":{"type":"object","properties":{"orders":{"type":"array","items":{"$ref":"#/components/schemas/OperationRecord"}},"nextOffset":{"type":["integer","null"]}},"required":["orders","nextOffset"],"additionalProperties":false},"AccumulationDestinationAsset":{"type":"string","enum":["BTC","USDB"]},"AccumulationAddressSubscription":{"type":"object","properties":{"provider":{"type":"string"},"chain":{"type":"string"},"address":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"lastError":{"type":["string","null"]},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["provider","chain","address","status","lastError","createdAt","updatedAt"],"additionalProperties":false},"AccumulationAddressRecord":{"type":"object","properties":{"accumulationAddressId":{"type":"string"},"label":{"type":"string"},"sourceChain":{"$ref":"#/components/schemas/Chain"},"sourceAsset":{"type":"string"},"destinationAsset":{"$ref":"#/components/schemas/AccumulationDestinationAsset"},"recipientSparkAddress":{"type":"string"},"feeBps":{"type":"integer"},"slippageBps":{"type":"integer"},"enabled":{"type":"boolean"},"depositAddress":{"type":["string","null"]},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"disabledAt":{"type":["string","null"]},"subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/AccumulationAddressSubscription"}},"appFees":{"type":"array","items":{"$ref":"#/components/schemas/AddressAppFee"}}},"required":["accumulationAddressId","label","sourceChain","sourceAsset","destinationAsset","recipientSparkAddress","feeBps","slippageBps","enabled","depositAddress","createdAt"],"additionalProperties":false},"AccumulationAddressCreateRequest":{"type":"object","properties":{"label":{"type":"string","maxLength":255,"pattern":"^[^\\x00-\\x1F\\x7F]*$"},"sourceChain":{"$ref":"#/components/schemas/Chain"},"sourceAsset":{"type":"string","minLength":1},"destinationAsset":{"$ref":"#/components/schemas/AccumulationDestinationAsset"},"recipientSparkAddress":{"type":"string","minLength":1,"description":"Server canonicalizes by trimming leading/trailing whitespace; case is preserved."},"feeBps":{"type":"integer","minimum":0,"maximum":9999},"slippageBps":{"type":"integer","minimum":0,"maximum":10000},"appFees":{"type":"array","items":{"$ref":"#/components/schemas/OrchestrationAppFeeRequest"},"minItems":1,"maxItems":16,"description":"Inline fee recipients for each deposit, requiring a server key or dashboard session."},"affiliateId":{"type":"string","description":"Registered affiliate ID for fees on each deposit, also accepted from client keys."},"affiliateIds":{"type":"array","items":{"$ref":"#/components/schemas/OrchestrationAffiliateIdEntry"},"minItems":1,"maxItems":16,"description":"Registered affiliate IDs or fee overrides for each deposit; mutually exclusive with appFees, with overrides requiring a server key or dashboard session."}},"required":["sourceChain","sourceAsset","destinationAsset","recipientSparkAddress"],"description":"Unknown top-level fields are ignored rather than rejected."},"AccumulationAddressCreateResponse":{"allOf":[{"$ref":"#/components/schemas/AccumulationAddressRecord"},{"type":"object","properties":{},"additionalProperties":false}]},"AccumulationAddressGetResponse":{"allOf":[{"$ref":"#/components/schemas/AccumulationAddressRecord"},{"type":"object","properties":{},"required":["subscriptions"],"additionalProperties":false}]},"AccumulationAddressListResponse":{"type":"object","properties":{"accumulationAddresses":{"type":"array","items":{"$ref":"#/components/schemas/AccumulationAddressRecord"}}},"required":["accumulationAddresses"],"additionalProperties":false},"AccumulationAddressSyncError":{"type":"object","properties":{"provider":{"type":"string"},"error":{"type":"string"}},"required":["provider","error"],"additionalProperties":false},"AccumulationAddressSyncResponse":{"type":"object","properties":{"ok":{"type":"boolean"},"enabledCount":{"type":"integer"},"solanaAddressCount":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/AccumulationAddressSyncError"}}},"required":["ok","enabledCount","solanaAddressCount","errors"],"additionalProperties":false},"AccumulationAddressReindexCurrency":{"type":"object","properties":{"currency":{"type":"string"},"symbol":{"type":"string"},"balance":{"type":"string"}},"required":["currency","symbol","balance"],"additionalProperties":false},"AccumulationAddressReindexResponse":{"type":"object","properties":{"ok":{"type":"boolean"},"accumulationAddressId":{"type":"string"},"sourceChain":{"$ref":"#/components/schemas/Chain"},"sourceAsset":{"type":"string"},"depositAddress":{"type":"string"},"relay":{"type":"object","properties":{"message":{"type":"string"},"triggeredCurrencies":{"type":"array","items":{"$ref":"#/components/schemas/AccumulationAddressReindexCurrency"}},"checkedCurrencies":{"type":"integer"},"failedCurrencies":{"type":"integer"}},"required":["message","triggeredCurrencies","checkedCurrencies","failedCurrencies"],"additionalProperties":false}},"required":["ok","accumulationAddressId","sourceChain","sourceAsset","depositAddress","relay"],"additionalProperties":false},"DashboardOperationsResponse":{"type":"object","properties":{"operations":{"type":"array","items":{"$ref":"#/components/schemas/DashboardOperationRecord"}},"nextOffset":{"type":["integer","null"]}},"required":["operations","nextOffset"],"additionalProperties":false},"DashboardOperationDetailResponse":{"type":"object","properties":{"operation":{"$ref":"#/components/schemas/DashboardOperationRecord"}},"required":["operation"],"additionalProperties":false},"AffiliateOrderDetail":{"type":"object","properties":{"operationId":{"type":"string"},"affiliateId":{"type":"string"},"feeBps":{"type":"integer"},"recipientAddress":{"type":"string"},"settlementChain":{"type":"string"},"settlementAsset":{"type":"string"},"amount":{"type":["string","null"]},"txHash":{"type":["string","null"]},"paidAt":{"type":["string","null"]},"createdAt":{"type":"string"},"sourceChain":{"allOf":[{"$ref":"#/components/schemas/Chain"},{"type":["string","null"]}]},"sourceAsset":{"type":["string","null"]},"destinationChain":{"allOf":[{"$ref":"#/components/schemas/Chain"},{"type":["string","null"]}]},"destinationAsset":{"type":["string","null"]},"amountIn":{"type":["string","null"]},"amountOut":{"type":["string","null"]},"operationStatus":{"type":["string","null"]}},"required":["operationId","affiliateId","feeBps","recipientAddress","settlementChain","settlementAsset","amount","txHash","paidAt","createdAt","sourceChain","sourceAsset","destinationChain","destinationAsset","amountIn","amountOut","operationStatus"],"additionalProperties":false},"AffiliateDashboardOrdersResponse":{"type":"object","properties":{"orders":{"type":"array","items":{"$ref":"#/components/schemas/AffiliateOrderDetail"}},"nextOffset":{"type":["integer","null"]}},"required":["orders","nextOffset"],"additionalProperties":false},"AffiliateActivityPoint":{"type":"object","properties":{"date":{"type":"string","description":"Bucket start, formatted per the response granularity"},"volumeUsd":{"type":"string","description":"USD volume of completed orders in the bucket"},"earnedAmount":{"type":"string","description":"Accrued affiliate fees in settlement smallest units"},"orderCount":{"type":"integer"}},"required":["date","volumeUsd","earnedAmount","orderCount"],"additionalProperties":false},"AffiliateDashboardMetricsResponse":{"type":"object","properties":{"metrics":{"type":"object","properties":{"volumeUsd":{"type":"string","description":"USD volume of completed orders in the range"},"earnedAmount":{"type":"string","description":"Accrued affiliate fees in settlement smallest units (USDC 6dp)"},"orderCount":{"type":"integer"},"completedCount":{"type":"integer"},"granularity":{"type":"string","description":"Series bucket size: hour or day"},"series":{"type":"array","items":{"$ref":"#/components/schemas/AffiliateActivityPoint"}}},"required":["volumeUsd","earnedAmount","orderCount","completedCount","granularity","series"],"additionalProperties":false}},"required":["metrics"],"additionalProperties":false},"StandingEffectiveMinimum":{"type":"object","properties":{"usdCents":{"type":"string","pattern":"^\\d+$"},"sourceAmountSmallest":{"type":["string","null"],"pattern":"^\\d+$"},"source":{"type":"string","enum":["xchain_route_bound","xchain_global_bound","source_asset_floor","destination_asset_floor"]}},"required":["usdCents","sourceAmountSmallest","source"],"additionalProperties":false,"description":"Current xchain policy floor, independent of the ordinary quote floor. With sourceChain and sourceAsset, resolves the exact route override or global bound and rounds the source amount up using the worker's market valuation; null when unpriceable. Without a source, reports the global bound with null sourceAmountSmallest. An unset floor is 0. Pricing, fees and execution availability can require more."},"StandingDepositAddress":{"type":"object","properties":{"standingAddressId":{"type":"string"},"addresses":{"type":"object","additionalProperties":{"type":"string"}},"enabled":{"type":"boolean"},"effectiveMinimum":{"$ref":"#/components/schemas/StandingEffectiveMinimum"},"bitcoinLimits":{"type":"object","properties":{"largeUnitSupported":{"type":"boolean","enum":[false]},"source":{"type":"object","additionalProperties":{},"description":"Frozen BTC source bounds by public chain; values may be malformed on legacy records."},"destination":{"description":"Frozen BTC destination bound. Omitted when absent on legacy BTC instructions, null for non-BTC destinations; validate before use."}},"required":["largeUnitSupported","source"]}},"required":["standingAddressId","addresses","enabled","effectiveMinimum"],"additionalProperties":false},"StandingDeposit":{"type":"object","properties":{"id":{"type":"string","description":"Deposit ID"},"chain":{"type":"string","description":"Deposit source chain"},"asset":{"type":"string","description":"Deposit asset: a listed asset's name, or an unsupported token's canonical address (lowercase 0x hex on EVM chains, the case-sensitive base58 mint on Solana). Token names and symbols do not establish support."},"tokenAddress":{"type":["string","null"],"description":"Immutable observed token contract address or mint from the deposit record; lowercase 0x hex on EVM chains, case-sensitive base58 on Solana. Null for native assets or legacy records without a stored token address. This is physical identity, not conversion eligibility."},"amount":{"type":"string","description":"Detected deposit amount in smallest units"},"sourceTxId":{"type":"string","description":"Source transaction ID"},"sourceTxIndex":{"type":["string","null"],"description":"Source output index, when applicable"},"senderAddress":{"type":["string","null"],"description":"Observed sender address; null for Bitcoin deposits with multiple distinct input addresses"},"observedAt":{"type":"string","description":"Deposit observation timestamp"},"status":{"type":"string","description":"Open set of processing statuses. Unsupported unbatched token deposits use review_required with code standing_unsupported_asset. Linked order status takes precedence; otherwise batch states held, refund_requested and refunded take precedence over the transfer materialization status."},"code":{"type":["string","null"],"description":"Extensible processing or error code. standing_unsupported_asset is a stable rejection of automatic standing conversion, not a minimum-amount or temporary routing failure. Legacy unsupported preparing batches are held with this code. When an order is linked, its error_code is returned even when null. Otherwise the batch error_code takes precedence over the transfer materialization_error_code. Values are not an exhaustive enum."},"batchId":{"type":["string","null"],"description":"Assigned batch ID"},"orderId":{"type":["string","null"],"description":"Linked order ID"},"quoteId":{"type":["string","null"],"description":"Linked quote ID"},"batchState":{"type":["string","null"],"enum":["preparing","held","committed","refund_requested","refunded",null],"description":"Assigned batch state"},"refundTxId":{"type":["string","null"],"description":"Refund transaction ID"},"zeroconfOffer":{"type":["object","null"],"properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","accepted","declined","expired","superseded"]},"expiresAt":{"type":"string"},"depositSats":{"type":"string"},"feeSats":{"type":"string"},"creditSats":{"type":"string"}},"required":["id","status","expiresAt","depositSats","feeSats","creditSats"]}},"required":["id","chain","asset","tokenAddress","amount","sourceTxId","sourceTxIndex","senderAddress","observedAt","status","code","batchId","orderId","quoteId","batchState","refundTxId","zeroconfOffer"]},"StandingDepositAddressRequest":{"type":"object","properties":{"destination":{"type":"object","properties":{"chain":{"type":"string","minLength":1},"asset":{"type":"string","minLength":1},"address":{"type":"string","minLength":1}},"required":["chain","asset","address"],"additionalProperties":false},"slippageBps":{"type":"integer","minimum":0,"maximum":10000,"default":50},"feeBps":{"type":"integer","minimum":0,"maximum":9999,"default":0},"affiliateIds":{"type":"array","items":{"anyOf":[{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,63}$"},{"type":"object","properties":{"affiliateId":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,63}$"},"feeBps":{"type":"integer","minimum":1,"maximum":9999}},"required":["affiliateId","feeBps"],"additionalProperties":false}]},"maxItems":16,"default":[]},"refundAddresses":{"type":"object","additionalProperties":{"type":"string","minLength":1},"default":{}}},"required":["destination"],"additionalProperties":false}},"parameters":{}},"paths":{"/v1/standing-deposit-addresses/destinations":{"get":{"tags":["Standing Deposit Addresses"],"x-group":"Standing Deposit Addresses","security":[{"bearerAuth":[]}],"operationId":"listStandingDepositDestinations","summary":"List standing destinations","description":"Structurally reachable destinations from configured standing custody for this partner, each with effectiveMinimum. Requires a server key. Lightning BTC is default-off and limited to explicitly admitted Solana USDC partners and reusable targets. Supply both sourceChain and sourceAsset or neither; omitting both returns the union across eligible sources and the global floor only. Token deposits must match a supported catalog contract or mint on the source chain; a matching symbol does not suffice. The policy floor does not guarantee a viable execution price or admit arbitrary tokens sent to an issued address.","parameters":[{"schema":{"type":"string","minLength":1,"description":"Source chain; requires sourceAsset"},"required":false,"description":"Source chain; requires sourceAsset","name":"sourceChain","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Source asset; requires sourceChain"},"required":false,"description":"Source asset; requires sourceChain","name":"sourceAsset","in":"query"}],"responses":{"200":{"description":"Structurally reachable destinations, deduplicated by chain and asset.","content":{"application/json":{"schema":{"type":"object","properties":{"destinations":{"type":"array","items":{"type":"object","properties":{"chain":{"type":"string"},"asset":{"type":"string"},"effectiveMinimum":{"$ref":"#/components/schemas/StandingEffectiveMinimum"}},"required":["chain","asset","effectiveMinimum"],"additionalProperties":false}}},"required":["destinations"],"additionalProperties":false}}}},"400":{"description":"Error with a stable error.code; foreign customers return not_found."},"401":{"description":"Error with a stable error.code; foreign customers return not_found."},"403":{"description":"Error with a stable error.code; foreign customers return not_found."},"404":{"description":"Error with a stable error.code; foreign customers return not_found."},"409":{"description":"Error with a stable error.code; foreign customers return not_found."},"503":{"description":"Temporarily unavailable. Address registration can return scanner_unavailable when observation registration is unavailable. Bounded primary database reads, including API-key authentication, return database_read_unavailable. Retry after Retry-After seconds; this response does not imply an invalid credential.","headers":{"Retry-After":{"description":"Seconds before retrying database_read_unavailable (1).","schema":{"type":"string"}}}}}}},"/v1/standing-deposit-addresses/{ref}":{"put":{"tags":["Standing Deposit Addresses"],"x-group":"Standing Deposit Addresses","security":[{"bearerAuth":[]}],"operationId":"registerStandingDepositAddress","summary":"Register standing address","description":"Create or fetch permanent addresses for an immutable instruction. New chain bindings require structural reachability from at least one eligible source asset; this does not guarantee pricing or execution for a deposit amount. An issued address cannot block arbitrary on-chain token arrivals. Independently proved unsupported token deposits remain visible with standing_unsupported_asset and cannot automatically convert. Existing bindings are preserved. Lightning BTC requires an admitted partner and a reusable Lightning Address or encoded HTTPS LNURL-pay target (maximum raw target length 4096); single-use BOLT11 and BOLT12 are rejected for new standing instructions. Initial Lightning source support is Solana canonical USDC only. Registration does not mint an invoice or promise an output amount; exact-in pricing happens after funding. Requires a server key.","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128},"required":true,"name":"ref","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Source chain; requires sourceAsset"},"required":false,"description":"Source chain; requires sourceAsset","name":"sourceChain","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Source asset; requires sourceChain"},"required":false,"description":"Source asset; requires sourceChain","name":"sourceAsset","in":"query"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandingDepositAddressRequest"},"example":{"destination":{"chain":"base","asset":"USDC","address":"RECIPIENT_ADDRESS"},"slippageBps":50}}}},"responses":{"200":{"description":"Permanent addresses and enabled state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandingDepositAddress"}}}},"400":{"description":"Error with a stable error.code; foreign customers return not_found."},"401":{"description":"Error with a stable error.code; foreign customers return not_found."},"403":{"description":"Error with a stable error.code; foreign customers return not_found."},"404":{"description":"Error with a stable error.code; foreign customers return not_found."},"409":{"description":"Error with a stable error.code; foreign customers return not_found."},"503":{"description":"Temporarily unavailable. Address registration can return scanner_unavailable when observation registration is unavailable. Bounded primary database reads, including API-key authentication, return database_read_unavailable. Retry after Retry-After seconds; this response does not imply an invalid credential.","headers":{"Retry-After":{"description":"Seconds before retrying database_read_unavailable (1).","schema":{"type":"string"}}}}}},"get":{"tags":["Standing Deposit Addresses"],"x-group":"Standing Deposit Addresses","security":[{"bearerAuth":[]}],"operationId":"getStandingDepositAddress","summary":"Get standing address","description":"Addresses, enabled state and current effectiveMinimum for a ref. Supply both sourceChain and sourceAsset for an exact route floor, or neither for the global floor. Requires a server key.","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128},"required":true,"name":"ref","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Source chain; requires sourceAsset"},"required":false,"description":"Source chain; requires sourceAsset","name":"sourceChain","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Source asset; requires sourceChain"},"required":false,"description":"Source asset; requires sourceChain","name":"sourceAsset","in":"query"}],"responses":{"200":{"description":"Permanent addresses and enabled state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandingDepositAddress"}}}},"400":{"description":"Error with a stable error.code; foreign customers return not_found."},"401":{"description":"Error with a stable error.code; foreign customers return not_found."},"403":{"description":"Error with a stable error.code; foreign customers return not_found."},"404":{"description":"Error with a stable error.code; foreign customers return not_found."},"409":{"description":"Error with a stable error.code; foreign customers return not_found."},"503":{"description":"Temporarily unavailable. Address registration can return scanner_unavailable when observation registration is unavailable. Bounded primary database reads, including API-key authentication, return database_read_unavailable. Retry after Retry-After seconds; this response does not imply an invalid credential.","headers":{"Retry-After":{"description":"Seconds before retrying database_read_unavailable (1).","schema":{"type":"string"}}}}}},"patch":{"tags":["Standing Deposit Addresses"],"x-group":"Standing Deposit Addresses","security":[{"bearerAuth":[]}],"operationId":"updateStandingDepositAddress","summary":"Pause or resume conversion","description":"Pause or resume conversion while observation continues. Requires a server key.","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128},"required":true,"name":"ref","in":"path"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"}},"required":["enabled"],"additionalProperties":false}}}},"responses":{"200":{"description":"Updated","content":{"application/json":{"schema":{"type":"object","properties":{"standingAddressId":{"type":"string"},"enabled":{"type":"boolean"}},"required":["standingAddressId","enabled"]}}}},"400":{"description":"Error with a stable error.code; foreign customers return not_found."},"401":{"description":"Error with a stable error.code; foreign customers return not_found."},"403":{"description":"Error with a stable error.code; foreign customers return not_found."},"404":{"description":"Error with a stable error.code; foreign customers return not_found."},"409":{"description":"Error with a stable error.code; foreign customers return not_found."},"503":{"description":"Temporarily unavailable. Address registration can return scanner_unavailable when observation registration is unavailable. Bounded primary database reads, including API-key authentication, return database_read_unavailable. Retry after Retry-After seconds; this response does not imply an invalid credential.","headers":{"Retry-After":{"description":"Seconds before retrying database_read_unavailable (1).","schema":{"type":"string"}}}}}}},"/v1/standing-deposit-addresses/{ref}/deposits":{"get":{"tags":["Standing Deposit Addresses"],"x-group":"Standing Deposit Addresses","security":[{"bearerAuth":[]}],"operationId":"listStandingDeposits","summary":"List deposits","description":"Deposits observed on a ref, newest first, including independently proved unsupported tokens rejected from automatic conversion. Inspect chain and tokenAddress for physical token identity, and status/code for processing state. Requires a server key.","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128},"required":true,"name":"ref","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":200},"required":false,"name":"limit","in":"query"},{"schema":{"type":"integer","minimum":0},"required":false,"name":"offset","in":"query"}],"responses":{"200":{"description":"Observed deposits and their order linkage.","content":{"application/json":{"schema":{"type":"object","properties":{"deposits":{"type":"array","items":{"$ref":"#/components/schemas/StandingDeposit"}},"nextOffset":{"type":["number","null"]}},"required":["deposits","nextOffset"]}}}},"400":{"description":"Error with a stable error.code; foreign customers return not_found."},"401":{"description":"Error with a stable error.code; foreign customers return not_found."},"403":{"description":"Error with a stable error.code; foreign customers return not_found."},"404":{"description":"Error with a stable error.code; foreign customers return not_found."},"409":{"description":"Error with a stable error.code; foreign customers return not_found."},"503":{"description":"Temporarily unavailable. Address registration can return scanner_unavailable when observation registration is unavailable. Bounded primary database reads, including API-key authentication, return database_read_unavailable. Retry after Retry-After seconds; this response does not imply an invalid credential.","headers":{"Retry-After":{"description":"Seconds before retrying database_read_unavailable (1).","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["database_read_unavailable"]},"message":{"type":"string","enum":["Database reads are temporarily unavailable"]}},"required":["code","message"]}},"required":["error"]}}}}}}},"/v1/standing-deposit-addresses/{ref}/deposits/{depositId}/zeroconf/accept":{"post":{"tags":["Standing Deposit Addresses"],"x-group":"Standing Deposit Addresses","security":[{"bearerAuth":[]}],"operationId":"acceptStandingDepositZeroconfOffer","summary":"Accept deposit ZeroConf offer","description":"Record the Bitcoin deposit ZeroConf decision; conflicting or stale decisions return standing_zeroconf_offer_conflict. Requires a server key.","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128},"required":true,"name":"ref","in":"path"},{"schema":{"type":"string","minLength":1},"required":true,"name":"depositId","in":"path"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"offerId":{"type":"string","minLength":1,"maxLength":128}},"required":["offerId"],"additionalProperties":false}}}},"responses":{"202":{"description":"Decision persisted; execution is asynchronous","content":{"application/json":{"schema":{"type":"object","properties":{"deposit":{"$ref":"#/components/schemas/StandingDeposit"}},"required":["deposit"]}}}},"400":{"description":"Error with a stable error.code; foreign customers return not_found."},"401":{"description":"Error with a stable error.code; foreign customers return not_found."},"403":{"description":"Error with a stable error.code; foreign customers return not_found."},"404":{"description":"Error with a stable error.code; foreign customers return not_found."},"409":{"description":"Error with a stable error.code; foreign customers return not_found."},"503":{"description":"Temporarily unavailable. Address registration can return scanner_unavailable when observation registration is unavailable. Bounded primary database reads, including API-key authentication, return database_read_unavailable. Retry after Retry-After seconds; this response does not imply an invalid credential.","headers":{"Retry-After":{"description":"Seconds before retrying database_read_unavailable (1).","schema":{"type":"string"}}}}}}},"/v1/standing-deposit-addresses/{ref}/deposits/{depositId}/zeroconf/decline":{"post":{"tags":["Standing Deposit Addresses"],"x-group":"Standing Deposit Addresses","security":[{"bearerAuth":[]}],"operationId":"declineStandingDepositZeroconfOffer","summary":"Decline deposit ZeroConf offer","description":"Record the Bitcoin deposit ZeroConf decision; conflicting or stale decisions return standing_zeroconf_offer_conflict. Requires a server key.","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128},"required":true,"name":"ref","in":"path"},{"schema":{"type":"string","minLength":1},"required":true,"name":"depositId","in":"path"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"offerId":{"type":"string","minLength":1,"maxLength":128}},"required":["offerId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Decision persisted; execution is asynchronous","content":{"application/json":{"schema":{"type":"object","properties":{"deposit":{"$ref":"#/components/schemas/StandingDeposit"}},"required":["deposit"]}}}},"400":{"description":"Error with a stable error.code; foreign customers return not_found."},"401":{"description":"Error with a stable error.code; foreign customers return not_found."},"403":{"description":"Error with a stable error.code; foreign customers return not_found."},"404":{"description":"Error with a stable error.code; foreign customers return not_found."},"409":{"description":"Error with a stable error.code; foreign customers return not_found."},"503":{"description":"Temporarily unavailable. Address registration can return scanner_unavailable when observation registration is unavailable. Bounded primary database reads, including API-key authentication, return database_read_unavailable. Retry after Retry-After seconds; this response does not imply an invalid credential.","headers":{"Retry-After":{"description":"Seconds before retrying database_read_unavailable (1).","schema":{"type":"string"}}}}}}},"/v1/standing-deposit-addresses/{ref}/resolve":{"post":{"tags":["Standing Deposit Addresses"],"x-group":"Standing Deposit Addresses","security":[{"bearerAuth":[]}],"operationId":"requestStandingDepositRefund","summary":"Request deposit refund","description":"Request a refund of selected depositIds or one batchId to an explicit refundAddress on the source chain. Unsupported token deposits may be requested for return of only their original token and recorded amount; no canonical-token substitution or shared-inventory payout is authorized. The worker checks proof, screening, custody and live transactions asynchronously; these checks may keep the refund held. A request is not proof of delivery, and arbitrary token arrivals do not trigger automatic gas-funded refunds. Requires a server key.","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128},"required":true,"name":"ref","in":"path"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"batchId":{"type":"string","minLength":1},"refundAddress":{"type":"string","minLength":1}},"required":["batchId","refundAddress"],"additionalProperties":false},{"type":"object","properties":{"depositIds":{"type":"array","items":{"type":"string","minLength":1},"minItems":1,"maxItems":200},"refundAddress":{"type":"string","minLength":1}},"required":["depositIds","refundAddress"],"additionalProperties":false}]}}}},"responses":{"202":{"description":"Return target recorded","content":{"application/json":{"schema":{"type":"object","properties":{"batchId":{"type":"string"},"status":{"type":"string","enum":["refund_requested"]}},"required":["batchId","status"]}}}},"400":{"description":"Error with a stable error.code; foreign customers return not_found."},"401":{"description":"Error with a stable error.code; foreign customers return not_found."},"403":{"description":"Error with a stable error.code; foreign customers return not_found."},"404":{"description":"Error with a stable error.code; foreign customers return not_found."},"409":{"description":"Error with a stable error.code; foreign customers return not_found."},"503":{"description":"Temporarily unavailable. Address registration can return scanner_unavailable when observation registration is unavailable. Bounded primary database reads, including API-key authentication, return database_read_unavailable. Retry after Retry-After seconds; this response does not imply an invalid credential.","headers":{"Retry-After":{"description":"Seconds before retrying database_read_unavailable (1).","schema":{"type":"string"}}}}}}},"/v1/lightning/decode":{"post":{"summary":"Inspect a BOLT11 invoice","description":"Read-only local inspection of a BOLT11 invoice, up to 16384 characters including an optional single lightning: prefix. Accepts lowercase or uppercase invoices; mixed case is rejected. Requires a server API key or a client key with orders:quote; account approval and client origin rules apply. Does not verify the signature, establish payability, fetch LNURL targets, create orders or make payments. LNURL, Lightning Address and BOLT12 inputs return actionable 400 errors. Expired and non-mainnet invoices can be inspected. Timestamps are Unix seconds. Responses use Cache-Control: private, no-store. No X-Idempotency-Key is required or persisted.","operationId":"postV1LightningDecode","security":[{"bearerAuth":[]}],"tags":["Lightning"],"x-group":"Lightning","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LightningDecodeRequest"}}}},"responses":{"200":{"description":"Decoded details; signatureVerified is always false","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LightningInvoiceDetails"}}}},"400":{"description":"Invalid JSON or request (invalid_request, validation_error), invalid BOLT11 (invalid_bolt11_invoice), unsupported target (unsupported_invoice_type) or network (unsupported_invoice_network)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid or expired API credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Client scope, origin, account or authentication method not permitted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"413":{"description":"Request body exceeds 128 KiB","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limited (`rate_limited`); see the [rate-limits guide](/api/rate-limits). Retry after Retry-After seconds when present (per-key limiter only), otherwise at X-RateLimit-Reset, an absolute epoch timestamp in milliseconds; both limiters also return X-RateLimit-Limit and X-RateLimit-Remaining.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/orchestration/blocked-addresses":{"get":{"summary":"List manual address blocks","description":"Complete active manual policy snapshot, sorted by scope and canonical address. Requires a full partner key or a client key with orders:quote; normal account and origin checks apply. All responses use Cache-Control: private, no-store. Replace a local snapshot only after success; removals appear as absence in a later complete snapshot. updatedAt is the last policy-decision write, not a screening timestamp or cursor. No pagination. An absent address may still fail provider or runtime screening; this is not a legal sanctions list. Rate limited per IP before reading the policy.","operationId":"getV1OrchestrationBlockedAddresses","security":[{"bearerAuth":[]}],"tags":["Orchestration"],"x-group":"Orchestration","responses":{"200":{"description":"Complete active manual policy (possibly empty)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrchestrationBlockedAddressesResponse"},"examples":{"success":{"summary":"Synthetic active manual block","value":{"addresses":[{"scope":"evm","address":"0x1111111111111111111111111111111111111111","updatedAt":"2026-10-21T00:00:00.000Z"}]}}}}}},"401":{"description":"Missing, invalid or expired credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Client scope, origin or partner account not permitted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limited (`rate_limited`); see the [rate-limits guide](/api/rate-limits). Retry after Retry-After seconds when present (per-key limiter only), otherwise at X-RateLimit-Reset, an absolute epoch timestamp in milliseconds; both limiters also return X-RateLimit-Limit and X-RateLimit-Remaining.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Manual policy unavailable or invalid (screening_unavailable); retain the previous snapshot.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/healthz":{"get":{"summary":"Check health","x-excluded":true,"description":"API and database availability. Public.","operationId":"getHealthz","security":[],"tags":["System"],"x-group":"System","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthzResponse"}}}},"413":{"description":"Request body exceeds maximum size","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Database unreachable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthzUnavailableResponse"}}}}}}},"/livez":{"get":{"summary":"Check liveness","x-excluded":true,"description":"API and worker availability. Public.","operationId":"getLivez","security":[],"tags":["System"],"x-group":"System","responses":{"200":{"description":"API and worker reachable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LivezResponse"}}}},"413":{"description":"Request body exceeds maximum size","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Worker TEE unreachable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LivezUnavailableResponse"}}}}}}},"/v1/orchestration/routes":{"get":{"summary":"List routes (v1)","description":"Older routes shape, superseded by GET /v2/orchestration/routes. Public. Still served for existing integrations. Reviewed xStocks/Ondo assets are excluded, including after admission; discover them through v2.","deprecated":true,"x-hidden":true,"operationId":"getV1OrchestrationRoutes","security":[{},{"bearerAuth":[]}],"tags":["Orchestration"],"x-group":"Orchestration","parameters":[{"schema":{"type":"string","enum":["default","shielded"],"description":"Explicit shielded capability discovery requires authentication and ordinary key scopes. Omission preserves the original response."},"required":false,"description":"Explicit shielded capability discovery requires authentication and ordinary key scopes. Omission preserves the original response.","name":"sourcePaymentMode","in":"query"}],"responses":{"200":{"description":"Supported public route pairs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrchestrationRoutesResponse"},"examples":{"success":{"summary":"Bitcoin to Solana USDC route","value":{"routes":[{"sourceChain":"bitcoin","sourceAsset":"BTC","destinationChain":"solana","destinationAsset":"USDC","exactOutEligible":false,"fixedEligible":false,"source":{"chain":"bitcoin","asset":"BTC","assetDisplayName":"Bitcoin","assetDisplaySymbol":"BTC","contractAddress":null,"decimals":8,"chainId":null,"chainDisplayName":"Bitcoin","chainIcon":"/btc.svg"},"destination":{"chain":"solana","asset":"USDC","assetDisplayName":"USDC","assetDisplaySymbol":"USDC","contractAddress":"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v","decimals":6,"chainId":"solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp","chainDisplayName":"Solana","chainIcon":"/chain-solana.svg"}}]}}}}}}}}},"/v2/orchestration/routes":{"get":{"summary":"List routes","description":"Every asset and the destinations it can reach. Public, partner-aware. Reviewed xStocks/Ondo discovery is v2-only and requires explicit admission; these assets are disabled by default. Reviewed pairs require supported independent valuation for both endpoints and fresh accepted evidence; unsupported directions are omitted without removing unrelated ordinary routes. Discovery is a current, non-cacheable availability snapshot, not a guarantee of future liquidity. Refresh it before selecting a route. Unsupported pairs return 400 xchain_no_route before planning; transient evidence failures remain retryable. Discovery is amount-independent; quotes still validate the requested size. Quote and execution endpoints remain under /v1/orchestration.","operationId":"getV2OrchestrationRoutes","security":[{},{"bearerAuth":[]}],"tags":["Orchestration"],"x-group":"Orchestration","responses":{"200":{"description":"Compact public route assets","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrchestrationRoutesV2Response"},"examples":{"success":{"summary":"Bitcoin to Solana USDC discovery","value":{"assets":[{"id":"bitcoin:BTC","chain":"bitcoin","asset":"BTC","assetDisplayName":"Bitcoin","assetDisplaySymbol":"BTC","contractAddress":null,"decimals":8,"chainId":null,"chainDisplayName":"Bitcoin","chainIcon":"/btc.svg","route":{"to":"all","exactOutTo":[],"fixedTo":[]}},{"id":"solana:USDC","chain":"solana","asset":"USDC","assetDisplayName":"USDC","assetDisplaySymbol":"USDC","contractAddress":"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v","decimals":6,"chainId":"solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp","chainDisplayName":"Solana","chainIcon":"/chain-solana.svg","route":{"to":[],"exactOutTo":[],"fixedTo":[]}}]}}}}}},"401":{"description":"Invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Partner account or client-key origin not permitted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limited (`rate_limited`). X-RateLimit-Reset is an absolute epoch time in milliseconds; the IP limiter does not send Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/orchestration/limits":{"get":{"summary":"Get route limits","description":"Amount bounds per route; pass filters to narrow results. Public.","operationId":"getV1OrchestrationLimits","security":[{},{"bearerAuth":[]}],"tags":["Orchestration"],"x-group":"Orchestration","parameters":[{"schema":{"$ref":"#/components/schemas/Chain"},"required":false,"name":"sourceChain","in":"query"},{"schema":{"$ref":"#/components/schemas/AssetInput"},"required":false,"description":"A canonical public asset symbol or a registry asset routing key. TON is a legacy input alias for ton:GRAM only; responses use GRAM.","name":"sourceAsset","in":"query"},{"schema":{"$ref":"#/components/schemas/Chain"},"required":false,"name":"destinationChain","in":"query"},{"schema":{"$ref":"#/components/schemas/AssetInput"},"required":false,"description":"A canonical public asset symbol or a registry asset routing key. TON is a legacy input alias for ton:GRAM only; responses use GRAM.","name":"destinationAsset","in":"query"},{"schema":{"type":"string","enum":["default","shielded"]},"required":false,"name":"sourcePaymentMode","in":"query"}],"responses":{"200":{"description":"Supported route limits and deterministic route constraints","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrchestrationLimitsResponse"},"examples":{"success":{"summary":"Illustrative route limits","value":{"generatedAt":"2026-09-12T12:00:00.000Z","routes":[{"sourceChain":"bitcoin","sourceAsset":"BTC","destinationChain":"solana","destinationAsset":"USDC","exactOutEligible":false,"fixedEligible":false,"source":{"chain":"bitcoin","asset":"BTC","assetDisplayName":"Bitcoin","assetDisplaySymbol":"BTC","contractAddress":null,"decimals":8,"chainId":null,"chainDisplayName":"Bitcoin","chainIcon":"/btc.svg"},"destination":{"chain":"solana","asset":"USDC","assetDisplayName":"USDC","assetDisplaySymbol":"USDC","contractAddress":"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v","decimals":6,"chainId":"solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp","chainDisplayName":"Solana","chainIcon":"/chain-solana.svg"},"direction":"sell","limits":{"orderNotionalUsd":{"minCents":"1000","maxCents":"1000000","source":"runtime_order_bounds"},"exactIn":{"supported":true,"requestAmount":{"leg":"source","chain":"bitcoin","asset":"BTC","minAmountSmallest":null,"maxAmountSmallest":null,"minUsdCents":"1000","maxUsdCents":"1000000"},"constraints":["order_notional_usd"]},"exactOut":{"supported":false,"requestAmount":null,"constraints":[]},"fiatUsd":null,"dynamicProviderLimits":{"possible":false,"components":[],"description":null},"constraints":[{"id":"order_notional_usd","amountMode":"all","leg":"route","source":"runtime_order_bounds","description":"Runtime USD notional bounds","chain":null,"asset":null,"minAmountSmallest":null,"maxAmountSmallest":null,"minUsdCents":"1000","maxUsdCents":"1000000"}]}}]}}}}}}}}},"/v1/explorer/operations":{"get":{"summary":"List explorer operations","description":"Redacted order lookup by exact order or transaction id. Public.","x-excluded":true,"operationId":"getV1ExplorerOperations","security":[],"tags":["Explorer"],"x-group":"Explorer","parameters":[{"schema":{"type":"string","minLength":1,"description":"Exact order id or transaction id. Address and filter lookups are rejected."},"required":true,"description":"Exact order id or transaction id. Address and filter lookups are rejected.","name":"q","in":"query"}],"responses":{"200":{"description":"Public operation lookup result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicExplorerOperationsResponse"}}}},"400":{"description":"Missing or invalid identifier","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Operation not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Identifier matches multiple operations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/explorer/operations/{id}":{"get":{"summary":"Get explorer operation","description":"One public explorer record by id.","x-excluded":true,"operationId":"getV1ExplorerOperationsId","security":[],"tags":["Explorer"],"x-group":"Explorer","parameters":[{"schema":{"type":"string","description":"Exact `ord_...` operation id."},"required":true,"description":"Exact `ord_...` operation id.","name":"id","in":"path"}],"responses":{"200":{"description":"Public operation detail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicExplorerOperationDetailResponse"}}}},"400":{"description":"Invalid operation id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Operation not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/orchestration/estimate":{"get":{"summary":"Estimate a swap","description":"Indicative price for a route, no state created. Public. HyperCore source routes are unavailable until independent deposit verification is supported; HyperCore destinations remain supported.","operationId":"getV1OrchestrationEstimate","security":[{},{"bearerAuth":[]}],"tags":["Orchestration"],"x-group":"Orchestration","parameters":[{"schema":{"$ref":"#/components/schemas/Chain"},"required":true,"name":"sourceChain","in":"query"},{"schema":{"$ref":"#/components/schemas/SourceAssetInput"},"required":true,"description":"An AssetInput, or a token address. A quote whose source is an unlisted token requires refundAddress: a deposit that cannot be sold is refunded in kind there.","name":"sourceAsset","in":"query"},{"schema":{"$ref":"#/components/schemas/Chain"},"required":true,"name":"destinationChain","in":"query"},{"schema":{"$ref":"#/components/schemas/DestinationAssetInput"},"required":true,"description":"An AssetInput, or a token address. An unlisted destination adds minAmountOut and fallback to the quote.","name":"destinationAsset","in":"query"},{"schema":{"type":"string","pattern":"^[0-9]+$"},"required":true,"name":"amount","in":"query"},{"schema":{"type":"string","enum":["exact_in","exact_out"]},"required":false,"name":"amountMode","in":"query"},{"schema":{"type":"string","enum":["variable","fixed"],"description":"Fixed-output quotes require exact_in, an eligible route, and partner approval. A route accepts fixed only where /v2/orchestration/routes reports fixedEligible (fixedTo); other routes return 400 fixed_delivery_unsupported_route. Fixed estimates are indicative; quotes validate exact-output affordability before returning deposit instructions. Fixed stablecoin routes to Solana USDC include recipient token-account creation costs upfront and preserve the quoted payout."},"required":false,"description":"Fixed-output quotes require exact_in, an eligible route, and partner approval. A route accepts fixed only where /v2/orchestration/routes reports fixedEligible (fixedTo); other routes return 400 fixed_delivery_unsupported_route. Fixed estimates are indicative; quotes validate exact-output affordability before returning deposit instructions. Fixed stablecoin routes to Solana USDC include recipient token-account creation costs upfront and preserve the quoted payout.","name":"deliveryMode","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Destination recipient for validation and network costs; use the owner address for Solana tokens."},"required":false,"description":"Destination recipient for validation and network costs; use the owner address for Solana tokens.","name":"recipientAddress","in":"query"},{"schema":{"type":"integer","minimum":0,"maximum":1000},"required":false,"name":"slippageBps","in":"query"},{"schema":{"type":"string","enum":["legacy","specific"],"description":"Opt in to affiliate_not_found / affiliate_disabled for registered affiliate lookup failures. Omitted or legacy preserves invalid_request. HTTP 400 in either mode."},"required":false,"description":"Opt in to affiliate_not_found / affiliate_disabled for registered affiliate lookup failures. Omitted or legacy preserves invalid_request. HTTP 400 in either mode.","name":"affiliateErrorMode","in":"query"},{"schema":{"type":"string","enum":["default","shielded"],"description":"Shielded is native ZEC exact-in variable only. No account or provider deposit is allocated by estimates."},"required":false,"description":"Shielded is native ZEC exact-in variable only. No account or provider deposit is allocated by estimates.","name":"sourcePaymentMode","in":"query"},{"schema":{"type":"string","enum":["default","shielded"],"description":"Shielded destination supports authenticated partners and appropriately scoped client keys. Shielded requires native zcash:ZEC, exact_in and variable delivery; unsupported routes/modes must reject. Omitted/default preserves existing delivery. No wallet or provider instructions are allocated by estimates."},"required":false,"description":"Shielded destination supports authenticated partners and appropriately scoped client keys. Shielded requires native zcash:ZEC, exact_in and variable delivery; unsupported routes/modes must reject. Omitted/default preserves existing delivery. No wallet or provider instructions are allocated by estimates.","name":"destinationPaymentMode","in":"query"},{"schema":{"type":"string","enum":["best_return"]},"required":false,"name":"routing","in":"query"},{"schema":{"type":"string","description":"Shielded only: comma-separated near-intents and/or hyperunit, without duplicates."},"required":false,"description":"Shielded only: comma-separated near-intents and/or hyperunit, without duplicates.","name":"allowedProviders","in":"query"},{"schema":{"type":"integer","exclusiveMinimum":0,"description":"Shielded only: upper bound for eligible provider estimates."},"required":false,"description":"Shielded only: upper bound for eligible provider estimates.","name":"maxEstimatedSettlementSeconds","in":"query"}],"responses":{"200":{"description":"Quote estimate","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrchestrationEstimateResponse"},"examples":{"success":{"summary":"Estimate for 100000 sats","value":{"amountMode":"exact_in","estimatedOut":"99000000","feeAmount":"500000","roundingFeeAmount":"0","totalFeeAmount":"500000","feeBps":50,"feeAsset":"USDC","route":["BTC","USDB","USDC"],"source":{"chain":"bitcoin","asset":"BTC","assetDisplayName":"Bitcoin","assetDisplaySymbol":"BTC","contractAddress":null,"decimals":8,"chainId":null,"chainDisplayName":"Bitcoin","chainIcon":"/btc.svg"},"destination":{"chain":"solana","asset":"USDC","assetDisplayName":"USDC","assetDisplaySymbol":"USDC","contractAddress":"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v","decimals":6,"chainId":"solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp","chainDisplayName":"Solana","chainIcon":"/chain-solana.svg"}}}}}}},"400":{"description":"Invalid request, unsupported route, or input outside amount bounds (`amount_too_small` / `amount_too_large`). A confirmed provider policy refusal returns `provider_policy_rejected` (400). It does not identify the refused address or establish that an address belongs to the caller. A confirmed minimum-amount refusal returns `amount_too_small`; any stated dollar minimum is USD swap value, not source-token units. For ordinary variable exact-in Zcash requests, a proven input below the remaining enabled source rail minimum returns `amount_too_small` before a disabled-provider error. Passing this minimum does not establish route availability. Conclusive source-route exhaustion with differing refusal reasons returns `xchain_source_route_unavailable` (400), without asserting unanimous policy rejection. Unclassified upstream failures, provider rate limits, local capacity limits, and timeouts remain retryable 503 errors. With affiliateErrorMode=specific, registered affiliate lookup failures return affiliate_not_found or affiliate_disabled. A source or destination named by token address can also return invalid_token_address, token_not_found, token_unsupported (including a Solana mint with refused extensions), token_blocked, insufficient_liquidity (no route reaches or leaves the token), unsupported_amount_mode (exact_out and fixed delivery), amount_too_large (the order cap, valued in the hub the token is swapped with), or route_unavailable (chain or account not enabled for that end).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Sanctioned address or cached screening block","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limited (`rate_limited`); see the [rate-limits guide](/api/rate-limits). Retry after Retry-After seconds when present (per-key limiter only), otherwise at X-RateLimit-Reset, an absolute epoch timestamp in milliseconds; both limiters also return X-RateLimit-Limit and X-RateLimit-Remaining.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Token metadata could not be read from the chain (`token_metadata_unavailable`); retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/orchestration/assets/resolve":{"get":{"summary":"Resolve a token address","description":"What a token address on a chain is, and whether this caller may use it as a destination or source. Accepts an ERC-20 address on an EVM chain or an SPL mint on solana. A listed address returns its registry asset; any other token admitted at either end returns its on-chain metadata with listing unlisted, and destination and source say which ends this caller may use it at. Public, partner-aware, rate limited like estimate, and stores nothing.","operationId":"getV1OrchestrationAssetsResolve","security":[{},{"bearerAuth":[]}],"tags":["Orchestration"],"x-group":"Orchestration","parameters":[{"schema":{"$ref":"#/components/schemas/Chain"},"required":true,"name":"chain","in":"query"},{"schema":{"type":"string","minLength":1,"description":"ERC-20 contract address on an EVM chain, or SPL mint (case-sensitive) on solana."},"required":true,"description":"ERC-20 contract address on an EVM chain, or SPL mint (case-sensitive) on solana.","name":"address","in":"query"}],"responses":{"200":{"description":"Resolved token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolvedTokenAddressResponse"},"examples":{"success":{"summary":"Unlisted Robinhood Chain token","value":{"asset":{"chain":"robinhood","asset":"0x39dbed3a2bd333467115de45665cc57f813c4571","assetDisplayName":"Pons","assetDisplaySymbol":"PONS","contractAddress":"0x39dbed3a2bd333467115de45665cc57f813c4571","decimals":18,"chainId":"4663","chainDisplayName":"Robinhood Chain","chainIcon":"/chain-robinhood.svg","listing":"unlisted"},"destination":true,"source":false}}}}}},"400":{"description":"Invalid query (`invalid_request`), or a token this caller cannot use at either end: invalid_token_address, token_not_found, token_unsupported, token_blocked, or route_unavailable (chain or account not enabled).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Partner account or client-key origin not permitted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limited (`rate_limited`); see the [rate-limits guide](/api/rate-limits). Retry after Retry-After seconds when present (per-key limiter only), otherwise at X-RateLimit-Reset, an absolute epoch timestamp in milliseconds; both limiters also return X-RateLimit-Limit and X-RateLimit-Remaining.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Token metadata could not be read from the chain (`token_metadata_unavailable`); retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/orchestration/quote":{"post":{"summary":"Create quote","description":"Firm price for 2 minutes plus a deposit address on ordinary routes. Explicit shielded ZEC instead returns a 30-minute funding deadline (expiresAt and funding.payBy), a separate two-minute indicative priceValidUntil, and indicativeMinAmountOut. New funding.version=2 quotes accept the canonical confirmed amount actually received and price it at market before freezing the execution minimum. Real provider minimums, fees and funding deadlines still apply. Legacy funding.version=1 quotes retain lockedMinAmountOut and their exact-amount contract. Shielded quotes allocate an Orchard receiver, not a provider deposit; both Unit and NEAR are eligible subject to operational readiness and execution policy. Omitted/default sourcePaymentMode retains existing behavior. Paying the address creates the order. Address screening can reject a quote request, including retries. A screening rejection does not replace a previously issued quote. HyperCore source routes are unavailable until independent deposit verification is supported; HyperCore destinations remain supported.","operationId":"postV1OrchestrationQuote","security":[{"bearerAuth":[]}],"tags":["Orchestration"],"x-group":"Orchestration","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrchestrationQuoteRequest"},"example":{"sourceChain":"base","sourceAsset":"USDC","destinationChain":"spark","destinationAsset":"BTC","amount":"50000000","recipientAddress":"RECIPIENT_ADDRESS"}}}},"responses":{"200":{"description":"Quote created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrchestrationQuoteResponse"},"examples":{"success":{"summary":"Bitcoin deposit quote","value":{"amountMode":"exact_in","estimatedOut":"99000000","feeAmount":"500000","roundingFeeAmount":"0","totalFeeAmount":"500000","feeBps":50,"feeAsset":"USDC","route":["BTC","USDB","USDC"],"quoteId":"q_7e450ab4-935b-4f8d-a6c4-4987a3cd2831","depositAddress":"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh","amountIn":"100000","expiresAt":"2026-09-12T12:02:00.000Z","source":{"chain":"bitcoin","asset":"BTC","assetDisplayName":"Bitcoin","assetDisplaySymbol":"BTC","contractAddress":null,"decimals":8,"chainId":null,"chainDisplayName":"Bitcoin","chainIcon":"/btc.svg"},"destination":{"chain":"solana","asset":"USDC","assetDisplayName":"USDC","assetDisplaySymbol":"USDC","contractAddress":"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v","decimals":6,"chainId":"solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp","chainDisplayName":"Solana","chainIcon":"/chain-solana.svg"}}}}}}},"400":{"description":"Invalid request, unsupported route, or input outside amount bounds (`amount_too_small` / `amount_too_large`). A confirmed provider policy refusal returns `provider_policy_rejected` (400). It does not identify the refused address or establish that an address belongs to the caller. A confirmed minimum-amount refusal returns `amount_too_small`; any stated dollar minimum is USD swap value, not source-token units. For ordinary variable exact-in Zcash requests, a proven input below the remaining enabled source rail minimum returns `amount_too_small` before a disabled-provider error. Passing this minimum does not establish route availability. Conclusive source-route exhaustion with differing refusal reasons returns `xchain_source_route_unavailable` (400), without asserting unanimous policy rejection. Unclassified upstream failures, provider rate limits, local capacity limits, and timeouts remain retryable 503 errors. These 400 responses follow ordinary idempotency caching: the same key and body replay the stored rejection while the record is retained. Use a new key when changing the amount, or to request a fresh quote after the provider restriction has been resolved. This differs from the existing 403 screening-rejection retry exception. With affiliateErrorMode=specific, registered affiliate lookup failures return affiliate_not_found or affiliate_disabled. A quote whose source is an unlisted token without refundAddress returns invalid_request. A destination BOLT11 invoice that has expired returns `destination_bolt11_expired`; one with less than 20 seconds of life left returns `invoice_expiring_soon`. A source or destination named by token address can also return invalid_token_address, token_not_found, token_unsupported (including a Solana mint with refused extensions), token_blocked, insufficient_liquidity (no route reaches or leaves the token), unsupported_amount_mode (exact_out and fixed delivery), amount_too_large (the order cap, valued in the hub the token is swapped with), or route_unavailable (chain or account not enabled for that end).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden or address screening rejection (`sanctioned_address` / `screening_blocked`). If retrying after a screening rejection, use the same idempotency key and request body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Idempotency conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limited (`rate_limited`); see the [rate-limits guide](/api/rate-limits). Retry after Retry-After seconds when present (per-key limiter only), otherwise at X-RateLimit-Reset, an absolute epoch timestamp in milliseconds; both limiters also return X-RateLimit-Limit and X-RateLimit-Remaining.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Address screening is temporarily unavailable (`screening_unavailable`), quote preparation is pending (`quote_preparation_pending`), or pricing is temporarily unavailable (`estimate_unavailable`). Retry with the same idempotency key and request body, respecting Retry-After when present. Token metadata could not be read from the chain (`token_metadata_unavailable`); retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/orchestration/offramp":{"post":{"summary":"Create Lightning offramp quote","description":"Create an exact-in, variable quote to a Cash App username or Lightning address. Returns the normal quote response and deposit instructions; paying creates the order. The recipient is resolved at delivery, so an unavailable account or an amount outside its limits can fail after funding. Completion confirms Lightning delivery. Cash App USD conversion depends on the recipient setting and is not guaranteed. Successful idempotency replays recheck the frozen quote recipient, refund and fee addresses against the current OFAC list without overwriting the successful quote or creating a replacement.","operationId":"postV1OrchestrationOfframp","security":[{"bearerAuth":[]}],"tags":["Orchestration"],"x-group":"Orchestration","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrchestrationOfframpRequest"},"example":{"sourceChain":"solana","sourceAsset":"USDC","amount":"50000000","recipientAddress":"$username","refundAddress":"YOUR_SOURCE_CHAIN_REFUND_ADDRESS"}}}},"responses":{"200":{"description":"Quote created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrchestrationQuoteResponse"},"examples":{"success":{"summary":"Lightning offramp deposit quote","value":{"amountMode":"exact_in","estimatedOut":"49500","feeAmount":"250000","roundingFeeAmount":"0","totalFeeAmount":"250000","feeBps":50,"feeAsset":"USDC","route":["USDC","USDB","BTC"],"quoteId":"q_7e450ab4-935b-4f8d-a6c4-4987a3cd2831","depositAddress":"7EcDhSYGxXyscszYEp35KHN8vvw3svAuLKTzXwCFLtV","amountIn":"50000000","expiresAt":"2026-09-12T12:02:00.000Z","source":{"chain":"solana","asset":"USDC","assetDisplayName":"USDC","assetDisplaySymbol":"USDC","contractAddress":"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v","decimals":6,"chainId":"solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp","chainDisplayName":"Solana","chainIcon":"/chain-solana.svg"},"destination":{"chain":"lightning","asset":"BTC","assetDisplayName":"Bitcoin","assetDisplaySymbol":"BTC","contractAddress":null,"decimals":8,"chainId":null,"chainDisplayName":"Lightning","chainIcon":"/chain-lightning.svg"}}}}}}},"400":{"description":"Invalid request or unsupported route. A confirmed provider policy refusal returns `provider_policy_rejected` (400). It does not identify the refused address or establish that an address belongs to the caller. A confirmed minimum-amount refusal returns `amount_too_small`; any stated dollar minimum is USD swap value, not source-token units. For ordinary variable exact-in Zcash requests, a proven input below the remaining enabled source rail minimum returns `amount_too_small` before a disabled-provider error. Passing this minimum does not establish route availability. Conclusive source-route exhaustion with differing refusal reasons returns `xchain_source_route_unavailable` (400), without asserting unanimous policy rejection. Unclassified upstream failures, provider rate limits, local capacity limits, and timeouts remain retryable 503 errors. These 400 responses follow ordinary idempotency caching: the same key and body replay the stored rejection while the record is retained. Use a new key when changing the amount, or to request a fresh quote after the provider restriction has been resolved. This differs from the existing 403 screening-rejection retry exception.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden or address screening rejection (`sanctioned_address` / `screening_blocked`). If retrying after a screening rejection, use the same idempotency key and request body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Idempotency conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limited (`rate_limited`); see the [rate-limits guide](/api/rate-limits). Retry after Retry-After seconds when present (per-key limiter only), otherwise at X-RateLimit-Reset, an absolute epoch timestamp in milliseconds; both limiters also return X-RateLimit-Limit and X-RateLimit-Remaining.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Address screening is temporarily unavailable (`screening_unavailable`), or quote preparation is pending (`quote_preparation_pending`). Retry with the same idempotency key and request body, respecting Retry-After when present.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/orchestration/submit":{"post":{"summary":"Submit deposit proof","description":"Attach a deposit transaction to a quote when automatic detection missed it. For shielded quotes, submit is only an authenticated status lookup: verified private receipt publication must already bind the order, otherwise 409 shielded_receipt_pending is returned. A caller-supplied transaction hash never credits a shielded deposit. Returns the existing order if one exists. New submit-created orders require independently verified positive funding in the exact source asset to the quote-assigned destination, including provider source addresses and their memo/tag; pending or unavailable proof returns 503 without an orderId. Canonical Lightning submits register the quote invoice for settlement watching without a caller-supplied funding identifier. Canonical Monero/Wagyu admits completed provider custody plus an independently verified and atomically reserved public USDC fill; its private XMR source amount is explicitly provider-attested. Retry the same body and idempotency key after Retry-After seconds. Positive underpayments remain subject to the worker's amount and delivery-floor checks. Terminal order replay does not restart execution. An order may be held in awaiting_approval for screening review. Track the existing order using /v1/orchestration/status; a screening hold does not initiate a refund.","operationId":"postV1OrchestrationSubmit","security":[{"bearerAuth":[]}],"tags":["Orchestration"],"x-group":"Orchestration","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrchestrationSubmitRequest"}}}},"responses":{"200":{"description":"Order created or replayed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrchestrationSubmitResponse"},"examples":{"success":{"summary":"Deposit awaiting confirmation","value":{"orderId":"ord_b91bbf90-42dc-4fe3-9b15-1d2c7e19cce6","status":"confirming"}}}}}},"400":{"description":"Invalid request or a transaction without a positive matching deposit (`xchain_deposit_mismatch`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limited (`rate_limited`); see the [rate-limits guide](/api/rate-limits). Retry after Retry-After seconds when present (per-key limiter only), otherwise at X-RateLimit-Reset, an absolute epoch timestamp in milliseconds; both limiters also return X-RateLimit-Limit and X-RateLimit-Remaining.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Deposit is not yet confirmed (`xchain_deposit_pending`) or verification is unavailable (`xchain_deposit_verification_unavailable`). Unverified deposits do not create an order. A retry may also reconcile an already funded order after interrupted materialization. Retry with the same body and idempotency key after Retry-After seconds; these responses are not cached.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/orchestration/onramp":{"post":{"summary":"Create onramp order","description":"Quote and order in one call for a Lightning payment into any destination. Address screening may reject the request with 403, return 503 when screening is unavailable, or hold the created order in awaiting_approval for review. Track the existing order using /v1/orchestration/status.","operationId":"postV1OrchestrationOnramp","security":[{"bearerAuth":[]}],"tags":["Orchestration"],"x-group":"Orchestration","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrchestrationOnrampRequest"},"example":{"destinationChain":"spark","destinationAsset":"USDB","recipientAddress":"RECIPIENT_ADDRESS","amountFiatUsd":"50.00"}}}},"responses":{"200":{"description":"Quote and order created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrchestrationOnrampResponse"},"examples":{"success":{"summary":"Lightning onramp order","value":{"amountMode":"exact_in","estimatedOut":"99000000","feeAmount":"500000","roundingFeeAmount":"0","totalFeeAmount":"500000","feeBps":50,"feeAsset":"USDC","route":["BTC","USDB","USDC"],"quoteId":"q_7e450ab4-935b-4f8d-a6c4-4987a3cd2831","depositAddress":"lnbc1pvjluezsp5zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zygspp5qqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqypqdpl2pkx2ctnv5sxxmmwwd5kgetjypeh2ursdae8g6twvus8g6rfwvs8qun0dfjkxaq9qrsgq357wnc5r2ueh7ck6q93dj32dlqnls087fxdwk8qakdyafkq3yap9us6v52vjjsrvywa6rt52cm9r9zqt8r2t7mlcwspyetp5h2tztugp9lfyql","amountIn":"100000","expiresAt":"2026-09-12T12:02:00.000Z","orderId":"ord_b91bbf90-42dc-4fe3-9b15-1d2c7e19cce6","paymentLinks":{"cashApp":"https://cash.app/launch/lightning/lnbc1pvjluezsp5zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zygspp5qqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqypqdpl2pkx2ctnv5sxxmmwwd5kgetjypeh2ursdae8g6twvus8g6rfwvs8qun0dfjkxaq9qrsgq357wnc5r2ueh7ck6q93dj32dlqnls087fxdwk8qakdyafkq3yap9us6v52vjjsrvywa6rt52cm9r9zqt8r2t7mlcwspyetp5h2tztugp9lfyql"},"effectiveSlippageBps":1000}}}}}},"202":{"description":"Order retained for screening review","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrchestrationSubmitResponse"},"examples":{"success":{"summary":"Created order retained for screening review","value":{"orderId":"ord_b91bbf90-42dc-4fe3-9b15-1d2c7e19cce6","status":"paused"}}}}}},"400":{"description":"Invalid request or unsupported route. A confirmed provider policy refusal returns `provider_policy_rejected` (400). It does not identify the refused address or establish that an address belongs to the caller. A confirmed minimum-amount refusal returns `amount_too_small`; any stated dollar minimum is USD swap value, not source-token units. For ordinary variable exact-in Zcash requests, a proven input below the remaining enabled source rail minimum returns `amount_too_small` before a disabled-provider error. Passing this minimum does not establish route availability. Conclusive source-route exhaustion with differing refusal reasons returns `xchain_source_route_unavailable` (400), without asserting unanimous policy rejection. Unclassified upstream failures, provider rate limits, local capacity limits, and timeouts remain retryable 503 errors. These 400 responses follow ordinary idempotency caching: the same key and body replay the stored rejection while the record is retained. Use a new key when changing the amount, or to request a fresh quote after the provider restriction has been resolved. This differs from the existing 403 screening-rejection retry exception.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limited (`rate_limited`); see the [rate-limits guide](/api/rate-limits). Retry after Retry-After seconds when present (per-key limiter only), otherwise at X-RateLimit-Reset, an absolute epoch timestamp in milliseconds; both limiters also return X-RateLimit-Limit and X-RateLimit-Remaining.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/orchestration/zeroconf/accept":{"post":{"summary":"Accept ZeroConf offer","description":"Accept a pending ZeroConf offer and credit the deposit before confirmation.","operationId":"postV1OrchestrationZeroconfAccept","security":[{"bearerAuth":[]}],"tags":["Orchestration"],"x-group":"Orchestration","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrchestrationZeroconfAcceptRequest"}}}},"responses":{"200":{"description":"0-conf offer accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrchestrationSubmitResponse"},"examples":{"success":{"summary":"Accepted offer resumes processing","value":{"orderId":"ord_b91bbf90-42dc-4fe3-9b15-1d2c7e19cce6","status":"processing"}}}}}},"400":{"description":"Invalid request or state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/orchestration/zeroconf/decline":{"post":{"summary":"Decline ZeroConf offer","description":"Decline a pending ZeroConf offer and wait for one confirmation.","operationId":"postV1OrchestrationZeroconfDecline","security":[{"bearerAuth":[]}],"tags":["Orchestration"],"x-group":"Orchestration","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrchestrationZeroconfDeclineRequest"}}}},"responses":{"200":{"description":"0-conf offer declined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrchestrationSubmitResponse"},"examples":{"success":{"summary":"Declined offer waits for confirmation","value":{"orderId":"ord_b91bbf90-42dc-4fe3-9b15-1d2c7e19cce6","status":"confirming"}}}}}},"400":{"description":"Invalid request or state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/orchestration/status":{"get":{"summary":"Get order status","description":"Authenticated order state by exactly one of id, quoteId, or txHash; client keys require id or quoteId with a matching read token.","operationId":"getV1OrchestrationStatus","security":[{"bearerAuth":[]}],"tags":["Orchestration"],"x-group":"Orchestration","parameters":[{"schema":{"type":"string"},"required":false,"name":"id","in":"query"},{"schema":{"type":"string"},"required":false,"name":"quoteId","in":"query"},{"schema":{"type":"string","enum":["true"],"description":"Independent opt-in with id or quoteId. Includes private-account aggregate funding progress, including order:null before materialization. Does not change includeFunding provider outcomes."},"required":false,"description":"Independent opt-in with id or quoteId. Includes private-account aggregate funding progress, including order:null before materialization. Does not change includeFunding provider outcomes.","name":"includeShieldedFunding","in":"query"},{"schema":{"type":"string","enum":["true"],"description":"Quote selector only. Include retained provider outcomes and allow order:null when a report exists before order creation. Unfunded/unknown quotes still return 404."},"required":false,"description":"Quote selector only. Include retained provider outcomes and allow order:null when a report exists before order creation. Unfunded/unknown quotes still return 404.","name":"includeFunding","in":"query"},{"schema":{"type":"string"},"required":false,"name":"txHash","in":"query"},{"schema":{"$ref":"#/components/schemas/Chain"},"required":false,"name":"sourceChain","in":"query"},{"schema":{"type":"string","description":"Matching read token for client-key lookups by `id` or `quoteId`."},"required":false,"description":"Matching read token for client-key lookups by `id` or `quoteId`.","name":"readToken","in":"query"}],"responses":{"200":{"description":"Order status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrchestrationStatusResponse"},"examples":{"success":{"summary":"Completed order","value":{"order":{"id":"ord_b91bbf90-42dc-4fe3-9b15-1d2c7e19cce6","type":"order","quoteId":"q_7e450ab4-935b-4f8d-a6c4-4987a3cd2831","status":"completed","sourceChain":"bitcoin","sourceAsset":"BTC","destinationChain":"solana","destinationAsset":"USDC","depositAddress":"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh","recipientAddress":"7EcDhSYGxXyscszYEp35KHN8vvw3svAuLKTzXwCFLtV","amountIn":"100000","amountOut":"99000000","feeAmount":"500000","feeAsset":"USDC","feeBps":50,"slippageBps":100,"createdAt":"2026-09-12T12:00:00.000Z","updatedAt":"2026-09-12T12:04:00.000Z","completedAt":"2026-09-12T12:04:00.000Z"},"stages":[{"name":"completed","status":"completed","completedAt":"2026-09-12T12:04:00.000Z"}]}}}}}},"400":{"description":"Invalid query","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limited (`rate_limited`); see the [rate-limits guide](/api/rate-limits). Retry after Retry-After seconds when present (per-key limiter only), otherwise at X-RateLimit-Reset, an absolute epoch timestamp in milliseconds; both limiters also return X-RateLimit-Limit and X-RateLimit-Remaining.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/orchestration/order":{"get":{"summary":"Get quote and order","description":"Quote, optional order, and retained provider funding outcomes. An absent order does not imply an absent deposit. quote may be null after cleanup when a funding report survives. Server key.","operationId":"getV1OrchestrationOrder","security":[{"bearerAuth":[]}],"tags":["Orchestration"],"x-group":"Orchestration","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"quoteId","in":"query"}],"responses":{"200":{"description":"Quote plus associated order","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrchestrationOrderResponse"},"examples":{"success":{"summary":"Quote and completed order","value":{"quote":{"id":"q_7e450ab4-935b-4f8d-a6c4-4987a3cd2831","kind":"sell","sourceChain":"bitcoin","sourceAsset":"BTC","destinationChain":"solana","destinationAsset":"USDC","amountIn":"100000","estimatedOut":"99000000","feeBps":50,"feeAmount":"500000","feeAsset":"USDC","roundingFeeAmount":"0","depositAddress":"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh","recipientAddress":"7EcDhSYGxXyscszYEp35KHN8vvw3svAuLKTzXwCFLtV","slippageBps":100,"expiresAt":"2026-09-12T12:02:00.000Z","expired":true,"createdAt":"2026-09-12T12:00:00.000Z"},"order":{"id":"ord_b91bbf90-42dc-4fe3-9b15-1d2c7e19cce6","type":"order","quoteId":"q_7e450ab4-935b-4f8d-a6c4-4987a3cd2831","status":"completed","sourceChain":"bitcoin","sourceAsset":"BTC","destinationChain":"solana","destinationAsset":"USDC","depositAddress":"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh","recipientAddress":"7EcDhSYGxXyscszYEp35KHN8vvw3svAuLKTzXwCFLtV","amountIn":"100000","amountOut":"99000000","feeAmount":"500000","feeAsset":"USDC","feeBps":50,"slippageBps":100,"createdAt":"2026-09-12T12:00:00.000Z","updatedAt":"2026-09-12T12:04:00.000Z","completedAt":"2026-09-12T12:04:00.000Z"},"stages":[{"name":"completed","status":"completed","completedAt":"2026-09-12T12:04:00.000Z"}]}}}}}},"400":{"description":"Invalid query","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limited (`rate_limited`); see the [rate-limits guide](/api/rate-limits). Retry after Retry-After seconds when present (per-key limiter only), otherwise at X-RateLimit-Reset, an absolute epoch timestamp in milliseconds; both limiters also return X-RateLimit-Limit and X-RateLimit-Remaining.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/orchestration/history":{"get":{"summary":"List order history","description":"The partner's orders filtered by recipient address, by the partner's own order tag, or both (at least one is required). Newest first; paused orders are hidden unless status is given. Server key.","operationId":"getV1OrchestrationHistory","security":[{"bearerAuth":[]}],"tags":["Orchestration"],"x-group":"Orchestration","parameters":[{"schema":{"type":"string","minLength":1,"description":"Recipient address to filter by."},"required":false,"description":"Recipient address to filter by.","name":"address","in":"query"},{"schema":{"type":"string","pattern":"^[A-Za-z0-9._:-]{1,64}$","description":"Partner order tag to filter by, as set on the quote or onramp."},"required":false,"description":"Partner order tag to filter by, as set on the quote or onramp.","name":"tag","in":"query"},{"schema":{"type":"string"},"required":false,"name":"status","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":200},"required":false,"name":"limit","in":"query"},{"schema":{"type":"integer","minimum":0},"required":false,"name":"offset","in":"query"}],"responses":{"200":{"description":"Order history","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrchestrationHistoryResponse"},"examples":{"success":{"summary":"Recipient order history","value":{"orders":[{"id":"ord_b91bbf90-42dc-4fe3-9b15-1d2c7e19cce6","type":"order","quoteId":"q_7e450ab4-935b-4f8d-a6c4-4987a3cd2831","status":"completed","sourceChain":"bitcoin","sourceAsset":"BTC","destinationChain":"solana","destinationAsset":"USDC","depositAddress":"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh","recipientAddress":"7EcDhSYGxXyscszYEp35KHN8vvw3svAuLKTzXwCFLtV","amountIn":"100000","amountOut":"99000000","feeAmount":"500000","feeAsset":"USDC","feeBps":50,"slippageBps":100,"createdAt":"2026-09-12T12:00:00.000Z","updatedAt":"2026-09-12T12:04:00.000Z","completedAt":"2026-09-12T12:04:00.000Z"}]}}}}}},"400":{"description":"Invalid query","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/accumulation-addresses":{"post":{"summary":"Create accumulation address","description":"Legacy address model; new integrations use standing deposit addresses. Create accumulation address. HyperCore source address creation is unavailable until independent deposit verification is supported; existing addresses require reconciliation.","deprecated":true,"operationId":"postV1AccumulationAddresses","security":[{"bearerAuth":[]}],"tags":["Accumulation Addresses"],"x-group":"Accumulation Addresses","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccumulationAddressCreateRequest"}}}},"responses":{"200":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccumulationAddressCreateResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"get":{"summary":"List accumulation addresses","description":"Legacy address model; new integrations use standing deposit addresses. List accumulation addresses.","deprecated":true,"operationId":"getV1AccumulationAddresses","security":[{"bearerAuth":[]}],"tags":["Accumulation Addresses"],"x-group":"Accumulation Addresses","parameters":[{"schema":{"type":"integer","minimum":1,"maximum":200},"required":false,"name":"limit","in":"query"},{"schema":{"type":"integer","minimum":0},"required":false,"name":"offset","in":"query"}],"responses":{"200":{"description":"List","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccumulationAddressListResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/accumulation-addresses/{idOrAddress}/reindex":{"post":{"summary":"Reindex accumulation address","description":"Legacy address model; new integrations use standing deposit addresses. Reindex accumulation address.","deprecated":true,"operationId":"postV1AccumulationAddressesIdOrAddressReindex","security":[{"bearerAuth":[]}],"tags":["Accumulation Addresses"],"x-group":"Accumulation Addresses","parameters":[{"schema":{"type":"string","minLength":1,"description":"Deposit address or accumulation address ID."},"required":true,"description":"Deposit address or accumulation address ID.","name":"idOrAddress","in":"path"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Idempotency-Key","in":"header"}],"responses":{"200":{"description":"Reindex result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccumulationAddressReindexResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"502":{"description":"Upstream service unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Upstream service unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/accumulation-addresses/sync":{"post":{"summary":"Sync accumulation webhooks","description":"Legacy address model; new integrations use standing deposit addresses. Sync accumulation webhooks.","deprecated":true,"operationId":"postV1AccumulationAddressesSync","security":[{"bearerAuth":[]}],"tags":["Accumulation Addresses"],"x-group":"Accumulation Addresses","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Idempotency-Key","in":"header"}],"responses":{"200":{"description":"Sync result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccumulationAddressSyncResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/accumulation-addresses/{id}/deposits":{"get":{"summary":"List held accumulation credits","description":"Held Relay settlement credits with independently retained ownership for this accumulation address. Unidentified shared-custody credits are excluded, so an empty list does not establish that no deposit exists. Amounts describe observed Solana USDC credit. Requires a server key.","operationId":"getV1AccumulationAddressesIdDeposits","deprecated":true,"security":[{"bearerAuth":[]}],"tags":["Accumulation Addresses"],"x-group":"Accumulation Addresses","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":200},"required":false,"name":"limit","in":"query"},{"schema":{"type":"integer","minimum":0,"maximum":1000000},"required":false,"name":"offset","in":"query"}],"responses":{"200":{"description":"Held credits","content":{"application/json":{"schema":{"type":"object","properties":{"deposits":{"type":"array","items":{"type":"object","properties":{"addressType":{"type":"string","enum":["accumulation"]},"addressId":{"type":"string"},"depositId":{"type":"string"},"state":{"type":"string","enum":["held"]},"observedCredit":{"type":"object","properties":{"chain":{"type":"string","enum":["solana"]},"asset":{"type":"string","enum":["USDC"]},"amount":{"type":"string"},"confirmationState":{"type":"string","enum":["confirmed"]}},"required":["chain","asset","amount","confirmationState"]},"reason":{"type":"string","enum":["awaiting_proof","needs_review"]},"observedAt":{"type":"string","format":"date-time"}},"required":["addressType","addressId","depositId","state","observedCredit","reason","observedAt"]}},"nextOffset":{"type":["integer","null"]}},"required":["deposits","nextOffset"]}}}},"400":{"description":"Invalid pagination","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/accumulation-addresses/{id}":{"get":{"summary":"Get accumulation address","description":"Legacy address model; new integrations use standing deposit addresses. Get accumulation address.","deprecated":true,"operationId":"getV1AccumulationAddressesId","security":[{"bearerAuth":[]}],"tags":["Accumulation Addresses"],"x-group":"Accumulation Addresses","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Record","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccumulationAddressGetResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"summary":"Delete accumulation address","description":"Legacy address model; new integrations use standing deposit addresses. Delete accumulation address.","deprecated":true,"operationId":"deleteV1AccumulationAddressesId","security":[{"bearerAuth":[]}],"tags":["Accumulation Addresses"],"x-group":"Accumulation Addresses","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Idempotency-Key","in":"header"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OkResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/liquidation-addresses":{"post":{"summary":"Create liquidation address","description":"Legacy address model; new integrations use standing deposit addresses. Create liquidation address.","deprecated":true,"operationId":"postV1LiquidationAddresses","security":[{"bearerAuth":[]}],"tags":["Liquidations"],"x-group":"Liquidations","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LiquidationAddressCreateRequest"}}}},"responses":{"200":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LiquidationAddressRecord"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"get":{"summary":"List liquidation addresses","description":"Legacy address model; new integrations use standing deposit addresses. List liquidation addresses.","deprecated":true,"operationId":"getV1LiquidationAddresses","security":[{"bearerAuth":[]}],"tags":["Liquidations"],"x-group":"Liquidations","parameters":[{"schema":{"type":"integer","minimum":1,"maximum":200},"required":false,"name":"limit","in":"query"},{"schema":{"type":"integer","minimum":0},"required":false,"name":"offset","in":"query"}],"responses":{"200":{"description":"List","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LiquidationAddressListResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/liquidation-addresses/orders":{"get":{"summary":"List liquidation orders","description":"Legacy address model; new integrations use standing deposit addresses. List liquidation orders.","deprecated":true,"operationId":"getV1LiquidationAddressesOrders","security":[{"bearerAuth":[]}],"tags":["Liquidations"],"x-group":"Liquidations","parameters":[{"schema":{"type":"string","minLength":1},"required":false,"name":"id","in":"query"},{"schema":{"type":"string","minLength":1},"required":false,"name":"label","in":"query"},{"schema":{"type":"string"},"required":false,"name":"status","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":200},"required":false,"name":"limit","in":"query"},{"schema":{"type":"integer","minimum":0},"required":false,"name":"offset","in":"query"}],"responses":{"200":{"description":"Orders","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LiquidationOrdersResponse"}}}},"400":{"description":"Invalid query","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/liquidation-addresses/{id}":{"get":{"summary":"Get liquidation address","description":"Legacy address model; new integrations use standing deposit addresses. Get liquidation address.","deprecated":true,"operationId":"getV1LiquidationAddressesId","security":[{"bearerAuth":[]}],"tags":["Liquidations"],"x-group":"Liquidations","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Record","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LiquidationAddressRecord"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"summary":"Delete liquidation address","description":"Legacy address model; new integrations use standing deposit addresses. Delete liquidation address.","deprecated":true,"operationId":"deleteV1LiquidationAddressesId","security":[{"bearerAuth":[]}],"tags":["Liquidations"],"x-group":"Liquidations","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Idempotency-Key","in":"header"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OkResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/affiliates/{affiliateId}":{"get":{"summary":"Get affiliate","description":"Read one affiliate owned by the authenticated partner, including disabled profiles. Requires a server key; client keys are denied. The ID is trimmed and lowercased. No idempotency key is required.","operationId":"getV1AffiliatesAffiliateId","security":[{"bearerAuth":[]}],"tags":["Affiliates"],"x-group":"Affiliates","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":64},"required":true,"name":"affiliateId","in":"path"}],"responses":{"200":{"description":"Affiliate profile including enabled and disabledAt state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateUpsertResponse"}}}},"400":{"description":"Invalid affiliate ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Client keys are not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"affiliate_not_found: no affiliate with this ID belongs to the authenticated partner","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"put":{"summary":"Upsert affiliate","description":"Create or update an affiliate profile and payout destination.","operationId":"putV1AffiliatesAffiliateId","security":[{"bearerAuth":[]}],"tags":["Affiliates"],"x-group":"Affiliates","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"affiliateId","in":"path"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateUpsertRequest"}}}},"responses":{"200":{"description":"Affiliate upserted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateUpsertResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"summary":"Disable affiliate","description":"Disable an affiliate.","operationId":"deleteV1AffiliatesAffiliateId","security":[{"bearerAuth":[]}],"tags":["Affiliates"],"x-group":"Affiliates","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"affiliateId","in":"path"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Idempotency-Key","in":"header"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OkResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/affiliates":{"get":{"summary":"List affiliates","description":"Affiliate profiles.","operationId":"getV1Affiliates","security":[{"bearerAuth":[]}],"tags":["Affiliates"],"x-group":"Affiliates","parameters":[{"schema":{"type":"boolean"},"required":false,"name":"includeDisabled","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000},"required":false,"name":"limit","in":"query"},{"schema":{"type":"integer","minimum":0},"required":false,"name":"offset","in":"query"}],"responses":{"200":{"description":"Affiliate list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateListResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/affiliates/{affiliateId}/claim":{"post":{"summary":"Claim affiliate balance","description":"Claim the full available balance in one custody and frozen payout bucket. Pass claimBucketId from affiliate stats to select an exact bucket. Without it, select the oldest claimable bucket within the chosen settlement and frozen payout destination. Missing legacy payout details are filled only when existing details match the selected destination; conflicting rows remain unclaimed. A below-minimum refusal identifies another eligible snapshotted balance's claimBucketId and saved recipient when available in the same settlement. Select that ID explicitly with a new X-Idempotency-Key; availability and the payout quote are rechecked.","operationId":"postV1AffiliatesAffiliateIdClaim","security":[{"bearerAuth":[]}],"tags":["Affiliates"],"x-group":"Affiliates","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"affiliateId","in":"path"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Idempotency-Key","in":"header"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateClaimCreateRequest"}}}},"responses":{"201":{"description":"Claim created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateClaimResponse"}}}},"400":{"description":"Invalid request or insufficient balance","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Payout path quote temporarily unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/affiliates/{affiliateId}/claims":{"get":{"summary":"List affiliate claims","description":"Claims for an affiliate.","operationId":"getV1AffiliatesAffiliateIdClaims","security":[{"bearerAuth":[]}],"tags":["Affiliates"],"x-group":"Affiliates","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"affiliateId","in":"path"},{"schema":{"type":"string","minLength":1},"required":false,"name":"settlementChain","in":"query"},{"schema":{"type":"string","minLength":1},"required":false,"name":"settlementAsset","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":200},"required":false,"name":"limit","in":"query"},{"schema":{"type":"integer","minimum":0},"required":false,"name":"offset","in":"query"}],"responses":{"200":{"description":"Claim list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateClaimListResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/affiliates/{affiliateId}/claims/{id}":{"get":{"summary":"Get affiliate claim","description":"One claim.","operationId":"getV1AffiliatesAffiliateIdClaimsId","security":[{"bearerAuth":[]}],"tags":["Affiliates"],"x-group":"Affiliates","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"affiliateId","in":"path"},{"schema":{"type":"string","minLength":1},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Claim record","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateClaimResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/webhooks":{"get":{"summary":"List webhooks","description":"Registered endpoints.","operationId":"getV1Webhooks","security":[{"bearerAuth":[]}],"tags":["Webhooks"],"x-group":"Webhooks","responses":{"200":{"description":"Enabled webhook endpoints","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookListResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"Register webhook","description":"Register an endpoint. The signing secret is returned once.","operationId":"postV1Webhooks","security":[{"bearerAuth":[]}],"tags":["Webhooks"],"x-group":"Webhooks","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCreateRequest"},"example":{"url":"https://example.com/webhooks/flashnet"}}}},"responses":{"200":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCreateResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/webhooks/{id}":{"delete":{"summary":"Delete webhook","description":"Disable an endpoint.","operationId":"deleteV1WebhooksId","security":[{"bearerAuth":[]}],"tags":["Webhooks"],"x-group":"Webhooks","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Idempotency-Key","in":"header"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OkResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/webhooks/recovery":{"get":{"summary":"List recovery webhooks","description":"Registered recovery endpoints.","operationId":"getV1WebhooksRecovery","security":[{"bearerAuth":[]}],"tags":["Webhooks"],"x-group":"Webhooks","responses":{"200":{"description":"Enabled recovery webhook endpoints","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookListResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"Register recovery webhook","description":"Register an endpoint for order.recovery_required events.","operationId":"postV1WebhooksRecovery","security":[{"bearerAuth":[]}],"tags":["Webhooks"],"x-group":"Webhooks","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCreateRequest"},"example":{"url":"https://example.com/webhooks/flashnet"}}}},"responses":{"200":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCreateResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/webhooks/recovery/{id}":{"delete":{"summary":"Delete recovery webhook","description":"Disable a recovery endpoint.","operationId":"deleteV1WebhooksRecoveryId","security":[{"bearerAuth":[]}],"tags":["Webhooks"],"x-group":"Webhooks","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Idempotency-Key","in":"header"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OkResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/webhooks/funding":{"get":{"summary":"List funding webhooks","description":"Registered funding endpoints.","operationId":"getV1WebhooksFunding","security":[{"bearerAuth":[]}],"tags":["Webhooks"],"x-group":"Webhooks","responses":{"200":{"description":"Enabled funding webhook endpoints","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookListResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"Register funding webhook","description":"Register an endpoint for funding.updated reports before order creation. These are provider reports, not verified customer refunds. Historical reports are not sent automatically.","operationId":"postV1WebhooksFunding","security":[{"bearerAuth":[]}],"tags":["Webhooks"],"x-group":"Webhooks","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCreateRequest"},"example":{"url":"https://example.com/webhooks/flashnet"}}}},"responses":{"200":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCreateResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/webhooks/funding/{id}":{"delete":{"summary":"Delete funding webhook","description":"Disable a funding endpoint.","operationId":"deleteV1WebhooksFundingId","security":[{"bearerAuth":[]}],"tags":["Webhooks"],"x-group":"Webhooks","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Idempotency-Key","in":"header"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OkResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/webhooks/ingress":{"get":{"summary":"List held-deposit webhooks","description":"Registered held-deposit endpoints.","operationId":"getV1WebhooksIngress","security":[{"bearerAuth":[]}],"tags":["Webhooks"],"x-group":"Webhooks","responses":{"200":{"description":"Enabled held-deposit webhook endpoints","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookListResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"Register held-deposit webhook","description":"Register an independent endpoint for ingress.held custody observations on accumulation and standing addresses. Events describe held credit, not delivery or a refund. Existing funding and order scopes are unchanged. Retained events are not replayed on subscription.","operationId":"postV1WebhooksIngress","security":[{"bearerAuth":[]}],"tags":["Webhooks"],"x-group":"Webhooks","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCreateRequest"},"example":{"url":"https://example.com/webhooks/flashnet"}}}},"responses":{"200":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCreateResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/webhooks/ingress/{id}":{"delete":{"summary":"Delete held-deposit webhook","description":"Disable a held-deposit endpoint.","operationId":"deleteV1WebhooksIngressId","security":[{"bearerAuth":[]}],"tags":["Webhooks"],"x-group":"Webhooks","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Idempotency-Key","in":"header"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OkResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/webhooks/shielded-funding":{"get":{"summary":"List shielded funding webhooks","description":"Registered shielded funding endpoints.","operationId":"getV1WebhooksShieldedFunding","security":[{"bearerAuth":[]}],"tags":["Webhooks"],"x-group":"Webhooks","responses":{"200":{"description":"Enabled shielded funding webhook endpoints","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookListResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"Register shielded funding webhook","description":"Register an endpoint for shielded_funding.updated aggregate private-account progress, including before order creation. Independent of ordinary status and funding.updated subscriptions. No viewing keys, notes or transaction identifiers are included. Historical reports are not sent automatically.","operationId":"postV1WebhooksShieldedFunding","security":[{"bearerAuth":[]}],"tags":["Webhooks"],"x-group":"Webhooks","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCreateRequest"},"example":{"url":"https://example.com/webhooks/flashnet"}}}},"responses":{"200":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCreateResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/webhooks/shielded-funding/{id}":{"delete":{"summary":"Delete shielded funding webhook","description":"Disable a shielded funding endpoint.","operationId":"deleteV1WebhooksShieldedFundingId","security":[{"bearerAuth":[]}],"tags":["Webhooks"],"x-group":"Webhooks","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Idempotency-Key","in":"header"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OkResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/partner/dashboard/operations":{"get":{"summary":"List partner operations","description":"List all orders for the authenticated partner with pagination, search, and optional affiliate, chain and tag filtering. Includes fee plan, fee payouts, total fee fields, and associated affiliate ids on each operation.","x-excluded":true,"operationId":"getV1PartnerDashboardOperations","security":[{"bearerAuth":[]}],"tags":["Dashboard"],"x-group":"Dashboard","parameters":[{"schema":{"type":"string","description":"Search query matching operation id, quote id, source tx hash, destination tx hash, or recipient address"},"required":false,"description":"Search query matching operation id, quote id, source tx hash, destination tx hash, or recipient address","name":"q","in":"query"},{"schema":{"type":"string","description":"Filter by operation status. When omitted, expired, paused, and unfulfilled orders are excluded."},"required":false,"description":"Filter by operation status. When omitted, expired, paused, and unfulfilled orders are excluded.","name":"status","in":"query"},{"schema":{"type":"string","description":"Filter to operations carrying a fee for this affiliate id."},"required":false,"description":"Filter to operations carrying a fee for this affiliate id.","name":"affiliateId","in":"query"},{"schema":{"type":"string","pattern":"^[A-Za-z0-9._:-]{1,64}$","description":"Filter to orders carrying exactly this tag."},"required":false,"description":"Filter to orders carrying exactly this tag.","name":"tag","in":"query"},{"schema":{"type":"string","enum":["true"],"description":"When true, keep only orders without a tag."},"required":false,"description":"When true, keep only orders without a tag.","name":"untagged","in":"query"},{"schema":{"type":"string","description":"Filter to operations whose source or destination chain matches this id. Public aliases such as hypercore also match the internally stored id."},"required":false,"description":"Filter to operations whose source or destination chain matches this id. Public aliases such as hypercore also match the internally stored id.","name":"chain","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":200,"description":"Page size (default 50)"},"required":false,"description":"Page size (default 50)","name":"limit","in":"query"},{"schema":{"type":"integer","minimum":0,"description":"Pagination offset (default 0)"},"required":false,"description":"Pagination offset (default 0)","name":"offset","in":"query"}],"responses":{"200":{"description":"Paginated operations list with fee breakdown","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardOperationsResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/partner/dashboard/operations/{id}":{"get":{"summary":"Get partner operation","description":"Get a single operation by ID for the authenticated partner.","x-excluded":true,"operationId":"getV1PartnerDashboardOperationsId","security":[{"bearerAuth":[]}],"tags":["Dashboard"],"x-group":"Dashboard","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Operation detail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardOperationDetailResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/affiliate-dashboard/{affiliateId}/orders":{"get":{"summary":"List affiliate orders","description":"List orders with affiliate fee entries for a given affiliate. Returns affiliate fee details joined with the corresponding operation data. Callable with a full server key, or with a client key that carries the affiliates:read scope and is pinned to exactly this affiliate.","x-excluded":true,"operationId":"getV1AffiliateDashboardAffiliateIdOrders","security":[{"bearerAuth":[]}],"tags":["Affiliate Dashboard"],"x-group":"Affiliate Dashboard","parameters":[{"schema":{"type":"string","minLength":1,"pattern":"^[a-z0-9][a-z0-9_-]{0,63}$","description":"Normalized affiliate ID"},"required":true,"description":"Normalized affiliate ID","name":"affiliateId","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":200,"description":"Page size (default 50)"},"required":false,"description":"Page size (default 50)","name":"limit","in":"query"},{"schema":{"type":"integer","minimum":0,"description":"Pagination offset (default 0)"},"required":false,"description":"Pagination offset (default 0)","name":"offset","in":"query"},{"schema":{"type":"string","description":"Exact-match search: order ID, quote ID, tx hash, or address (0x values match case-insensitively)"},"required":false,"description":"Exact-match search: order ID, quote ID, tx hash, or address (0x values match case-insensitively)","name":"q","in":"query"},{"schema":{"type":"string","description":"Filter by operation status"},"required":false,"description":"Filter by operation status","name":"status","in":"query"},{"schema":{"type":"string","description":"ISO 8601 inclusive lower bound on fee accrual time"},"required":false,"description":"ISO 8601 inclusive lower bound on fee accrual time","name":"dateFrom","in":"query"},{"schema":{"type":"string","description":"ISO 8601 exclusive upper bound on fee accrual time"},"required":false,"description":"ISO 8601 exclusive upper bound on fee accrual time","name":"dateTo","in":"query"}],"responses":{"200":{"description":"Paginated affiliate orders with fee details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateDashboardOrdersResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Client key missing the affiliates:read scope or not pinned to this affiliate","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Affiliate not found or disabled","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/affiliate-dashboard/{affiliateId}/metrics":{"get":{"summary":"Get affiliate metrics","description":"Range-scoped activity metrics for one affiliate: USD volume of completed orders carrying the affiliate's fee, accrued fees, order counts, and a bucketed time series. Same auth as the other affiliate-dashboard reads: full server key, or a client key with the affiliates:read scope pinned to this affiliate.","x-excluded":true,"operationId":"getV1AffiliateDashboardAffiliateIdMetrics","security":[{"bearerAuth":[]}],"tags":["Affiliate Dashboard"],"x-group":"Affiliate Dashboard","parameters":[{"schema":{"type":"string","minLength":1,"pattern":"^[a-z0-9][a-z0-9_-]{0,63}$","description":"Normalized affiliate ID"},"required":true,"description":"Normalized affiliate ID","name":"affiliateId","in":"path"},{"schema":{"type":"string","description":"ISO 8601 inclusive lower bound; omit for all time"},"required":false,"description":"ISO 8601 inclusive lower bound; omit for all time","name":"dateFrom","in":"query"},{"schema":{"type":"string","description":"ISO 8601 exclusive upper bound"},"required":false,"description":"ISO 8601 exclusive upper bound","name":"dateTo","in":"query"},{"schema":{"type":"string","description":"IANA timezone for series bucketing (default UTC)"},"required":false,"description":"IANA timezone for series bucketing (default UTC)","name":"tz","in":"query"}],"responses":{"200":{"description":"Affiliate activity metrics","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateDashboardMetricsResponse"}}}},"400":{"description":"Invalid date parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Client key missing the affiliates:read scope or not pinned to this affiliate","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Affiliate not found or disabled","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"webhooks":{}}