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

# Available, pending and reserved balances per currency



## OpenAPI

````yaml /openapi.json get /v1/balances
openapi: 3.1.0
info:
  title: One Pay API
  version: 0.1.0
  description: >-
    One API to collect payments and send payouts across Africa. Amounts are
    integers in minor units (XAF francs, NGN kobo). Guides: the One Pay
    developer docs.
servers:
  - url: https://onepay-api-eiy9.onrender.com
    description: One Pay (your key decides test or live)
  - url: http://localhost:3000
    description: Local development
security:
  - bearerAuth: []
paths:
  /v1/balances:
    get:
      tags:
        - Merchant
      summary: Available, pending and reserved balances per currency
      operationId: getV1Balances
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Balances'
        '401':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Balances:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              currency:
                type: string
                enum:
                  - XAF
                  - NGN
              available:
                type: integer
                minimum: -9007199254740991
                maximum: 9007199254740991
              pending:
                type: integer
                minimum: -9007199254740991
                maximum: 9007199254740991
              reserved:
                type: integer
                minimum: -9007199254740991
                maximum: 9007199254740991
            required:
              - currency
              - available
              - pending
              - reserved
            additionalProperties: false
        mode:
          type: string
          enum:
            - test
            - live
      required:
        - data
        - mode
      additionalProperties: false
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            request_id:
              type: string
          required:
            - code
            - message
            - request_id
          additionalProperties: false
      required:
        - error
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your secret key: sk_test_... or sk_live_...'

````

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