> ## 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 orders

> Your orders, newest first, optionally filtered by `asset` (either side) and `status`. Pass `next_before_id` back as `before_id` for the next page; null means done.



## OpenAPI

````yaml /v2/openapi.json get /orders
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:
    get:
      summary: List orders
      description: >-
        Your orders, newest first, optionally filtered by `asset` (either side)
        and `status`. Pass `next_before_id` back as `before_id` for the next
        page; null means done.
      parameters:
        - schema:
            type: integer
            minimum: 1
            maximum: 200
            description: Page size, 1-200 (default 50).
          required: false
          description: Page size, 1-200 (default 50).
          name: limit
          in: query
        - schema:
            type: string
            format: uuid
            description: 'Keyset cursor: the `next_before_id` from the previous page.'
          required: false
          description: 'Keyset cursor: the `next_before_id` from the previous page.'
          name: before_id
          in: query
        - schema:
            type: string
            minLength: 1
            description: Only orders with this asset on either side.
            example: USDC
          required: false
          description: Only orders with this asset on either side.
          name: asset
          in: query
        - schema:
            type: string
            enum:
              - accepted
              - processing
              - awaiting_instructions
              - awaiting_funds
              - proof_submitted
              - funds_confirmed
              - expired
              - completed
              - failed
              - cancelled
            description: Only orders in this status.
          required: false
          description: Only orders in this status.
          name: status
          in: query
        - $ref: '#/components/parameters/HermesOrg'
      responses:
        '200':
          description: One page of orders.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderList'
        '400':
          description: Malformed `limit`, `before_id`, `asset` or `status`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '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:
    OrderList:
      type: object
      properties:
        orders:
          type: array
          items:
            $ref: '#/components/schemas/Order'
        has_more:
          type: boolean
        next_before_id:
          type:
            - string
            - 'null'
          format: uuid
          description: Pass back as `before_id` for the next page; null means done.
      required:
        - orders
        - has_more
        - next_before_id
    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
    Order:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The order id — your handle for polling and support.
        client_ref:
          type: string
          example: inv-1042
        from_asset:
          type: string
          minLength: 1
          description: >-
            An asset code as `GET /v2/assets` lists it — uppercase, never
            compound (`USDC`, `USD`; never `USDC-ETHEREUM`). Network and rail
            live on the payment object.
          example: USDT
        from_amount:
          type: string
          description: >-
            What you pay, in `from_asset`. On a to-bank order this is held from
            your balance at creation.
          example: '1000'
        to_asset:
          type: string
          minLength: 1
          description: >-
            An asset code as `GET /v2/assets` lists it — uppercase, never
            compound (`USDC`, `USD`; never `USDC-ETHEREUM`). Network and rail
            live on the payment object.
          example: BIF
        to_amount:
          type: string
          description: >-
            What the beneficiary receives (to-bank order) or you are credited
            (from-bank order), in `to_asset`.
          example: '2850500'
        rate:
          type: string
          description: 'The quote’s rate: corridor currency per one stablecoin.'
          example: '2850.5'
        status:
          type: string
          enum:
            - accepted
            - processing
            - awaiting_instructions
            - awaiting_funds
            - proof_submitted
            - funds_confirmed
            - expired
            - completed
            - failed
            - cancelled
          description: >-
            To-bank order: `accepted` (your stablecoin is held) → `processing`
            (the desk is paying the beneficiary) → `completed` | `failed` |
            `cancelled`. From-bank order: `awaiting_instructions` →
            `awaiting_funds` (see `funding`; wire before `expires_at`) →
            `proof_submitted` → `funds_confirmed` → `completed` | `expired` |
            `failed` | `cancelled`. There is no cancel endpoint; ask Jenzy
            operations.
          example: accepted
        failure:
          type:
            - object
            - 'null'
          properties:
            code:
              type: string
              enum:
                - unable_to_fill
                - beneficiary_rejected
                - funds_not_received
                - not_delivered
                - other
            message:
              type: string
          required:
            - code
            - message
          description: >-
            Set only on `failed`: one of the published codes with its fixed
            message.
        refund:
          type: object
          properties:
            status:
              type: string
              enum:
                - pending
                - returned
          required:
            - status
          description: >-
            Present on a to-bank order that failed after the coins had left.
            `pending` — your stablecoin is on its way back; `returned` — it has
            been credited to your balance as a collection.
        beneficiary:
          type: object
          properties:
            name:
              type: string
            bank_name:
              type: string
            account_number:
              type: string
            branch:
              type: string
          required:
            - name
            - bank_name
            - account_number
          description: To-bank orders only, exactly as you sent it.
        funding:
          type: object
          properties:
            bank_name:
              type: string
            account_name:
              type: string
            account_number:
              type: string
            reference:
              type: string
              description: >-
                Write this on your transfer. It is how the desk matches your
                money to this order.
            amount:
              type: string
              description: Exactly `from_amount`.
            asset:
              type: string
              description: Exactly `from_asset`.
            deadline:
              type: string
              format: date-time
              description: Equals `expires_at`.
          required:
            - bank_name
            - account_name
            - account_number
            - reference
            - amount
            - asset
            - deadline
          description: >-
            From-bank orders only, present from `awaiting_funds`: where to wire
            your `from_amount`. Immutable once set.
        proofs:
          type: object
          properties:
            funding:
              type: object
              properties:
                uploaded_at:
                  type: string
                  format: date-time
                rejected_reason:
                  type: string
                  description: Present when the desk rejected this proof; upload a new one.
              required:
                - uploaded_at
          description: Your newest funding proof on a from-bank order, if any.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        expires_at:
          type: string
          format: date-time
          description: >-
            From-bank orders only: the funding deadline. Past it with no proof
            the order is `expired`.
        receipt_url:
          type:
            - string
            - 'null'
          format: uri
          description: >-
            The public link to the receipt of an order that pays a bank
            beneficiary. Send it to your beneficiary: the page shows the status
            of the payment, not your fee or rate. Null on an order that pays
            you. In the sandbox the link is on `track.sandbox.jenzy.com`.
      required:
        - id
        - client_ref
        - from_asset
        - from_amount
        - to_asset
        - to_amount
        - rate
        - status
        - failure
        - proofs
        - created_at
        - updated_at
        - receipt_url
  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.