INinfinite
fixed-routes

Create a virtual bank account fixed route

Changed on

Creates a virtual bank account that automatically sweeps fiat deposits. Route type (FIAT_TO_CRYPTO, FIAT_TO_FIAT, or FIAT_TO_CRYPTO_TO_FIAT) is inferred from the sweep target account type. Set depositMatching to DEDICATED for a unique account number, or REFERENCE for a shared account number plus a payment reference. Use the Idempotency-Key header to safely retry on network failure.

post/v1/fixed-routes/virtual-bank-accounts

Request

Headers

X-API-Keystring

API key

Idempotency-Keystring

Optional idempotency key. When supplied, a retry with the same key replays the original response (24h TTL) instead of being rejected as a duplicate.

Request body

correspondentBankNamestring

Correspondent/intermediary bank name

correspondentBankSwiftCodestring

Correspondent/intermediary bank SWIFT/BIC code (8 or 11 characters)

correspondentAccountNumberstring

Correspondent/intermediary account number

customerIdstring required

Customer ID

braleAutomationIdstring

Optional. Existing Brale automation id (admin / advanced). When omitted, the API creates a wire onramp automation after registering the settlement wallet on Brale.

onrampSettlementInwAccountIdstring

Optional. TRANSACTION Infinite Wallet for on-chain settlement (Ethereum). When omitted, one is created or reused for the customer.

onrampPayoutTreasuryInwAccountIdstring

Optional. TRANSACTION Infinite Wallet on the receive chain for post-settlement payout when the receive chain is not Ethereum. When omitted, one is created or reused.

sweepTargetAccountIdstring required

Sweep / destination account id; the route type is inferred from it. A crypto wallet, or an ACTIVE provider-balance account (USDT on Ethereum) when the organization is enabled for provider-balance onramps, gives FIAT_TO_CRYPTO (developer fees are not supported on a provider-balance target). The customer's own fiat balance account gives FIAT_TO_FIAT: the deposit settles into that balance in the same currency with no crypto leg, and destinationRail becomes BALANCE. That requires the pay-in and the balance to be on the same provider holding the fiat on dedicated coordinates, and rejects developer fees. An external bank account gives the FIAT_TO_CRYPTO_TO_FIAT sandwich.

sourceRail'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' | 'CNAPS' | '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'

Source rail - payment rail for incoming deposits

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

destinationRail'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' | 'CNAPS' | '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'

Destination rail - chain/network for crypto sweep

destinationCurrencystring

Destination currency to convert to

developerFeeFixedstring

Fixed fee in minor units of source currency

developerFeePercentnumber

Variable fee as decimal percentage (0.01 = 1%)

externalReferencestring

Client-provided external reference

Example request

{
  "correspondentBankName": "Bank of America",
  "correspondentBankSwiftCode": "IRVTUS3NXXX",
  "correspondentAccountNumber": "9876543210",
  "customerId": "cus_abc123",
  "onrampPayoutTreasuryInwAccountId": "inw_tron_tx",
  "sweepTargetAccountId": "ewa_abc123",
  "sourceRail": "ACH",
  "sourceRails": [
    "ACH",
    "WIRE"
  ],
  "sourceCurrency": "USD",
  "destinationRail": "BASE",
  "destinationCurrency": "USDC",
  "developerFeeFixed": "100000",
  "developerFeePercent": 0.01,
  "externalReference": "550e8400-e29b-41d4-a716-446655440000",
  "metadata": {
    "nickname": "Main Checking Account",
    "purpose": "Business operations",
    "tags": [
      "primary",
      "operations"
    ]
  },
  "allowedSenderBanks": [
    {
      "bankName": "JPMorgan Chase",
      "routingNumber": "021000021",
      "swiftBic": "CHASUS33"
    }
  ]
}

Response

Fixed route created successfully

idstring required

Fixed route ID (same as source account ID)

customerIdstring required
type'FIAT_TO_CRYPTO' | 'CRYPTO_TO_FIAT' | 'CRYPTO_TO_BALANCE' | 'CRYPTO_TO_CRYPTO' | 'FIAT_TO_FIAT' | 'FIAT_TO_CRYPTO_TO_FIAT' required
statusstring required
enabledboolean required

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

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.

destinationCurrencystring
destinationRailstring
sweepTargetAccountIdstring required

ID of the account funds are swept to

previousSweepTargetAccountIdstring

Sweep target this route pointed at before the latest retarget. Omitted until the route has been retargeted. The next retarget replaces it.

previousDestinationRailstring

