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

# Get a settlement order



## OpenAPI

````yaml /openapi.yaml get /api/integrations/settlements/orders/{orderId}
openapi: 3.1.0
info:
  title: COP By Integrations API
  version: 0.1.0
  description: |
    Non-custodial Celo API for partners. Prepare swaps and BRE-B COP payouts;
    the user signs from their wallet. Confirm with the transaction hash.
servers:
  - url: https://api.copby.digitalcop.shop
    description: Production API
security:
  - bearerAuth: []
tags:
  - name: Settlement
    description: Quote Arc USDC and create settlement orders that deliver COPm on Celo
  - name: Swaps
    description: Prepare and confirm onchain COPm swaps
  - name: BRE-B
    description: Quote, KYC, and COP payouts via Bridge Bre-B
  - name: Webhooks
    description: >
      Bridge → COP By inbound callbacks, plus outbound partner payout webhooks
      (REQ-INT-WH-01).

      Partners configure URL + signing secret in the dashboard; deliveries are
      HMAC-signed.
paths:
  /api/integrations/settlements/orders/{orderId}:
    get:
      tags:
        - Settlement
      summary: Get a settlement order
      operationId: getSettlementOrder
      parameters:
        - name: orderId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Organization-owned settlement order
          content:
            application/json:
              schema:
                type: object
                required:
                  - order
                properties:
                  order:
                    $ref: '#/components/schemas/SettlementOrder'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/SettlementError'
        '429':
          $ref: '#/components/responses/SettlementError'
components:
  schemas:
    SettlementOrder:
      type: object
      required:
        - orderId
        - quoteId
        - organizationId
        - sourceAddress
        - destinationAddress
        - status
        - health
        - fundsStatus
        - createdAt
        - updatedAt
      properties:
        orderId:
          type: string
        quoteId:
          type: string
        organizationId:
          type: string
        sourceAddress:
          $ref: '#/components/schemas/Address'
        destinationAddress:
          $ref: '#/components/schemas/Address'
        status:
          type: string
          enum:
            - CREATED
            - BURNED
            - ATTESTED
            - MINTED
            - ROUTING
            - ROUTED
            - DELIVERED
            - REFUND_PENDING
            - REFUNDING
            - REFUNDED
            - FAILED
        health:
          type: string
          enum:
            - HEALTHY
            - STUCK
        fundsStatus:
          type: string
          enum:
            - IN_USER_WALLET
            - BURNED_ON_ARC
            - AWAITING_ATTESTATION
            - USDC_ON_ARBITRUM
            - IN_TRANSIT_TO_CELO
            - USDM_ON_CELO
            - COPM_ON_CELO
            - DELIVERED_TO_DESTINATION
            - REFUND_IN_TRANSIT
            - REFUNDED_TO_SOURCE
            - UNKNOWN
        reference:
          type:
            - string
            - 'null'
        burnTxHash:
          type:
            - string
            - 'null'
        messageHash:
          type:
            - string
            - 'null'
        burnNonce:
          type:
            - string
            - 'null'
        burnedAt:
          type:
            - string
            - 'null'
          format: date-time
        stuckReason:
          type:
            - string
            - 'null'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Address:
      type: string
      pattern: ^0x[a-fA-F0-9]{40}$
      example: '0x2222222222222222222222222222222222222222'
    SettlementErrorBody:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - stage
            - fundsStatus
            - fundsMoved
            - retryable
            - nextAction
          properties:
            code:
              type: string
              enum:
                - INVALID_REQUEST
                - RATE_LIMITED
                - INVALID_AMOUNT
                - INVALID_SOURCE_ADDRESS
                - INVALID_DESTINATION_ADDRESS
                - BELOW_MINIMUM
                - ABOVE_MAXIMUM
                - QUOTE_EXPIRED
                - QUOTE_NOT_FOUND
                - ROUTE_UNAVAILABLE
                - SLIPPAGE_LIMIT_EXCEEDED
                - MENTO_CAPACITY_EXCEEDED
                - IDEMPOTENCY_CONFLICT
                - QUOTE_ALREADY_USED
                - INVALID_IDEMPOTENCY_KEY
                - ORDER_NOT_FOUND
                - PROVIDER_UNAVAILABLE
                - INTERNAL_ERROR
                - INTAKE_PAUSED
            message:
              type: string
            stage:
              type: string
            fundsStatus:
              type: string
            fundsMoved:
              type: boolean
            retryable:
              type: boolean
            nextAction:
              type: string
            requestId:
              type: string
  responses:
    Unauthorized:
      description: Missing or invalid integration API key
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
    SettlementError:
      description: Settlement lifecycle error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SettlementErrorBody'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Integration API key. Send as `Bearer copby_live_pk_…`.

````