Skip to main content
POST
Create accumulation address

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

Unknown top-level fields are ignored rather than rejected.

sourceChain
enum<string>
required
Available options:
arbitrum,
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
string
required
Minimum string length: 1
destinationAsset
enum<string>
required
Available options:
BTC,
USDB
recipientSparkAddress
string
required

Server canonicalizes by trimming leading/trailing whitespace; case is preserved.

Minimum string length: 1
label
string
Maximum string length: 255
Pattern: ^[^\x00-\x1F\x7F]*$
feeBps
integer
Required range: 0 <= x <= 9999
slippageBps
integer
Required range: 0 <= x <= 10000
appFees
object[]

Inline fee recipients for each deposit, requiring a server key or dashboard session.

Required array length: 1 - 16 elements
affiliateId
string

Registered affiliate ID for fees on each deposit, also accepted from client keys.

affiliateIds
(string | object)[]

Registered affiliate IDs or fee overrides for each deposit; 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

Created

accumulationAddressId
string
required
label
string
required
sourceChain
enum<string>
required
Available options:
arbitrum,
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
string
required
destinationAsset
enum<string>
required
Available options:
BTC,
USDB
recipientSparkAddress
string
required
feeBps
integer
required
slippageBps
integer
required
enabled
boolean
required
depositAddress
string | null
required
createdAt
string
required
updatedAt
string
disabledAt
string | null
subscriptions
object[]
appFees
object[]