> ## Documentation Index
> Fetch the complete documentation index at: https://docs.meld.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List supported routes by direction

> Same as find-supported-routes, across every non-swap category of the direction: ONRAMP covers CRYPTO_ONRAMP and CRYPTO_VIRTUAL_ACCOUNT_ONRAMP (fiat to crypto), OFFRAMP covers CRYPTO_OFFRAMP and CRYPTO_VIRTUAL_ACCOUNT_OFFRAMP (crypto to fiat). Each payment method carries the category it is published under; a method published under two categories is returned once per category. When both `paymentMethod` and `paymentType` are provided, `paymentMethod` takes precedence. An unknown `countryCode`, or a `subdivision` outside US and CA, returns `400`. Provider scope rules:
- No authentication: results come from the global dataset; `Meld-Account-Id` is ignored.
- Basic Auth only: results are restricted to the authenticated identity's `providers` claim. An identity without a `providers` claim, or with an empty one, is unrestricted.
- `Meld-Account-Id` only: ignored for anonymous callers.
- Both Basic Auth and `Meld-Account-Id`: results are restricted to the intersection of both provider sets. An account id this service has no account data for leaves the scope unchanged; a known account with no providers yields an empty scope.
- Naming an account that does not belong to the caller returns `403` when account-header enforcement is enabled, unless the caller has an authorized administrator or service role. With enforcement in monitor mode, the request is only reported and proceeds.
- Explicit partner filters are intersected with the resolved provider scope.

Explicit `partners` filtering is intersected with the resolved provider scope.
If the effective provider scope contains no providers, this collection endpoint returns `200` with an empty result.



## OpenAPI

````yaml /openapi/networkpartner-20260203.json get /network-partner/supported/routes/direction/{direction}/{countryCode}/{sourceCurrencyCode}/{destinationCurrencyCode}
openapi: 3.1.0
info:
  title: NETWORK PARTNER
  version: '2026-02-03'
  description: ''
servers:
  - url: https://api-sb.meld.io
    description: Meld API sandbox
  - url: https://api.meld.io
    description: Meld API production
security: []
tags:
  - name: Supported
    description: ''
