Customers

List fixed routes for a customer

Returns all fixed routes (virtual bank accounts and virtual wallets) configured for a customer.

get/v1/customers/{customerId}/fixed-routes

Path parameters

customerIdstring required
Example:cus_abc123

Customer ID

Query parameters

limitnumber

Number of items to return (default: 50)

offsetnumber

Number of items to skip (default: 0)

Headers

X-API-Keystring

API key

Response

Paginated list of fixed routes

totalnumber
limitnumber
offsetnumber

Example response

{
  "data": [
    {
      "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",
      "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"
      }
    }
  ]
}

Changes

Changed in 3 of the 19 revisions of this API.2125

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

  • 916d2367a8f82122See the full diff
    • ▲

      the response property //// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property //// became nullable for the status

      response-property-became-nullable

    • ●

      removed the optional property ///// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property ///// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property ///// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property ///// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property ///// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property ///// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property ///// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property ///// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property ///// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property ///// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property ///// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property ///// from the response with the status

      response-optional-property-removed

    • ○

      added to the //// response property allOf list for the response status

      response-property-all-of-added

    • ○

      added to the //// response property allOf list for the response status

      response-property-all-of-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the required property /////// to the response with the status

      response-required-property-added