Create offramp quote

POST

orchestration

offramp

Create Lightning offramp quote

curl --request POST \
  --url https://orchestration.flashnet.xyz/v1/orchestration/offramp \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency-Key: <x-idempotency-key>' \
  --data '
{
  "sourceChain": "solana",
  "sourceAsset": "USDC",
  "amount": "50000000",
  "recipientAddress": "$username",
  "refundAddress": "YOUR_SOURCE_CHAIN_REFUND_ADDRESS"
}
'

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency-Key': '<x-idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    sourceChain: 'solana',
    sourceAsset: 'USDC',
    amount: '50000000',
    recipientAddress: '$username',
    refundAddress: 'YOUR_SOURCE_CHAIN_REFUND_ADDRESS'
  })
};

fetch('https://orchestration.flashnet.xyz/v1/orchestration/offramp', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://orchestration.flashnet.xyz/v1/orchestration/offramp"

payload = {
    "sourceChain": "solana",
    "sourceAsset": "USDC",
    "amount": "50000000",
    "recipientAddress": "$username",
    "refundAddress": "YOUR_SOURCE_CHAIN_REFUND_ADDRESS"
}
headers = {
    "X-Idempotency-Key": "<x-idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "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"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Partner API key in the form Authorization: Bearer fn_....

Headers

X-Idempotency-Key

string

required

Minimum string length: 1

Body

application/json

Exact-in variable Lightning payout. Unknown fields are rejected.

sourceChain

enum<string>

required

Available options:

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

sourceAsset

required

A canonical public asset symbol or a registry asset routing key. TON is a legacy input alias for ton:GRAM only; responses use GRAM.

Available options:

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,

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,

XPL,

XRP,

ZEC,

cbBTC,

tBTC

amount

string

required

Amount in smallest units of the source asset.

Pattern: ^[0-9]+$

recipientAddress

string

required

Cash App username (username or $username), or Lightning address (username@domain). Cash App usernames resolve to [email protected]. BOLT11 invoices and URLs are not accepted.

Minimum string length: 1

refundAddress

string

required

Required refund address on the source chain, or the supplied refundChain.

Minimum string length: 1

refundChain

enum<string>

Available options:

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

slippageBps

integer

Slippage tolerance in basis points, subject to the route minimum.

Required range: 0 <= x <= 1000

appFees

object[]

Inline app fees, requiring a server key or dashboard session.

Required array length: 1 - 16 elements

Show child attributes

affiliateId

string

Registered affiliate ID for accrued fees, also accepted from client keys.

affiliateIds

(string | object)[]

Registered affiliate IDs or fee overrides; mutually exclusive with appFees, with overrides requiring a server key or dashboard session.

Required array length: 1 - 16 elements

Registered affiliate ID or { affiliateId, feeBps } override.

Minimum string length: 1

Response

Quote created

quoteId

string

required

depositAddress

string

required

amountIn

string

required

estimatedOut

string

required

feeAmount

string

required

totalFeeAmount

string

required

feeAsset

string

required

feeBps

integer

required

route

string[]

required

expiresAt

string

required

reviewedAssets

object[]

Exact immutable reviewed token identities frozen by the native quote. Omitted for legacy or invalid snapshots; caller metadata cannot set these pins.

Required array length: 1 - 32 elements

Show child attributes

depositMemo

string

Memo or tag required with the deposit when present.

lightningReceiveRequestId

string

amountMode

enum<string>

Available options:

exact_in,

exact_out

targetAmountOut

string

requiredAmountIn

string

maxAcceptedAmountIn

string

inputBufferBps

integer

deliveryMode

enum<string>

Available options:

fixed

priceLockMode

enum<string>

Action required when the locked price can no longer be honored.

Available options:

strict_requote,

approval_required

lockedMinAmountOut

string

Minimum locked destination amount in smallest units.

roundingFeeAmount

string

networkCostAmount

string

Quoted network cost in smallest units of networkCostAsset.

networkCostAsset

string

Asset used to pay the quoted network cost.

networkCostRequired

boolean

Whether the quoted network cost must be paid.

networkCosts

object[]

Itemized network costs and quote-time assumptions.

Option 1
Option 2

Show child attributes

sweepFeeAmount

string

appFeeAmount

string

appFeePlatformCutAmount

string

appFees

object[]

Show child attributes

feeAssetDetails

object

Show child attributes

feeAmountUsd

string

totalFeeAmountUsd

string

readToken

string

Client-key read token for this quote and its order, including private ZeroConf outcomes.

⌘I

Create Lightning offramp quote

curl --request POST \
  --url https://orchestration.flashnet.xyz/v1/orchestration/offramp \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency-Key: <x-idempotency-key>' \
  --data '
{
  "sourceChain": "solana",
  "sourceAsset": "USDC",
  "amount": "50000000",
  "recipientAddress": "$username",
  "refundAddress": "YOUR_SOURCE_CHAIN_REFUND_ADDRESS"
}
'

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency-Key': '<x-idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    sourceChain: 'solana',
    sourceAsset: 'USDC',
    amount: '50000000',
    recipientAddress: '$username',
    refundAddress: 'YOUR_SOURCE_CHAIN_REFUND_ADDRESS'
  })
};

fetch('https://orchestration.flashnet.xyz/v1/orchestration/offramp', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://orchestration.flashnet.xyz/v1/orchestration/offramp"

payload = {
    "sourceChain": "solana",
    "sourceAsset": "USDC",
    "amount": "50000000",
    "recipientAddress": "$username",
    "refundAddress": "YOUR_SOURCE_CHAIN_REFUND_ADDRESS"
}
headers = {
    "X-Idempotency-Key": "<x-idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "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"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Get started

Endpoints

Create offramp quote

Authorizations

Headers

Body

Response