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

> Returns cumulative conversion progress for your credited incoming CNGN transaction. Requires wallets:view. Store only the highest revision per transaction, whether received here or through conversion.updated. Completed means no restricted amount remains; funds may have been released or returned. Use balances and withdrawal quotes for current spendability. Returns 404 for unknown, unowned, or not-yet-credited transactions.

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/transactions/{transaction_id}/conversion
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/transactions/{transaction_id}/conversion:
    get:
      tags:
        - Wallets
      summary: Get CNGN conversion progress
      description: >-
        Returns cumulative conversion progress for your credited incoming CNGN
        transaction. Requires wallets:view. Store only the highest revision per
        transaction, whether received here or through conversion.updated.
        Completed means no restricted amount remains; funds may have been
        released or returned. Use balances and withdrawal quotes for current
        spendability. Returns 404 for unknown, unowned, or not-yet-credited
        transactions.
      operationId: get_partner_wallets_transactions_transaction_id_conversion
      parameters:
        - description: >-
            Incoming CNGN wallet transaction ID from wallet transactions or a
            deposit webhook. This is not a blockchain transaction hash.
          example: 019a0430-0000-7000-8000-000000000001
          in: path
          name: transaction_id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              example:
                data:
                  currency: NGN
                  initially_restricted_amount: '10000000.00'
                  released_amount: '4000000.00'
                  remaining_amount: '5000000.00'
                  returned_amount: '1000000.00'
                  revision: 3
                  settlement_rail: CNGN
                  status: pending
                  transaction_id: 019a0430-0000-7000-8000-000000000001
                status: success
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/CngnConversionResponse'
                  status:
                    enum:
                      - success
                    type: string
                required:
                  - status
                  - data
                type: object
          description: Cumulative conversion progress
        '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: Conversion progress not found or deposit not yet credited
        '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: Conversion progress temporarily unavailable
      security:
        - api_key: []
components:
  schemas:
    CngnConversionResponse:
      properties:
        currency:
          description: >-
            Amounts are cumulative decimal wallet-currency strings, net of the
            deposit fee.
          type: string
        initially_restricted_amount:
          description: Portion of the original net deposit awaiting conversion capacity.
          type: string
        released_amount:
          description: >-
            Cumulative amount released from the conversion restriction. Read
            balances

            for current spendability; later activity can consume released funds.
          type: string
        remaining_amount:
          description: >-
            Initially restricted minus released and returned. Can include funds

            committed to a pending withdrawal; use quotes for withdrawal
            eligibility.
          type: string
        returned_amount:
          description: >-
            Restricted amount returned through its origin rail or transferred to
            another Stabyl

            account. Internal transfers retain the restriction for the
            recipient.
          type: string
        revision:
          description: >-
            Increasing progress revision. Keep the highest revision per
            transaction

            across REST reads and conversion.updated deliveries.
          format: int64
          type: integer
        settlement_rail:
          description: Origin settlement rail; for example CNGN for an NGN wallet.
          example: CNGN
          type: string
        status:
          description: >-
            pending while remaining_amount is positive; completed when it is
            zero.

            Completion can result from release, return, or both.
          type: string
        transaction_id:
          description: Incoming wallet transaction ID, not the blockchain transaction hash.
          format: uuid
          type: string
      required:
        - transaction_id
        - revision
        - currency
        - settlement_rail
        - initially_restricted_amount
        - released_amount
        - returned_amount
        - remaining_amount
        - status
      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.