fixed-routes

Validate if a fixed route can be created

Changed on

Checks if a fixed route configuration is valid before creating it. Returns validation result with any errors.

post/v1/fixed-routes/validate

Request

Headers

X-API-Keystring

API key

Request body

sweepTargetAccountIdstring required

The destination account ID for the fixed route

fixedRouteType'FIAT_TO_CRYPTO' | 'CRYPTO_TO_FIAT' | 'CRYPTO_TO_BALANCE' | 'CRYPTO_TO_CRYPTO' | 'FIAT_TO_FIAT' | 'FIAT_TO_CRYPTO_TO_FIAT' required

The type of fixed route to create

sourceRailstring

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

sourceRailsstring[]

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.

depositMatching'DEDICATED' | 'REFERENCE'

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.

sourceCurrencystring

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

destinationRailstring

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

destinationCurrencystring

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

braleAutomationIdstring

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

documentIdsstring[]

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

Example request

{
  "sweepTargetAccountId": "ewa_abc123",
  "fixedRouteType": "FIAT_TO_CRYPTO",
  "sourceRail": "ACH",
  "sourceRails": [
    "ACH",
    "WIRE"
  ],
  "sourceCurrency": "USD",
  "destinationRail": "BASE",
  "destinationCurrency": "USDC"
}

Response

Validation result

validboolean required

Whether the fixed route configuration is valid

errorstring

Error message if validation failed

Example response

{
  "valid": true,
  "error": "FIAT_TO_CRYPTO route requires a wallet as sweep target",
  "minimumAmount": {
    "currency": "USD",
    "exponent": 2,
    "value": "12345",
    "displayValue": "123.45"
  }
}

Changes