> ## Documentation Index > Fetch the complete documentation index at: https://docs.fastcac.com/llms.txt > Use this file to discover all available pages before exploring further. # Get your balance ## OpenAPI ````yaml /openapi.json get /balance openapi: 3.1.0 info: title: FastCAC API description: Register Nigerian businesses with CAC from your own product. version: '2026-11-01' servers: - url: https://api.fastcac.com/v1 security: - apiKey: [] tags: - name: Account description: Check your key and see your organization. - name: Names description: >- Check a business name against CAC's rules and registry, and the categories it takes, before registering it. - name: Registrations description: Register a Business Name with CAC, from draft to certificate. - name: Balance description: >- Your prepaid wallet: what's available, its transactions and your funding account. - name: Test helpers description: >- Test keys only: move a registration on without waiting, or simulate a deposit. - name: Webhooks description: Endpoints that receive events, and the events sent to them. - name: Webhook events description: What FastCAC POSTs to your webhook endpoints. paths: /balance: get: tags: - Balance summary: Get your balance operationId: balance_balance_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/V1Balance' examples: Example: value: object: balance available: '1245000.00' held: '0.00' currency: NGN low_balance_threshold: '100000.00' funding_account: account_number: '0000000000' bank_name: TEST BANK account_name: FastCAC - TEST MODE '400': description: The request is invalid; `param` names the field. content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: The API key is missing, malformed, revoked or expired. content: application/json: schema: $ref: '#/components/schemas/Error' examples: Example: value: error: type: authentication_error code: api_key_missing message: 'Send your API key as `Authorization: Bearer `.' param: null request_id: req_YJt2gM0BsAkpffXMBqyXSlRl '403': description: >- The key can't do this (for example, a test helper called with a live key). content: application/json: schema: $ref: '#/components/schemas/Error' examples: Example: value: error: type: permission_error code: live_mode_unavailable message: >- Live registrations are paused right now. Use a test key (fc_test_…) meanwhile. param: null request_id: req_wgBktVSfV339LVnBZfTmu3u1 '404': description: No such object for this key's organization and mode. content: application/json: schema: $ref: '#/components/schemas/Error' examples: Example: value: error: type: not_found_error code: resource_missing message: 'No such registration: reg_0000000000000000000000.' param: id request_id: req_gbQw9iB4MBVzQzZgN79RVjdz '409': description: >- The object's state doesn't allow this, or the Idempotency-Key was reused. content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too many requests; wait for `Retry-After` seconds. content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: V1Balance: properties: object: type: string const: balance title: Object default: balance available: type: string title: Available description: Spendable, in naira, as a decimal string. held: type: string title: Held description: >- Deposits our payments partner is holding for review (over its limit); not spendable yet. currency: type: string const: NGN title: Currency default: NGN low_balance_threshold: anyOf: - type: string - type: 'null' title: Low Balance Threshold description: Below this, a charge sends balance.low. Set on the Billing page. funding_account: anyOf: - $ref: '#/components/schemas/V1FundingAccount' - type: 'null' description: >- Your own account number, once it's active (test mode: a fake one). null until then. type: object required: - available - held - low_balance_threshold - funding_account title: V1Balance Error: properties: error: $ref: '#/components/schemas/ErrorDetail' required: - error title: V1Error type: object V1FundingAccount: properties: account_number: type: string title: Account Number description: Transfer naira here from any Nigerian bank to fund the wallet. bank_name: anyOf: - type: string - type: 'null' title: Bank Name account_name: anyOf: - type: string - type: 'null' title: Account Name description: 'What the payer''s bank app shows: FastCAC - your legal name.' type: object required: - account_number - bank_name - account_name title: V1FundingAccount ErrorDetail: properties: type: type: string enum: - invalid_request_error - authentication_error - payment_error - permission_error - not_found_error - idempotency_error - rate_limit_error - api_error title: Type code: type: string title: Code description: Stable and machine-readable, e.g. registration_incomplete. message: type: string title: Message description: For a developer to read; may change. param: anyOf: - type: string - type: 'null' title: Param description: The parameter at fault, as a path like proprietors[0].nin. request_id: anyOf: - type: string - type: 'null' title: Request Id description: Also in the FastCAC-Request-Id header. Quote it to support. details: anyOf: - additionalProperties: true type: object - type: 'null' title: Details description: >- Only on some errors. A 402 insufficient_balance carries amount_due, balance, currency and funding_account (number, bank, name; null until it's active). type: object required: - type - code - message - param - request_id title: ErrorDetail securitySchemes: apiKey: type: http scheme: bearer description: 'Your secret API key: fc_test_… in test mode, fc_live_… in live mode.' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.