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

# Get CNGN conversion capacity

> Returns platform-wide NGN conversion capacity with status and observation time. Requires wallets:view. This snapshot does not reserve capacity or guarantee immediate conversion for a subsequent deposit. Eligible deposits receive capacity automatically in FIFO order. Returns 503 when a current snapshot is unavailable.

See the [NGN currency guide](/docs/currencies/ngn.md#cngn) for deposits, conversion capacity, withdrawal limits, and `conversion.updated` webhook handling.


## OpenAPI

````yaml /openapi/openapi.json get /partner/wallets/rails/{rail}/pool
openapi: 3.1.0
info:
  contact:
    email: support@stabyl.com
    name: Stabyl Support
  description: >-
    REST API for approved Stabyl accounts to automate exchange, wallet, and
    non-production simulation workflows.
  license:
    name: Proprietary
  title: Stabyl API
  version: 1.0.0
servers:
  - description: Production
    url: https://api.stabyl.com/v1
  - description: Staging
    url: https://api-staging.stabyl.com/v1
security: []
tags:
  - description: Trading market data and order management for account automation.
    name: Exchange
  - description: >-
      Supported routes, deposit destinations, balances, transactions, and saved
      recipients.
    name: Wallets
  - description: >-
      Outbound event delivery configuration and eventually consistent delivery
      history. Verify Standard Webhooks webhook-id, webhook-timestamp, and
      webhook-signature headers against the unchanged raw request body before
      parsing JSON.
    name: Webhooks
  - description: Non-production endpoints for testing integration behavior.
    name: Simulation
paths:
  /partner/wallets/rails/{rail}/pool:
    get:
      tags:
        - Wallets
      summary: Get CNGN conversion capacity
      description: >-
        Returns platform-wide NGN conversion capacity with status and
        observation time. Requires wallets:view. This snapshot does not reserve
        capacity or guarantee immediate conversion for a subsequent deposit.
        Eligible deposits receive capacity automatically in FIFO order. Returns
        503 when a current snapshot is unavailable.
      operationId: get_partner_wallets_rails_rail_pool
      parameters:
        - description: Settlement rail, case-insensitive. Only CNGN is supported.
          example: CNGN
          in: path
          name: rail
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              example:
                data:
                  as_of: '2026-10-20T12:00:00Z'
                  available: '50000000.00'
                  cap: '500000000.00'
                  currency: NGN
                  rail: CNGN
                  status: available
                  utilized: '450000000.00'
                status: success
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/CngnPoolResponse'
                  status:
                    enum:
                      - success
                    type: string
                required:
                  - status
                  - data
                type: object
          description: Current conversion capacity
        '401':
          content:
            application/json:
              example:
                error:
                  code: UNAUTHORIZED
                  message: missing X-Api-Key header
                status: error
              schema:
                properties:
                  error:
                    properties:
                      code:
                        example: UNAUTHORIZED
                        type: string
                      message:
                        example: missing X-Api-Key header
                        type: string
                    required:
                      - code
                      - message
                    type: object
                  status:
                    enum:
                      - error
                    type: string
                required:
                  - status
                  - error
                type: object
          description: API key required
        '403':
          content:
            application/json:
              example:
                error:
                  code: FORBIDDEN
                  message: request is not allowed
                status: error
              schema:
                properties:
                  error:
                    properties:
                      code:
                        example: FORBIDDEN
                        type: string
                      message:
                        example: request is not allowed
                        type: string
                    required:
                      - code
                      - message
                    type: object
                  status:
                    enum:
                      - error
                    type: string
                required:
                  - status
                  - error
                type: object
          description: Missing wallets:view scope
        '404':
          content:
            application/json:
              example:
                error:
                  code: NOT_FOUND
                  message: resource not found
                status: error
              schema:
                properties:
                  error:
                    properties:
                      code:
                        example: NOT_FOUND
                        type: string
                      message:
                        example: resource not found
                        type: string
                    required:
                      - code
                      - message
                    type: object
                  status:
                    enum:
                      - error
                    type: string
                required:
                  - status
                  - error
                type: object
          description: Pool not available for this rail
        '503':
          content:
            application/json:
              example:
                error:
                  code: SERVICE_UNAVAILABLE
                  message: service unavailable
                status: error
              schema:
                properties:
                  error:
                    properties:
                      code:
                        example: SERVICE_UNAVAILABLE
                        type: string
                      message:
                        example: service unavailable
                        type: string
                    required:
                      - code
                      - message
                    type: object
                  status:
                    enum:
                      - error
                    type: string
                required:
                  - status
                  - error
                type: object
          description: Current capacity temporarily unavailable
      security:
        - api_key: []
components:
  schemas:
    CngnPoolResponse:
      properties:
        as_of:
          description: Time the capacity snapshot was observed.
          format: date-time
          type: string
        available:
          description: >-
            Uncommitted capacity. This is not an account balance or a
            reservation.
          type: string
        cap:
          description: Total conversion capacity, as a decimal wallet-currency string.
          type: string
        currency:
          description: Wallet currency in which all capacity amounts are denominated.
          type: string
        rail:
          description: Origin settlement rail, for example CNGN.
          type: string
        status:
          description: >-
            available, exhausted, or paused. A positive amount during paused
            status

            does not mean conversions can proceed.
          type: string
        utilized:
          description: Capacity used or already committed to conversions.
          type: string
      required:
        - rail
        - currency
        - cap
        - utilized
        - available
        - status
        - as_of
      type: object
  securitySchemes:
    api_key:
      description: >-
        API credential. Withdrawal quote and submit operations additionally
        require the documented Ed25519 timestamp, nonce, and signature headers.
      in: header
      name: X-Api-Key
      type: apiKey
      x-default: sb_test_your_key

````

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