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

# Consulta saldo

> Consulta o saldo de certificados do parceiro.

> [!NOTE]
>
> Veja também: [Erros](https://docs.certificados.zapsign.com.br/erros.md)


## OpenAPI

````yaml /api-reference/openapi.json get /api/v2/partners/credits
openapi: 3.1.0
info:
  title: Certificados ZapSign Partner API v2
  version: 2.0.0
  description: >-
    API REST para parceiros criarem e acompanharem protocolos de certificado
    digital e-CPF e e-CNPJ (A1 e A3 em nuvem), emitidos por videoconferência.
  contact:
    name: Suporte Certificados ZapSign
    url: https://wa.me/5511952135263
servers:
  - url: https://certificados.zapsign.com.br
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Protocolos
    description: Criação, consulta, listagem e cancelamento de protocolos.
  - name: Verificação
    description: Verificação opcional do titular antes de criar o protocolo.
  - name: Agendamento
    description: Horários livres e agendamento da videoconferência.
  - name: Saldo e catálogo
    description: Saldo atual e certificados disponíveis para o parceiro.
paths:
  /api/v2/partners/credits:
    get:
      tags:
        - Saldo e catálogo
      summary: Consulta saldo
      description: Consulta o saldo de certificados do parceiro.
      operationId: getCredits
      responses:
        '200':
          description: Saldo atual.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditsResponse'
              examples:
                Saldo atual:
                  summary: Saldo atual
                  value:
                    credits_available: 4
      x-codeSamples:
        - lang: curl
          label: cURL
          source: |-
            curl 'https://certificados.zapsign.com.br/api/v2/partners/credits' \
              -H 'Authorization: Bearer czk_live_SUA_CHAVE'
        - lang: javascript
          label: Node.js (fetch)
          source: >-
            const res = await fetch(
              'https://certificados.zapsign.com.br/api/v2/partners/credits',
              {
                headers: {
                  Authorization: 'Bearer czk_live_SUA_CHAVE',
                },
              },
            );

            const saldo = await res.json();

            // `saldo.credits_available` é a quantidade de certificados
            disponíveis.
        - lang: python
          label: Python (requests)
          source: >-
            import requests


            res = requests.get(
                'https://certificados.zapsign.com.br/api/v2/partners/credits',
                headers={
                    'Authorization': 'Bearer czk_live_SUA_CHAVE',
                },
            )

            saldo = res.json()

            # saldo['credits_available'] é a quantidade de certificados
            disponíveis.
components:
  headers:
    XRequestId:
      description: Identificador da chamada. Informe-o ao suporte se precisar de ajuda.
      schema:
        type: string
        example: 01K7Q4A1B2C3D4E5F6G7H8J9KM
  schemas:
    CreditsResponse:
      type: object
      required:
        - credits_available
      properties:
        credits_available:
          type: integer
          minimum: 0
          description: >-
            Certificados disponíveis para criar protocolos. Cada protocolo
            desconta o `credits_required` do certificado escolhido.
          example: 4
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: czk_live_*
      description: >-
        API key criada no [portal do
        parceiro](https://certificados.zapsign.com.br/reseller/api-keys).

````

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