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

# List desk corridors

> The currencies the desk trades against stablecoins, with the current all-in rate in each direction and the minimum order. A null rate means that direction is closed right now; `open` false means no quote can be taken. Rates hold until Jenzy replaces them.



## OpenAPI

````yaml /v2/openapi.json get /orders/corridors
openapi: 3.1.0
info:
  title: Jenzy Hermes Multi-asset API
  version: 2.0.0
  description: >-
    Hold and pay out across the assets enabled for your organization. Every
    amount is an exact decimal string beside an `asset` field. Authenticate with
    the same `jz_live_…` API key as `/v1`.
servers:
  - url: https://api.jenzy.com/v2
    description: Production
security: []
paths:
  /orders/corridors:
    get:
      summary: List desk corridors
      description: >-
        The currencies the desk trades against stablecoins, with the current
        all-in rate in each direction and the minimum order. A null rate means
        that direction is closed right now; `open` false means no quote can be
        taken. Rates hold until Jenzy replaces them.
      parameters:
        - $ref: '#/components/parameters/HermesOrg'
      responses:
        '200':
          description: Every corridor, open or closed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CorridorList'
        '401':
          description: Missing, malformed, or revoked API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '403':
          description: >-
            Organization suspended, request IP not on the allowlist, no
            multi-asset access yet (`onboarding_incomplete` /
            `access_suspended`), or the desk is not enabled for your
            organization (`corridor_not_enabled`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '503':
          description: The `/v2` shutter is closed — check `GET /v2/ping`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - ApiKeyAuth: []
components:
  parameters:
    HermesOrg:
      name: HERMES-ORG
      in: header
      required: false
      description: >-
        The id of one of your Child orgs. The call then acts on that Child org,
        not on your organization. If you do not send it, the call acts on your
        organization. An id that is not one of your Child orgs gives `404`.
      schema:
        type: string
        format: uuid
        example: 3f1c2a9e-8b7d-4e21-9a6f-0c5d4b3e2a10
  schemas:
    CorridorList:
      type: object
      properties:
        corridors:
          type: array
          items:
            $ref: '#/components/schemas/Corridor'
      required:
        - corridors
      description: Every corridor the desk trades, open or closed.
    ErrorEnvelope:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - validation_error
                - unauthorized
                - forbidden
                - not_found
                - conflict
                - rate_limited
                - internal_error
                - unknown_institution
                - invalid_mobile_number
                - invalid_account_number
                - mobile_number_institution_mismatch
                - service_unavailable
                - sandbox_only
                - insufficient_funds
                - rail_disabled
                - amount_limit_exceeded
                - org_limit_exceeded
                - service_incident
                - service_maintenance
                - onboarding_incomplete
                - access_suspended
                - corridor_not_enabled
                - unsupported_pair
                - invalid_wallet_address
                - rate_unavailable
                - quote_expired
                - quote_used
                - limit_exceeded
                - amount_below_minimum
                - unsupported_asset
                - unsupported_network
                - unsupported_media_type
                - payload_too_large
                - client_ref_used
                - beneficiary_required
                - beneficiary_not_allowed
                - proof_not_expected
                - invalid_beneficiary
                - beneficiary_exists
                - beneficiary_not_active
                - invoice_required
                - prohibited_industry
              description: >-
                Stable identifier a client may branch on — never renamed or
                removed.
            message:
              type: string
          required:
            - code
            - message
      required:
        - error
    Corridor:
      type: object
      properties:
        asset:
          type: string
          minLength: 1
          description: The corridor currency — the fiat side of an order.
          example: BIF
        rate_off_ramp:
          type:
            - string
            - 'null'
          description: >-
            Stablecoin → `asset`: units of `asset` per one stablecoin (USDT and
            USDC share it), as a trimmed decimal string. Null when this
            direction is closed, or when the desk is closed. Your economics are
            entirely in this rate; there is no separate fee.
          example: '2850.5'
        rate_on_ramp:
          type:
            - string
            - 'null'
          description: >-
            `asset` → stablecoin: units of `asset` per one stablecoin (USDT and
            USDC share it), as a trimmed decimal string. Null when this
            direction is closed, or when the desk is closed. Your economics are
            entirely in this rate; there is no separate fee.
          example: '2900'
        min:
          type: string
          description: >-
            The smallest order in this corridor, measured on the STABLECOIN side
            (`from_amount` on a to-bank order, `to_amount` on a from-bank
            order). Below it a quote is `amount_below_minimum`.
          example: '1000'
        open:
          type: boolean
          description: >-
            Whether a quote can be taken now: the desk is open and at least one
            direction has a rate. A null rate says which direction is closed.
      required:
        - asset
        - rate_off_ramp
        - rate_on_ramp
        - min
        - open
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: 'Your Jenzy API key: `Authorization: Bearer jz_live_…`'

````

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