Create onramp order

Quote and order in one call for a Lightning payment into any destination. Hermod checks both phases independently. Enforced quote hits return 403; unhealthy screening controls, enforced invalid subjects or missing address evidence return 503. After order creation, enforced hits or missing/invalid address evidence retain the order in awaiting_approval status for operator review. Hermod service failures and unverified chain coverage log and continue. Log-only mode records results without a Hermod rejection or hold.

POST

orchestration

onramp

Create onramp order

curl --request POST \
  --url https://orchestration.flashnet.xyz/v1/orchestration/onramp \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency-Key: <x-idempotency-key>' \
  --data '
{
  "destinationChain": "spark",
  "destinationAsset": "USDB",
  "recipientAddress": "RECIPIENT_ADDRESS"
}
'

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency-Key': '<x-idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    destinationChain: 'spark',
    destinationAsset: 'USDB',
    recipientAddress: 'RECIPIENT_ADDRESS'
  })
};

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

import requests

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

payload = {
    "destinationChain": "spark",
    "destinationAsset": "USDB",
    "recipientAddress": "RECIPIENT_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": "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
}

{
  "orderId": "ord_b91bbf90-42dc-4fe3-9b15-1d2c7e19cce6",
  "status": "paused"
}

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

Unsupported top-level and refund fields are ignored and returned in ignoredFields.

destinationChain

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

destinationAsset

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,

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

recipientAddress

string

required

Destination recipient; use the owner address for Solana tokens; sanctioned addresses are rejected.

Minimum string length: 1

amount

string

Amount in smallest units; exact_out uses the destination asset and whole cents for stablecoins; mutually exclusive with amountFiatUsd.

Pattern: ^[0-9]+$

amountFiatUsd

string

USD amount paid through Cash App or Strike, converted to sats at request time; read current bounds from /v1/orchestration/limits.

Pattern: ^(?:0|[1-9][0-9]*)(?:\.[0-9]{1,2})?$

amountMode

enum<string>

exact_out pins the destination amount and requires whole cents for stablecoins.

Available options:

exact_in,

exact_out

deliveryMode

enum<string>

Requested delivery mode; fixed applies only to eligible exact_in onramps and is echoed when applied.

Available options:

variable,

fixed

slippageBps

integer

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

Required range: 0 <= x <= 1000

descriptionHash

string

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.

Pattern: ^[0-9a-fA-F]{64}$

refundAddress

string

Lightning address or amountless BOLT11 refund invoice; unsupported values appear in ignoredFields, and pre-swap failures without a target report refund_address_missing.

Minimum string length: 1

refundChain

enum<string>

Lightning refund chain, inferred when omitted; unsupported values appear in ignoredFields.

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

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

tag

string | null

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.

Pattern: ^[A-Za-z0-9._:-]{1,64}$

Response

Quote and order 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

orderId

string

required

sourcePaymentMode

enum<string>

Available options:

shielded

priceValidUntil

string<date-time>

Two-minute indicative pricing deadline. Execution reprices after verified receipt and must preserve lockedMinAmountOut.

execution

object

Show child attributes

funding

object

Show child attributes

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

transaction

object

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.

Show child attributes

depositMemo

string

Memo or tag required with the deposit when present.

lightningReceiveRequestId

string

flexibleAmount

enum<boolean>

The invoice is amountless. amountIn and estimatedOut price the indicative amount and are rescaled to the amount actually paid.

Available options:

true

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
Option 3

Show child attributes

sweepFeeAmount

string

appFeeAmount

string

appFeePlatformCutAmount

string

appFees

object[]

Show child attributes

feeAssetDetails

object

Show child attributes

feeAmountUsd

string

totalFeeAmountUsd

string

minAmountOut

string

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

object

Unlisted destinations only: what the recipient receives if the swap into the token cannot deliver minAmountOut.

Show child attributes

source

object

Show child attributes

destination

object

Show child attributes

tag

string | null

The request's tag; null when none was sent.

readToken

string

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

paymentLinks

object

Show child attributes

effectiveSlippageBps

integer

Slippage tolerance applied to the order, in basis points.

ignoredFields

string[]

Names of ignored request fields, including unsupported refundAddress or refundChain values.

⌘I

Create onramp order

curl --request POST \
  --url https://orchestration.flashnet.xyz/v1/orchestration/onramp \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency-Key: <x-idempotency-key>' \
  --data '
{
  "destinationChain": "spark",
  "destinationAsset": "USDB",
  "recipientAddress": "RECIPIENT_ADDRESS"
}
'

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency-Key': '<x-idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    destinationChain: 'spark',
    destinationAsset: 'USDB',
    recipientAddress: 'RECIPIENT_ADDRESS'
  })
};

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

import requests

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

payload = {
    "destinationChain": "spark",
    "destinationAsset": "USDB",
    "recipientAddress": "RECIPIENT_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": "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
}

{
  "orderId": "ord_b91bbf90-42dc-4fe3-9b15-1d2c7e19cce6",
  "status": "paused"
}

{
  "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 onramp order

Authorizations

Headers

Body

Response