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

# Get a wallet



## OpenAPI

````yaml GET /v1/wallets/{id}
openapi: 3.1.0
info:
  title: KryptaPay API
  version: 1.0.0
  description: >-
    Collect and pay out across Africa — Mobile Money, bank transfers and
    stablecoins — through one REST API.


    Authenticate every request with your secret API key: `Authorization: Bearer
    kp_<env>_…`.

    All responses use the envelope `{ "ok": boolean, "data"?: …, "error"?: {
    "code", "message", "details"? } }`.
  contact:
    name: KryptaPay Support
    email: support@krypta-pay.com
    url: https://krypta-pay.com
servers:
  - url: https://staging.api.krypta-pay.com
    description: Sandbox
  - url: https://api.krypta-pay.com
    description: Production
security:
  - apiKey: []
tags:
  - name: Payins
    description: Collect money from your customers' Mobile Money wallets.
  - name: Payouts
    description: Send money to Mobile Money wallets, bank accounts and crypto addresses.
  - name: Fees
    description: Know the exact fee before you move money.
  - name: FX
    description: Exchange rates, quotes and conversions between your wallets.
  - name: Wallets
    description: Balances of your multi-currency wallets.
  - name: Transactions
    description: Unified history of every movement on your account.
  - name: Networks
    description: Which payment networks are currently available.
  - name: Status
    description: Public platform status.
paths:
  /v1/wallets/{id}:
    get:
      tags:
        - Wallets
      summary: Get a wallet
      operationId: getWallet
      parameters:
        - schema:
            type: string
          in: path
          name: id
          required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      kind:
                        type: string
                        enum:
                          - FIAT
                          - STABLECOIN
                          - VIRTUAL_IBAN
                          - VIRTUAL_ACH
                      currency:
                        $ref: '#/components/schemas/Currency'
                      label:
                        type:
                          - string
                          - 'null'
                      balance:
                        type: string
                        pattern: ^\d+(\.\d{1,8})?$
                        description: >-
                          Decimal amount with up to 8 fractional digits, e.g.
                          "1500" or "1500.75"
                      reserved:
                        type: string
                        pattern: ^\d+(\.\d{1,8})?$
                        description: >-
                          Decimal amount with up to 8 fractional digits, e.g.
                          "1500" or "1500.75"
                      available:
                        type: string
                        pattern: ^\d+(\.\d{1,8})?$
                        description: >-
                          Decimal amount with up to 8 fractional digits, e.g.
                          "1500" or "1500.75"
                      chain:
                        $ref: '#/components/schemas/Network'
                      address:
                        type:
                          - string
                          - 'null'
                      byCountry:
                        type: array
                        items:
                          type: object
                          properties:
                            country:
                              type:
                                - string
                                - 'null'
                            amount:
                              type: string
                              pattern: ^\d+(\.\d{1,8})?$
                              description: >-
                                Decimal amount with up to 8 fractional digits,
                                e.g. "1500" or "1500.75"
                          required:
                            - country
                            - amount
                          additionalProperties: false
                    required:
                      - id
                      - kind
                      - currency
                      - label
                      - balance
                      - reserved
                      - available
                      - chain
                      - address
                    additionalProperties: false
                required:
                  - ok
                  - data
                additionalProperties: false
              example:
                ok: true
                data:
                  id: cmgx2k1qv0002s60f1a9b8c7d
                  kind: FIAT
                  currency: XOF
                  label: XOF wallet
                  balance: '1250000'
                  reserved: '15150'
                  available: '1234850'
                  chain: null
                  address: null
                  byCountry:
                    - country: BJ
                      amount: '1250000'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    Currency:
      type: string
      enum:
        - XOF
        - XAF
        - NGN
        - GHS
        - CDF
        - EUR
        - USD
        - USDC
        - USDT
      description: ISO currency code (fiat) or stablecoin ticker.
    Network:
      type: string
      enum:
        - MTN_BJ
        - MTN_CI
        - MTN_CM
        - ORANGE_CI
        - ORANGE_SN
        - ORANGE_ML
        - ORANGE_BF
        - ORANGE_CM
        - MOOV_BJ
        - MOOV_TG
        - MOOV_CI
        - MOOV_BF
        - WAVE_CI
        - WAVE_SN
        - FREE_SN
        - TMONEY_TG
        - MOBICASH_ML
        - MOBICASH_BF
        - DJAMO_CI
        - MIXX_SN
        - MTN_CG
        - AIRTEL_CG
        - ORANGE_CD
        - AIRTEL_CD
        - VODACOM_CD
        - AFRICELL_CD
        - AIRTEL_GA
        - MOMO_NG
        - AIRTEL_NG
        - OPAY_NG
        - MTN_GH
        - VODAFONE_GH
        - AIRTELTIGO_GH
        - BANK_XOF
        - BANK_XAF
        - BANK_NGN
        - BANK_GHS
        - BANK_CDF
        - BANK_EUR
        - BANK_USD
        - ETH
        - POLYGON
        - TRON
      description: >-
        Payment network. See [Networks & currencies](/networks) for countries
        and limits.
    Error:
      type: object
      properties:
        ok:
          type: boolean
          enum:
            - false
        error:
          type: object
          properties:
            code:
              type: string
              description: Stable, machine-readable code. Branch on this, not on `message`.
            message:
              type: string
              description: Human-readable explanation. May change; do not parse.
            details:
              description: >-
                Extra context. For `validation_error`: `{ formErrors,
                fieldErrors }`.
          required:
            - code
            - message
      required:
        - ok
        - error
  responses:
    Unauthorized:
      description: Missing, invalid or expired API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            ok: false
            error:
              code: unauthorized
              message: Invalid or expired API key
    Forbidden:
      description: >-
        The key lacks the required scope (`insufficient_scope`), or the account
        is not KYB-approved (`kyb_required`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            ok: false
            error:
              code: kyb_required
              message: Your organization must complete KYB verification.
    NotFound:
      description: The resource does not exist or belongs to another account.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            ok: false
            error:
              code: not_found
              message: Payout not found
    RateLimited:
      description: >-
        Too many requests. Wait for the number of seconds in the `retry-after`
        header.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            ok: false
            error:
              code: rate_limited
              message: Rate limit exceeded, retry in 1 minute
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        Secret API key from **Dashboard → Developers**: `kp_sandbox_…` for
        Sandbox, `kp_live_…` for Production. Server-side only.

````

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