Mesh Token Network Pairs API

openapi: 3.2.0
info:
  title: Mesh Connect Integration Token Network Pairs API
  description: 'Mesh allows users to connect accounts of financial institutions,

    crypto exchanges, and self-custody wallets. Mesh handles credential

    validation, MFA, and error handling for each integration. After

    an account is connected, Mesh allows client applications to read holdings,

    transaction history and balances and execute crypto transfers (with user approval).'
  version: '1.0'
servers:
- url: https://integration-api.meshconnect.com
- url: https://sandbox-integration-api.meshconnect.com
security:
- Client-Secret: []
  Client-Id: []
tags:
- name: TokenNetworkPairs
paths:
  /api/v1/token-network-pairs:
    get:
      tags:
      - TokenNetworkPairs
      summary: Get token-network pairs
      description: 'Flat list of every token-on-network pair available in the transfer catalog, including manual-only

        pairs (eligible for manual transfers without broker support). Each pair carries a stable

        `pairId` and whether the chain is monitored by Mesh (`isTracked`). Thin reformatter over

        the same catalog returned by the managed-transfers tokens endpoint.'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenNetworkPairsResponseApiResult'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema: {}
      operationId: getApiV1TokenNetworkPairs
      x-operation-id-source: derived
components:
  schemas:
    ApiResultStatus:
      enum:
      - ok
      - serverFailure
      - permissionDenied
      - badRequest
      - notFound
      - conflict
      - tooManyRequest
      - locked
      - unavailableForLegalReasons
      type: string
    TokenNetworkPairsResponse:
      type: object
      properties:
        pairs:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/TokenNetworkPair'
      additionalProperties: false
      description: Flat list of every token-on-network combination in the transfer catalog, including manual-only pairs.
    TokenNetworkPair:
      type: object
      properties:
        pairId:
          type: string
          description: 'Stable, deterministic identifier for this (token, network) pair (RFC 4122 version 5 GUID).

            The same token/network combination always maps to the same value.'
          format: uuid
        symbol:
          type:
          - string
          - 'null'
          description: Token symbol (e.g. "USDC", "ETH", "BTC").
        networkId:
          type: string
          description: Internal Mesh network ID (GUID format).
          format: uuid
        networkName:
          type:
          - string
          - 'null'
          description: Network Name
        tokenLogoUrl:
          type:
          - string
          - 'null'
          description: Token logo URL.
        networkLogoUrl:
          type:
          - string
          - 'null'
          description: Network logo URL.
        isTracked:
          type: boolean
          description: 'Whether the network is monitored by Indexing Co. When true, manual deposits on this chain are

            auto-detected; when false, the client reconciles deposits itself.'
      additionalProperties: false
      description: 'A single token-on-network combination available in the transfer catalog. Decoupled from broker

        integrations: a pair can be available for manual transfers even when no connected broker supports it.'
    TokenNetworkPairsResponseApiResult:
      type: object
      properties:
        status:
          enum:
          - ok
          - serverFailure
          - permissionDenied
          - badRequest
          - notFound
          - conflict
          - tooManyRequest
          - locked
          - unavailableForLegalReasons
          allOf:
          - $ref: '#/components/schemas/ApiResultStatus'
          readOnly: true
        message:
          type:
          - string
          - 'null'
          description: A message generated by the API
        displayMessage:
          type:
          - string
          - 'null'
          description: User-friendly display message that can be presented to the end user
        errorHash:
          type:
          - string
          - 'null'
          description: An error grouping hash from string components and caller information. Used by bugsnag on FE for correct error grouping
          readOnly: true
        teamCode:
          type:
          - string
          - 'null'
          description: 'Opaque team code for error routing. Resolved from exception origin or caller file path via CODEOWNERS.

            Format: 2-character code (e.g., "7K", "M2"). Use for alerting/routing, not display.'
          readOnly: true
        errorType:
          type:
          - string
          - 'null'
          description: 'Strictly-typed error type that is explaining the reason of an unsuccessful status of the operation.

            All possible error types are available in the documentation.'
        errorData:
          readOnly: true
        content:
          allOf:
          - $ref: '#/components/schemas/TokenNetworkPairsResponse'
          description: Flat list of every token-on-network combination in the transfer catalog, including manual-only pairs.
      additionalProperties: false
  securitySchemes:
    Client-Secret:
      type: apiKey
      description: Contact Mesh to get client Secret
      name: X-Client-Secret
      in: header
    Client-Id:
      type: apiKey
      description: Contact Mesh to get client Id
      name: X-Client-Id
      in: header