Skip to main content
POST
CLI

Authorizations

Authorization
string
header
required

API Key in Bearer format (e.g., Bearer sk_test_...)

Headers

X-API-Key
string

API key

Body

application/json
sweepTargetAccountId
string
required

The destination account ID for the fixed route

Example:

"ewa_abc123"

fixedRouteType
enum<string>
required

The type of fixed route to create

Available options:
FIAT_TO_CRYPTO,
CRYPTO_TO_FIAT,
CRYPTO_TO_CRYPTO,
FIAT_TO_FIAT,
FIAT_TO_CRYPTO_TO_FIAT
Example:

"FIAT_TO_CRYPTO"

sourceRail
string

Source rail - payment rail for incoming deposits (e.g., ACH, WIRE, SEPA)

Example:

"ACH"

sourceRails
enum<string>[]

Optional list of inbound rails for a USD bank pay-in deposit account. Omit to accept ACH and wire. SWIFT is included only when listed. When sourceRail is sent instead, it is treated as a one-element list. Crypto deposit routes still use a single sourceRail.

Available options:
ACH,
ACH_SAME_DAY,
WIRE,
FED_NOW,
RTP,
EREBOR,
EREBOR_RAIL,
BALANCE,
SWIFT,
SEPA,
SEPA_INSTANT,
TIPS,
FASTER_PAYMENTS,
BACS,
CHAPS,
ELIXIR,
NICS,
EFT,
INTERAC,
NPP,
BECS,
UPI,
IMPS,
IMPS_WITH_FIRC,
NEFT,
RTGS,
BI_FAST,
ARTAJASA,
PIX,
TED,
TEF,
SPEI,
COELSA,
SINPE,
CIPS,
CFXPS,
CHATS,
ZENGIN,
KFTC,
FAST_SG,
MEPS,
DUITNOW,
PROMPTPAY,
INSTAPAY,
PESONET,
NAPAS,
BEFTN,
SLIPS,
ZAHAV,
GHIPSS,
NIBSS,
PESALINK,
RTC_ZA,
TZS_RTGS,
EGP_ACH,
JOD_ACH,
NPSS,
MADA,
QPS,
DOP_ACH,
GTQ_ACH,
HNL_ACH,
PEN_ACH,
JMD_ACH,
USD_ACH_SV,
USD_ACH_EC,
CLP_TEF,
PSE,
COP_ACH,
BOB_RTGS,
PYG_ACH,
CERTIS,
DKK_TIPS,
SENT,
NKS,
BANKGIROT,
HKD_FPS,
IBFT,
TRY_FAST,
ETHEREUM,
BASE,
POLYGON,
SOLANA,
TRON,
BITCOIN,
ARBITRUM
Example:
depositMatching
enum<string>

How incoming payments are matched to this deposit account. DEDICATED issues a unique account number and the sender does not include a payment reference. REFERENCE uses a shared account number and the sender must include sourceAccount.depositInstructions.reference on the payment (wire memo or ACH addenda). Omit to keep the default for the requested rails. USD ACH, wire, and SWIFT bank pay-ins only.

Available options:
DEDICATED,
REFERENCE
sourceCurrency
string

Source currency for deposits (e.g., USD, EUR)

Example:

"USD"

destinationRail
string

Destination rail - chain/network for outgoing sweep (e.g., BASE, ETHEREUM)

Example:

"BASE"

destinationCurrency
string

Destination currency to convert to (e.g., USDC, USDT)

Example:

"USDC"

braleAutomationId
string

Bound Brale wire automation ID for legacy onramp routes. Omit for new standby-pool routes (Solana SBC intermediary).

documentIds
string[]

Standing supporting agreement document ID for a third-party SWIFT fixed route.

Maximum array length: 1

Response

Validation result

valid
boolean
required

Whether the fixed route configuration is valid

Example:

true

error
string

Error message if validation failed

Example:

"FIAT_TO_CRYPTO route requires a wallet as sweep target"

minimumAmount
object

Minimum deposit amount for this route. Deposits below this floor are not swept.