> ## Documentation Index > Fetch the complete documentation index at: https://userepass.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Estado da habilitação de pagamentos por PIX > Retorna o estado do onboarding de pagamentos por PIX (status, documentos, prontidão e fila de liberação) ou `null` quando ainda não foi habilitado. Alimenta o banner da dashboard. ## OpenAPI ````yaml /openapi.json get /payment-enablement openapi: 3.1.0 info: title: Repass API description: >- API pública do Repass — plataforma de gestão de afiliados: programas, links, tracking, atribuição, conversões, comissões, payouts, fiscal (BR), reprocessamento, event store e webhooks. version: 0.1.0 servers: - url: https://api.userepass.com description: Produção security: - bearerAuth: [] - apiKeyAuth: [] tags: - name: Profile description: Perfil do usuário autenticado. - name: Guide description: >- Guia de onboarding do painel: estado de tours, telas visitadas e preferências por usuário e organização. - name: Portal description: >- Portal do afiliado: sessão por identidade de afiliado (sem org), convites e claim. - name: Programs description: 'Programas de afiliados: configuração, atribuição, hold e tiers.' - name: Commission Rules description: Regras de comissão versionadas (imutáveis) por programa. - name: Affiliates description: 'Ciclo de vida do afiliado: cadastro, aprovação, tier, saldo.' - name: Terms description: Termos do programa, versionados. - name: Materials description: >- Materiais (criativos) do programa: upload pelo gestor e download pelos afiliados. - name: Links description: Links rastreáveis e domínios de redirecionamento. - name: Coupons description: Cupons de afiliado e sync com gateway. - name: Pagamentos por PIX description: Habilitação de pagamentos por PIX (onboarding e documentos). - name: Tracking description: Endpoints públicos de redirect e registro de cliques. - name: Clicks description: Consulta de cliques e estatísticas de link. - name: Conversions description: 'Conversões: ingestão S2S, atribuição, matching, fraude e auditoria.' - name: Commissions description: Comissões calculadas, holds, aprovação, void e clawback. - name: Payouts description: Ciclos de pagamento, prévia, execução e comprovantes. - name: Invoices description: Notas fiscais (PJ), envio e validação (BR). - name: Fraud description: Fila de revisão e decisões de fraude. - name: Reprocess description: Reprocessamento com dry-run obrigatório e relatório de impacto. - name: Events description: Histórico de eventos para auditoria e consulta. - name: Notifications description: >- Notificações ao operador (falhas de sincronização, payouts e afins) — registro in-app espelhado por e-mail aos owners/admins. - name: Webhooks description: Endpoints de webhook, entregas, retries e dead-letter. - name: Ingest description: Ingestão de eventos de cobrança (S2S e gateways). - name: Settings description: Configurações por organização (políticas e integrações). - name: Billing description: 'Plano e cobrança: contadores de uso da organização para o painel.' - name: Dashboard description: >- Métricas agregadas da operação (receita, top afiliados, conversões, comissões, novos afiliados) para a home e os relatórios do gestor. - name: Health description: Liveness do serviço. paths: /payment-enablement: get: tags: - Pagamentos por PIX summary: Estado da habilitação de pagamentos por PIX description: >- Retorna o estado do onboarding de pagamentos por PIX (status, documentos, prontidão e fila de liberação) ou `null` quando ainda não foi habilitado. Alimenta o banner da dashboard. operationId: getPaymentEnablement responses: '200': description: Default Response content: application/json: schema: type: object properties: enablement: anyOf: - type: object properties: id: type: string description: Identificador da habilitação (prefixo `pmac_`). organizationId: type: string status: type: string enum: - requested - provisioning - documents_pending - under_review - approved - rejected - suspended description: >- Status interno da habilitação de pagamentos por PIX. `requested`: na fila de liberação (waitlist). `provisioning`: em criação. `documents_pending`: aguardando envio de documentos. `under_review`: em análise. `approved`: apto a transacionar. `rejected`/`suspended`: bloqueado. readiness: type: boolean description: >- `true` quando a habilitação está aprovada (apta a pagar por PIX). waitlisted: type: boolean description: >- `true` quando ainda está na fila de liberação gradual. generalStatus: anyOf: - type: string enum: - NOT_SENT - PENDING - AWAITING_APPROVAL - APPROVED - REJECTED description: Status cru de um eixo/documento no Asaas. - type: 'null' commercialInfoStatus: anyOf: - type: string enum: - NOT_SENT - PENDING - AWAITING_APPROVAL - APPROVED - REJECTED description: Status cru de um eixo/documento no Asaas. - type: 'null' bankAccountInfoStatus: anyOf: - type: string enum: - NOT_SENT - PENDING - AWAITING_APPROVAL - APPROVED - REJECTED description: Status cru de um eixo/documento no Asaas. - type: 'null' documentationStatus: anyOf: - type: string enum: - NOT_SENT - PENDING - AWAITING_APPROVAL - APPROVED - REJECTED description: Status cru de um eixo/documento no Asaas. - type: 'null' pixStatus: anyOf: - type: string enum: - NOT_SENT - PENDING - AWAITING_APPROVAL - APPROVED - REJECTED description: Status cru de um eixo/documento no Asaas. - type: 'null' statusReason: anyOf: - type: string - type: 'null' createdAt: type: string format: date-time updatedAt: type: string format: date-time documents: type: array items: type: object properties: id: type: string description: >- Identificador do documento (prefixo `pmad_`). providerDocumentId: type: string description: Id do grupo de documento no Asaas. type: type: string description: >- Tipo do documento (IDENTIFICATION, IDENTIFICATION_SELFIE, MINUTES_OF_ELECTION, CUSTOM, ...). documentStatus: type: string enum: - NOT_SENT - PENDING - AWAITING_APPROVAL - APPROVED - REJECTED description: Status cru de um eixo/documento no Asaas. submissionMode: type: string enum: - api - link description: >- Como o documento é enviado. `api`: upload dentro do painel. `link`: exige o link de verificação (identidade/selfie). onboardingUrl: anyOf: - type: string - type: 'null' description: >- Link de verificação (sem marca), quando o documento precisa ser enviado por lá. `null` quando o upload é feito no painel. required: - id - providerDocumentId - type - documentStatus - submissionMode - onboardingUrl additionalProperties: false required: - id - organizationId - status - readiness - waitlisted - generalStatus - commercialInfoStatus - bankAccountInfoStatus - documentationStatus - pixStatus - statusReason - createdAt - updatedAt - documents additionalProperties: false - type: 'null' required: - enablement additionalProperties: false components: securitySchemes: bearerAuth: type: http scheme: bearer description: >- Chave de API (prefixo `rstr_`) enviada como `Authorization: Bearer rstr_...`. apiKeyAuth: type: apiKey in: header name: x-api-key description: Chave de API (prefixo `rstr_`) enviada no header `x-api-key`. ````