> ## Documentation Index > Fetch the complete documentation index at: https://docs.pay.v4companyamaral.com/llms.txt > Use this file to discover all available pages before exploring further. # Situação da subconta do lojista > Diz se o lojista já tem conta de recebimento **no ambiente da requisição** (teste ou produção). Nunca devolve a chave de API da subconta. ## OpenAPI ````yaml /openapi.yaml get /receiving-account openapi: 3.1.0 info: title: V4Pay API version: 2.0.0 description: > API do gateway de pagamentos V4Pay: autenticação, clientes, cobranças, cupons e emissão de Pix — cada lojista tem uma conta de recebimento no CNPJ dele, e a cobrança leva um split com a taxa do V4 Pay. Todas as rotas protegidas usam token JWT — o usuário é identificado pelo token, nunca por `user_id` no corpo da requisição. servers: - url: https://v4pay-api.vercel.app description: Produção. - url: http://localhost:3000 description: Ambiente local de desenvolvimento. security: [] tags: - name: Pix description: Emitir e consultar cobranças Pix — o coração da API. - name: Cobranças description: Registro direto de cobranças e a listagem do histórico da loja. - name: Clientes description: Cadastro de pagadores para reutilizar nas cobranças. - name: Links de pagamento description: URLs públicas reutilizáveis que abrem o checkout com o valor definido. - name: Checkout (público) description: >- As rotas que a página de pagamento usa — sem autenticação, o pagador não tem conta. - name: Produtos description: Catálogo da loja; um produto pode virar cobrança ou link. - name: Cupons description: Descontos aplicados no checkout e na emissão por produto. - name: Assinaturas description: Cobrança recorrente, gerada por um cron diário. - name: Webhooks (endpoints) description: >- As URLs do seu servidor que recebem os eventos da loja, com assinatura HMAC. - name: Chaves de API description: Credenciais de integração (v4pay_test_ / v4pay_live_), revogáveis. - name: Conta de recebimento description: Cadastro da empresa e a conta que recebe — vale no modo subconta. - name: Aprovação de produção description: >- O fluxo para liberar a operação em produção — dados da empresa, documentos e análise da equipe. - name: Saques description: >- Pedidos de saque do saldo — suspensos no modo conta única (REPASSE_MANUAL). - name: Membros da loja description: Convites e papéis de quem opera a loja junto com o dono. - name: Conta (auth) description: Cadastro, login, perfil e a troca de ambiente da sessão. - name: Auditoria description: Trilha das ações feitas na loja, com quem fez e de onde. - name: Sistema description: Saúde da API. - name: Interno description: >- USO INTERNO DO PAINEL — documentado por transparência, não para integração: pode mudar sem aviso (Roadmap, aprovações da equipe, cron, login com Google, onboarding). paths: /receiving-account: get: tags: - Conta de recebimento summary: Situação da subconta do lojista description: > Diz se o lojista já tem conta de recebimento **no ambiente da requisição** (teste ou produção). Nunca devolve a chave de API da subconta. responses: '200': description: Situação atual. content: application/json: schema: type: object properties: data: type: object properties: existe: type: boolean account_id: type: - string - 'null' wallet_id: type: - string - 'null' status: type: - string - 'null' enum: - creating - pending - approved - rejected - null description: 'Resumo da aprovação: só `approved` pode cobrar.' environment: type: - string - 'null' enum: - test - live - null webhook_registered: type: boolean pix_key: type: - string - 'null' description: >- Chave Pix (EVP) da subconta. É a chave que recebe; sem ela ATIVA não há QR code. pix_key_status: type: - string - 'null' enum: - ACTIVE - AWAITING_ACTIVATION - ERROR - null fee_percent: type: - number - 'null' fee_fixed: type: - number - 'null' aprovacao: $ref: '#/components/schemas/AprovacaoSubconta' conta_unica: type: - boolean - 'null' description: >- true quando o servidor está em modo conta única (temporário). configuracao_pendente: type: boolean description: >- true quando há um erro de configuração no servidor (modo desconhecido ou motor de pagamentos do ambiente sem credencial). provedor_configurado: type: boolean description: >- false quando o motor de pagamentos deste ambiente ainda não está configurado — a abertura da subconta vai falhar. O detalhe do problema fica no log do servidor. Só vem quando `existe` é false. modo: type: - string - 'null' enum: - conta_unica - null description: >- `conta_unica` quando o servidor está cobrando na conta principal do V4 Pay (sem subconta). Nesse modo a resposta vem com `existe: true`, `status: approved` e `aprovacao.aprovada: true` — o lojista não precisa cadastrar empresa — e os campos de subconta (account_id, wallet_id, pix_key…) vêm nulos. Ausente fora do modo. mensagem: type: string '401': $ref: '#/components/responses/Unauthorized' security: - bearerAuth: [] components: schemas: AprovacaoSubconta: type: object description: > Aprovação (KYC) da conta de recebimento. Cada frente vale `PENDING` (falta enviar algo), `AWAITING_APPROVAL` (enviado, em análise), `APPROVED` ou `REJECTED`. Só com `geral = APPROVED` a cobrança é liberada. Enquanto isso, o `link_documentos` leva o lojista à página segura do parceiro para enviar documentos e fazer a selfie; ele some quando não falta mais nada. properties: aprovada: type: boolean description: true quando `geral` é APPROVED. conferida: type: boolean description: false se nunca conseguimos ler a aprovação. geral: type: - string - 'null' enum: - PENDING - AWAITING_APPROVAL - APPROVED - REJECTED - null dados_comerciais: type: - string - 'null' enum: - PENDING - AWAITING_APPROVAL - APPROVED - REJECTED - null conta_bancaria: type: - string - 'null' enum: - PENDING - AWAITING_APPROVAL - APPROVED - REJECTED - null documentos: type: - string - 'null' enum: - PENDING - AWAITING_APPROVAL - APPROVED - REJECTED - null conferida_em: type: - string - 'null' format: date-time link_documentos: type: - string - 'null' format: uri link_documentos_qr: type: - string - 'null' description: >- O mesmo link como QR code (imagem PNG em base64, data URL), para abrir no celular. Só em GET /receiving-account e na conferência. motivos_recusa: type: - string - 'null' description: Texto do motor de pagamentos quando algo foi recusado. ErrorAuth: type: object description: > Segundo formato de erro, usado só pelo middleware de autenticação (token ausente, inválido ou chave revogada). Repare que aqui `error` é uma string, não um objeto. properties: error: type: string example: Token JWT ou chave de API ausente responses: Unauthorized: description: Não autenticado. Repare no formato — `error` é string neste caso. content: application/json: schema: $ref: '#/components/schemas/ErrorAuth' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: > Token JWT obtido em `/auth/login`, enviado no cabeçalho `Authorization` no formato `Bearer `. ````