paths:
  /network-partner/supported/routes/direction/{direction}/{countryCode}/{sourceCurrencyCode}/{destinationCurrencyCode}:
    get:
      tags:
        - Supported
      summary: List supported routes by direction
      description: >-
        Same as find-supported-routes, across every non-swap category of the
        direction: ONRAMP covers CRYPTO_ONRAMP and CRYPTO_VIRTUAL_ACCOUNT_ONRAMP
        (fiat to crypto), OFFRAMP covers CRYPTO_OFFRAMP and
        CRYPTO_VIRTUAL_ACCOUNT_OFFRAMP (crypto to fiat). Each payment method
        carries the category it is published under; a method published under two
        categories is returned once per category. When both `paymentMethod` and
        `paymentType` are provided, `paymentMethod` takes precedence. An unknown
        `countryCode`, or a `subdivision` outside US and CA, returns `400`.
        Provider scope rules:

        - No authentication: results come from the global dataset;
        `Meld-Account-Id` is ignored.

        - Basic Auth only: results are restricted to the authenticated
        identity's `providers` claim. An identity without a `providers` claim,
        or with an empty one, is unrestricted.

        - `Meld-Account-Id` only: ignored for anonymous callers.

        - Both Basic Auth and `Meld-Account-Id`: results are restricted to the
        intersection of both provider sets. An account id this service has no
        account data for leaves the scope unchanged; a known account with no
        providers yields an empty scope.

        - Naming an account that does not belong to the caller returns `403`
        when account-header enforcement is enabled, unless the caller has an
        authorized administrator or service role. With enforcement in monitor
        mode, the request is only reported and proceeds.

        - Explicit partner filters are intersected with the resolved provider
        scope.


        Explicit `partners` filtering is intersected with the resolved provider
        scope.

        If the effective provider scope contains no providers, this collection
        endpoint returns `200` with an empty result.
      operationId: find-supported-routes-by-direction
      parameters:
        - name: Meld-Version
          in: header
          description: Dated API version to use for this request, e.g. `2026-02-03`.
          required: false
          schema:
            type: string
            example: '2026-02-03'
        - description: Country code
          example: US
          name: countryCode
          in: path
          required: true
          schema:
            type: string
        - description: >-
            Canonical destination currency code. Crypto for ONRAMP; fiat for
            OFFRAMP.
          example: BTC
          name: destinationCurrencyCode
          in: path
          required: true
          schema:
            type: string
        - description: Ramp direction
          example: ONRAMP
          name: direction
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/Direction'
        - description: Canonical source currency code. Fiat for ONRAMP; crypto for OFFRAMP.
          example: USD
          name: sourceCurrencyCode
          in: path
          required: true
          schema:
            type: string
        - description: >-
            When true, returns only payment methods available in the hosted
            checkout (widget)
          name: checkout
          in: query
          schema:
            type: boolean
        - description: When true, returns only headless-capable payment methods
          name: headless
          in: query
          schema:
            type: boolean
        - description: Comma-separated partner ids
          example: PAYBIS,BANXA
          name: partners
          in: query
          schema:
            type: string
        - description: Canonical payment method code
          example: CREDIT_DEBIT_CARD
          name: paymentMethod
          in: query
          schema:
            type: string
        - description: Payment method type
          example: CARD
          name: paymentType
          in: query
          schema:
            $ref: '#/components/schemas/PaymentType'
        - description: >-
            Country subdivision code. Supported for US and CA only. Use either
            full ISO 3166-2 code or local code.
          example: US-NY
          name: subdivision
          in: query
          schema:
            type: string
        - description: >-
            Optional. Base58 encoded account id, ignored for anonymous callers.
            For authenticated callers, intersects identity providers with
            account providers. With account-header enforcement enabled, the
            account must belong to the caller unless the caller has an
            authorized administrator or service role.
          name: Meld-Account-Id
          in: header
          schema:
            type: string
      responses:
        '200':
          description: Supported routes
          content:
            application/json:
              examples:
                supportedRoutesByDirection:
                  summary: One partner's ONRAMP methods across two categories
                  value:
                    - partner: UPHOLD
                      source: USD
                      destination: USDC
                      paymentMethods:
                        - paymentType: CARD
                          name: CREDIT_DEBIT_CARD
                          partnerMethodName: credit-card
                          category: CRYPTO_ONRAMP
                          limits:
                            currencyCode: USD
                            min: 10.83
                            max: 16133
                          logo:
                            dark: >-
                              https://cdn.meld.io/images-paymentmethod/CREDIT_DEBIT_CARD/logo_dark.png
                            light: >-
                              https://cdn.meld.io/images-paymentmethod/CREDIT_DEBIT_CARD/logo_light.png
                          headlessSupported: true
                          checkoutSupported: false
                          cardRenderMode: IFRAME
                          headlessPresentation:
                            surface: EMBEDDED_WIDGET
                            protocol: UPHOLD_WIDGET
                            version: 1
                          headlessProviderMethod: credit-card
                        - paymentType: BANK_TRANSFER
                          name: ACH
                          partnerMethodName: ACH
                          category: CRYPTO_VIRTUAL_ACCOUNT_ONRAMP
                          limits:
                            currencyCode: USD
                            min: 10.83
                            max: 16133
                          logo:
                            dark: >-
                              https://cdn.meld.io/images-paymentmethod/ACH/logo_dark.png
                            light: >-
                              https://cdn.meld.io/images-paymentmethod/ACH/logo_light.png
                          headlessSupported: true
                          checkoutSupported: false
                          headlessProviderMethod: ACH
                      kycLimits: []
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SupportedRoute'
        '400':
          description: >-
            Unknown country code, `subdivision` without a US or CA country, or
            an invalid enum value
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The credentials are valid but not for this account or provider scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '405':
          description: The path exists but not for this method
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '406':
          description: No representation available for the requested Accept header
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '415':
          description: Request body media type not supported
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected failure in this service
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security: []
components:
  schemas:
    Direction:
      description: >-
        Ramp direction. ONRAMP covers CRYPTO_ONRAMP and
        CRYPTO_VIRTUAL_ACCOUNT_ONRAMP; OFFRAMP covers CRYPTO_OFFRAMP and
        CRYPTO_VIRTUAL_ACCOUNT_OFFRAMP. Swap categories are not included.
      type: string
      enum:
        - ONRAMP
        - OFFRAMP
    PaymentType:
      description: Payment method type grouping canonical payment methods
      type: string
      enum:
        - BANK_TRANSFER
        - CARD
        - CASH
        - EXCHANGE
        - LOCAL
        - MOBILE_WALLET
    SupportedRoute:
      description: >-
        Supported route details for a specific source and destination currency
        pair
      type: object
      properties:
        partner:
          type: string
          description: Partner identifier
          examples:
            - BANXA
        source:
          type: string
          description: Source currency code
          examples:
            - USD
        destination:
          type: string
          description: Destination currency code
          examples:
            - BTC
        paymentMethods:
          type: array
          items:
            $ref: '#/components/schemas/PaymentMethod1'
          description: >-
            Payment methods for the route. Empty for swap routes without payment
            methods.
        kycLimits:
          type: array
          items:
            $ref: '#/components/schemas/ProviderKycLimit'
          description: >-
            Provider KYC limits for this route. Empty when limits are not
            available.
    ErrorResponse:
      type: object
      description: The error body every failed request on this service returns.
      required:
        - code
        - message
        - timestamp
      properties:
        code:
          type: string
          description: What went wrong, as a stable value to branch on.
          enum:
            - BAD_REQUEST
            - CONFLICT
            - ENCRYPTION_ERROR
            - FORBIDDEN
            - JSON_PROCESSING_ERROR
            - METHOD_NOT_ALLOWED
            - UNSUPPORTED_MEDIA_TYPE
            - NOT_ACCEPTABLE
            - NOT_FOUND
            - NOT_SUPPORTED
            - SERVICE_PROVIDER_ERROR
            - UNAUTHORIZED
            - UNEXPECTED_ERROR
        message:
          type: string
          description: >-
            What happened, in words, naming the value that was rejected or not
            found.
        requestId:
          type: string
          description: >-
            The request's id when one reached this service. Quote it in a
            support request. Absent when nothing upstream set one.
        timestamp:
          type: string
          format: date-time
          description: >-
            When the failure occurred. ISO 8601, UTC
            (`YYYY-MM-DDThh:mm:ss.sss+00:00`).
    PaymentMethod1:
      type: object
      description: Payment method details for a supported route
      properties:
        paymentType:
          description: Payment type
          type: string
          examples:
            - CARD
          allOf:
            - $ref: '#/components/schemas/PaymentType'
        name:
          type: string
          description: Canonical payment method code
          examples:
            - CREDIT_DEBIT_CARD
        partnerMethodName:
          type: string
          description: Partner-specific payment method identifier
          examples:
            - card
        category:
          description: Provider category this payment method is published under
          type: string
          examples:
            - CRYPTO_ONRAMP
          allOf:
            - $ref: '#/components/schemas/Category'
        limits:
          description: >-
            Limits for this payment method in a single denomination (see Limit).
            Null when limits are not available.
          type: object
          allOf:
            - $ref: '#/components/schemas/Limit'
        logo:
          description: Payment method logo variants
          type: object
          allOf:
            - $ref: '#/components/schemas/PaymentMethodLogo'
        headlessSupported:
          type: boolean
          description: Whether this provider payment method is enabled for headless flows
        checkoutSupported:
          type: boolean
          description: >-
            Whether this provider payment method is available in the hosted
            checkout (widget)
        cardRenderMode:
          description: >-
            Card render mode; populated only for headless CREDIT_DEBIT_CARD and
            APPLE_PAY methods, otherwise null
          type: string
          allOf:
            - $ref: '#/components/schemas/CardRenderMode'
        headlessPresentation:
          description: >-
            Optional presentation protocol for this provider's eligible route
            method
          type: object
          allOf:
            - $ref: '#/components/schemas/HeadlessPresentation'
        headlessProviderMethod:
          type: string
          description: >-
            Partner-specific payment method identifier the headless flow
            transacts on; populated exactly when headlessSupported. May differ
            from partnerMethodName, which identifies the route's widget product.
          examples:
            - GUEST_CHECKOUT_APPLE_PAY
    ProviderKycLimit:
      description: Provider KYC limits for a currency and limit window
      type: object
      properties:
        provider:
          type: string
          description: Provider identifier
          examples:
            - BANXA
        category:
          description: Provider category
          type: string
          examples:
            - CRYPTO_ONRAMP
          allOf:
            - $ref: '#/components/schemas/Category'
        countryCode:
          type: string
          description: ISO 3166-1 alpha-2 country code
          examples:
            - US
        limitType:
          description: Window the level amounts apply to
          type: string
          examples:
            - DAILY
          allOf:
            - $ref: '#/components/schemas/LimitType'
        currencyCode:
          type: string
          description: >-
            Canonical currency (fiat or crypto) the level amounts are
            denominated in
          examples:
            - USD
        level1:
          type: number
          description: >-
            Limit for a customer verified to KYC level 1, in currencyCode per
            limitType window; zero or greater, null when not configured
          examples:
            - 1000
        level2:
          type: number
          description: >-
            Limit for a customer verified to KYC level 2, in currencyCode per
            limitType window; zero or greater, null when not configured
          examples:
            - 10000
        level3:
          type: number
          description: >-
            Limit for a customer verified to KYC level 3, in currencyCode per
            limitType window; zero or greater, null when not configured
          examples:
            - 50000
    Category:
      description: Categories of functionality offered by a service provider
      type: string
      enum:
        - CRYPTO_ONRAMP
        - CRYPTO_OFFRAMP
        - CRYPTO_TRANSFER
        - BANK_LINKING
        - FIAT_PAYMENTS
        - CRYPTO_VIRTUAL_ACCOUNT_ONRAMP
        - CRYPTO_VIRTUAL_ACCOUNT_OFFRAMP
        - CUSTOMER_KYC
        - CRYPTO_ONRAMP_SWAP
        - CRYPTO_OFFRAMP_SWAP
    Limit:
      type: object
      description: >-
        Single-denomination projection of the route's limits, kept for v1
        compatibility. Uses the fiat-leg limit when one exists, otherwise the
        crypto-leg limit, rounded to 2 decimal places (HALF_UP for a fiat
        denomination, HALF_EVEN otherwise), so small crypto bounds lose
        precision. Use /v2/supported/routes for every denomination at full
        precision.
      properties:
        currencyCode:
          type: string
          description: >-
            Currency the bounds are denominated in: the route's fiat currency,
            or its crypto currency when no fiat limit exists
          examples:
            - USD
        min:
          type: number
          description: >-
            Inclusive minimum amount in currencyCode, 2 decimal places; null
            when unknown
          examples:
            - 10
        max:
          type: number
          description: >-
            Inclusive maximum amount in currencyCode, 2 decimal places; null
            when unknown
          examples:
            - 10000
    PaymentMethodLogo:
      type: object
      description: Payment method logo variants
      properties:
        dark:
          type: string
          description: Dark logo URL
          examples:
            - >-
              https://cdn.meld.io/images-paymentmethod/CREDIT_DEBIT_CARD/logo_dark.png
        light:
          type: string
          description: Light logo URL
          examples:
            - >-
              https://cdn.meld.io/images-paymentmethod/CREDIT_DEBIT_CARD/logo_light.png
    CardRenderMode:
      description: >-
        How a headless integration renders the provider's payment-collection
        surface. Applies only to headless CREDIT_DEBIT_CARD and APPLE_PAY
        payment methods; null for every other method.
      type: string
      enum:
        - IFRAME
        - REDIRECT
        - SDK_NATIVE
    HeadlessPresentation:
      description: >-
        Versioned headless payment presentation; not an eligibility or
        authorization grant
      type: object
      properties:
        surface:
          type: string
          description: >-
            The shape the provider exposes, in the same vocabulary as
            ApplePayPresentation. Current values: EMBEDDED_WIDGET, NATIVE_TOKEN,
            PROVIDER_HOSTED, VENDOR_SDK, NATIVE_SDK. Deliberately not an
            enumeration: consumers must read future values and fail closed on
            ones they do not support.
          examples:
            - NATIVE_TOKEN
            - NATIVE_SDK
        protocol:
          type: string
          description: >-
            Adapter protocol identifier (upper-case letters, digits and
            underscores); consumers must recognize it before use and fail closed
            otherwise
          examples:
            - BANXA_CHECKOUT
        version:
          type: integer
          format: int32
          minimum: 1
          description: Protocol version; consumers must explicitly support it
          examples:
            - 1
    LimitType:
      description: Window a provider KYC limit amount applies to
      type: string
      enum:
        - TRANSACTION
        - DAILY
        - WEEKLY
        - MONTHLY
        - YEARLY

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.