Destination rail stored with the previous sweep target. Omitted when there is no previous destination.

previousDestinationCurrencystring

Destination currency stored with the previous sweep target. Omitted when there is no previous destination.

developerFeeFixedstring nullable

Fixed fee in minor units of source currency

developerFeePercentnumber nullable

Variable fee as decimal percentage (0.01 = 1%)

refundAccountIdstring nullable

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

documentIdsstring[] nullable

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

sharesBalanceAccountCoordinatesboolean 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.

payinCloseableboolean required

Whether deactivating this route can close the deposit account. When false, deactivating only disables the route and a later payment can still arrive.

payinClosedboolean required

Whether the deposit account is closed. A closed account cannot be turned back on.

sourceClosedboolean required

Whether the source account is closed. A closed source cannot be turned back on. A wallet address can still receive funds.

canReenableboolean required

Whether this route can be turned back on. False when the source account or the destination account is not active.

depositsForwardWhileDisabledboolean required

Whether this deposit address keeps paying the current destination after the route is disabled. When false, deposits are not auto-swept.

createdAtstring date-time required
updatedAtstring date-time required

Example response

{
  "id": "vba_abc123",
  "customerId": "cus_abc123",
  "type": "FIAT_TO_CRYPTO",
  "status": "ACTIVE",
  "enabled": true,
  "metadata": {
    "nickname": "Main Checking Account",
    "purpose": "Business operations",
    "tags": [
      "primary",
      "operations"
    ]
  },
  "sourceAccount": {
    "id": "vba_abc123",
    "type": "VIRTUAL_BANK",
    "metadata": {
      "nickname": "Main Checking Account",
      "purpose": "Business operations",
      "tags": [
        "primary",
        "operations"
      ]
    },
    "depositInstructions": {
      "bankName": "JPMorgan Chase Bank",
      "bankAddress": {
        "addressLine1": "123 Main Street",
        "addressLine2": "Apt 4B",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94102",
        "country": "US"
      },
      "accountNumber": "1234567890",
      "routingNumber": "021000021",
      "iban": "GB82WEST12345698765432",
      "swiftBic": "CHASUS33",
      "bankCountryCode": "US",
      "reference": "REF-123456",
      "depositMessage": "INV-2026-0001",
      "beneficiaryName": "John Doe",
      "beneficiaryAddress": {
        "addressLine1": "123 Main Street",
        "addressLine2": "Apt 4B",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94102",
        "country": "US"
      }
    },
    "sourceCurrency": "USD",
    "sourceRail": "ACH",
    "sourceRails": [
      "ACH",
      "WIRE"
    ],
    "walletAddress": "0x742d35Cc6529Cf6c6D06E4C8a4c07583F5C6C2d8",
    "addressType": "EVM",
    "chains": [
      "ETHEREUM",
      "BASE"
    ]
  },
  "destinationCurrency": "USDC",
  "destinationRail": "BASE",
  "sweepTargetAccountId": "ewa_abc123",
  "previousSweepTargetAccountId": "ewa_previous",
  "previousDestinationRail": "ETHEREUM",
  "previousDestinationCurrency": "USDT",
  "sweepTargetAccount": {
    "id": "ewa_abc123",
    "type": "EXTERNAL_WALLET",
    "metadata": {
      "nickname": "Main Checking Account",
      "purpose": "Business operations",
      "tags": [
        "primary",
        "operations"
      ]
    },
    "walletAddress": "0x742d35Cc6529Cf6c6D06E4C8a4c07583F5C6C2d8",
    "addressType": "EVM",
    "chains": [
      "ETHEREUM",
      "BASE"
    ],
    "accountNumber": "****7890",
    "routingNumber": "021000021",
    "bankName": "Bank of America"
  },
  "developerFeeFixed": "100000",
  "developerFeePercent": 0.01,
  "refundAccountId": "inw_abc123",
  "correspondentBank": {
    "swiftCode": "IRVTUS3NXXX",
    "accountNumber": "9876543210"
  },
  "allowedSenderBanks": [
    {
      "bankName": "JPMorgan Chase",
      "routingNumber": "021000021",
      "swiftBic": "CHASUS33"
    }
  ],
  "minimumAmount": {
    "currency": "USD",
    "exponent": 2,
    "value": "12345",
    "displayValue": "123.45"
  },
  "canReenable": true
}

Changes

  • 90065d3e6974Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 7072bd7fdeb7Revision changes
    • info

      added the new CNAPS enum value to the request property

    • info

      added the new CNAPS enum value to the request property

    • info

      added the new CNAPS enum value to the request property /