Implementação

Um guia de implementação para auxiliar na integração com a API de autorizações na jornada 3.

Implemente o Pix Automático

A implementação do Pix Automático possui duas etapas principais: criar a autorização da recorrência e, após sua ativação, criar as cobranças recorrentes vinculadas a ela.

📘

Ao concluir este guia, você saberá criar a autorização, acompanhar sua ativação e criar cobranças recorrentes via Pix Automático.

Como funciona

%%{init: {"flowchart": {"nodeSpacing": 18,"rankSpacing": 24,"diagramPadding": 4,"padding": 7}}}%%
flowchart TD
    A["Criar autorização"] --> B["Gerar QR Code"]
    B --> C["Pagador realiza o primeiro pagamento"]
    C --> D["Autorização passa para ACTIVE"]
    D --> E["Criar cobranças recorrentes"]
    E --> F["Receber Webhooks"]
    F --> G["Acompanhar pagamentos"]

    classDef inicio fill:#DBEAFE,stroke:#2563EB,color:#1E3A8A,stroke-width:3px
    classDef decisao fill:#FEF3C7,stroke:#D97706,color:#78350F,stroke-width:3px
    classDef correcao fill:#FFEDD5,stroke:#EA580C,color:#7C2D12,stroke-width:2px
    classDef validacao fill:#E0F2FE,stroke:#0284C7,color:#0C4A6E,stroke-width:2px
    classDef sucesso fill:#DCFCE7,stroke:#16A34A,color:#14532D,stroke-width:3px
    classDef analise fill:#FEE2E2,stroke:#DC2626,color:#7F1D1D,stroke-width:3px

    classDef respostaSim fill:#22C55E,stroke:#15803D,color:#FFFFFF,stroke-width:3px
    classDef respostaNao fill:#EF4444,stroke:#B91C1C,color:#FFFFFF,stroke-width:3px
    classDef respostaDuvida fill:#8B5CF6,stroke:#6D28D9,color:#FFFFFF,stroke-width:3px

    class A inicio
    class B,C,D,E,F validacao
    class G sucesso

    linkStyle default stroke:#94A3B8,stroke-width:2px

1. Crie a autorização

Crie uma autorização com QR Code imediato. Esse QR Code será utilizado para realizar o primeiro pagamento e conceder o consentimento para a recorrência.

Consulte o endpoint: Criar autorização com QR Code imediato.

A resposta disponibiliza, entre outras informações:

CampoFinalidade
payloadCódigo Pix utilizado no primeiro pagamento
idIdentificador da autorização utilizado nas cobranças recorrentes
conciliationIdentifierRelaciona a autorização à cobrança do primeiro pagamento
👍

Recomendado

Armazene o id da autorização. Esse identificador será necessário para criar as cobranças recorrentes.

2. Acompanhe a ativação da autorização

A autorização passa para ACTIVE após o pagador realizar o primeiro pagamento, o Pix ser liquidado com sucesso e o processo de autorização ser concluído. Somente depois dessa ativação novas cobranças podem ser vinculadas à autorização.

⚠️

Acompanhe os Webhooks

Utilize Webhooks para acompanhar as alterações de status da autorização e identificar quando ela passar para ACTIVE.

Consulte os Fluxos de Webhook do Pix Automático.

Caso o pagamento inicial não seja concluído ou a autorização seja recusada, novas cobranças não poderão ser vinculadas a ela.

3. Crie as cobranças recorrentes

Com a autorização em ACTIVE, crie a cobrança informando o id da autorização no campo pixAutomaticAuthorizationId.

CampoFinalidade
pixAutomaticAuthorizationIdRelaciona a cobrança à autorização concedida pelo pagador

Consulte o endpoint: Criar nova cobrança.

⚠️

Atenção

Sem o pixAutomaticAuthorizationId, a cobrança será criada como uma cobrança Pix convencional.

🚧

Intervalo para criação

A instrução de pagamento deve ser criada entre 2 e 10 dias úteis antes do vencimento.

Fora dessa janela, a API retornará uma exceção.

Cuidados importantes

  • O primeiro pagamento não cria automaticamente as cobranças futuras.
  • A integração deve criar as cobranças recorrentes conforme a periodicidade desejada.
  • Recusas, cancelamentos ou revogações da autorização impedem novas cobranças automáticas.

Próximos passos




Did this page help you?