Skip to main content
GET
CLI

Authorizations

Authorization
string
header
required

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

Headers

X-API-Key
string

API key

Path Parameters

id
string
required

Query Parameters

expand
string

Comma-separated list of fields to expand (e.g., "sweepTargetAccount")

Example:

"sweepTargetAccount"

Response

Fixed route details

id
string
required

Fixed route ID (same as source account ID)

Example:

"vba_abc123"

customerId
string
required
Example:

"cus_abc123"

type
enum<string>
required
Available options:
FIAT_TO_CRYPTO,
CRYPTO_TO_FIAT,
CRYPTO_TO_CRYPTO,
FIAT_TO_FIAT,
FIAT_TO_CRYPTO_TO_FIAT
Example:

"FIAT_TO_CRYPTO"

status
string
required
Example:

"ACTIVE"

enabled
boolean
required

Whether the fixed route is enabled. When false, deposits land but do not auto-sweep.

Example:

true

sourceAccount
object
required
sweepTargetAccountId
string
required

ID of the account funds are swept to

Example:

"ewa_abc123"

sharesBalanceAccountCoordinates
boolean
required

Whether this route's deposit coordinates are shared with a USD balance account. When true, the route and a balance account are mutually exclusive for the customer — one must be closed/disabled before the other can be created or re-enabled. Only bank pay-in routes on the balance-account provider qualify (ACH, WIRE, or SWIFT); crypto routes and payout routes are always false.

Example:

false

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
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
metadata
object

Custom metadata for the fixed route account, including nickname

destinationCurrency
string
Example:

"USDC"

destinationRail
string
Example:

"BASE"

sweepTargetAccount
object

Sweep target account details (only when expand=sweepTargetAccount)

developerFeeFixed
string

Fixed fee in minor units of source currency

Example:

"100000"

developerFeePercent
number

Variable fee as decimal percentage (0.01 = 1%)

Example:

0.01

refundAccountId
string

Customer wallet account ID (inw_xxx or ewa_xxx) for refunds on failed transfers or when fees exceed deposit

Example:

"inw_abc123"

correspondentBank
object | null

Correspondent/intermediary bank details (when applicable)

allowedSenderBanks
object[] | null

Allowed sender banks for deposits into this route. When set, deposits from sender banks not on this list are held for review instead of being processed automatically.

documentIds
string[] | null

Standing supporting agreement document ID applied to transfers created by this route.

Maximum array length: 1
minimumAmount
object

Minimum deposit amount for this route. Deposits below this floor are held instead of swept. This is a preview based on the stored route configuration; the validate endpoint returns the authoritative floor at submission time.