Pix imediato (Cob)

O Pix imediato é indicado para cobranças que devem ser pagas logo após a criação, como acontece nas compras feitas em lojas virtuais.

No checkout, por exemplo, o cliente escolhe Pix como forma de pagamento e recebe um QR Code ou código Copia e Cola. A partir desse momento, ele tem um prazo para concluir o pagamento.

Enquanto não houver confirmação, o pedido deve permanecer aguardando pagamento.

Quando usar

Compras online: o cliente seleciona Pix no checkout e recebe os dados para pagamento.
Pedidos com reserva temporária: o estabelecimento mantém o pedido aguardando pagamento por um período definido. Se o prazo terminar sem confirmação, o pedido pode ser cancelado conforme as regras da loja.
Cobranças para pagamento imediato: quando não é necessário definir uma data futura de vencimento ou condições adicionais, como juros e multa.

Expiração

É possível definir por quanto tempo a cobrança Pix ficará válida.

Esse prazo permite que o e-commerce controle quanto tempo o pedido pode permanecer aguardando pagamento. Por exemplo, uma loja pode estabelecer um período de 15 minutos para o cliente concluir a compra.

Se o prazo terminar sem confirmação, a cobrança poderá expirar. O que acontece com o pedido depende das regras definidas pelo estabelecimento.

flowchart TD
    A["Cliente realiza o pedido"]
    B["E-commerce cria a cobrança Pix imediato"]
    C["Cliente recebe o QR Code ou código Copia e Cola"]
    D{"Pagamento confirmado antes da expiração?"}
    E["Cyclopay confirma o pagamento"]
    F["E-commerce recebe a confirmação por webhook ou consulta"]
    G["Pedido atualizado e liberado conforme as regras da loja"]
    H["Prazo de pagamento encerrado sem confirmação"]
    I["Cobrança expirada"]
    J["Pedido atualizado ou cancelado conforme as regras da loja"]
    A --> B
    B --> C
    C --> D
    D -->|Sim| E
    E --> F
    F --> G
    D -->|Não| H
    H --> I
    I --> J

    classDef default fill:#1C2026,stroke:#434B57,color:#F0F2F5
    classDef decision fill:#243249,stroke:#568AF6,color:#FFFFFF
    classDef success fill:#173D30,stroke:#36A67A,color:#D9F6E8
    classDef expired fill:#462B2B,stroke:#C77474,color:#FFE2E2

    class D decision
    class E,F,G success
    class H,I,J expired

📘
A cobrança foi criada. E agora?
O pedido deve continuar aguardando pagamento até que a confirmação seja recebida. Uma resposta HTTP de sucesso ao criar a cobrança significa apenas que a solicitação foi processada, não que o cliente pagou.

O que mostrar ao comprador

Depois de criar a cobrança, apresente as informações necessárias para que o cliente consiga pagar.

Exiba o QR Code e disponibilize o código Pix Copia e Cola.
Mostre o tempo restante para pagamento ou o horário de expiração.
Informe o que acontece se o prazo terminar sem pagamento.
ok vaAtualize a situação do pedido quando a confirmação chegar.

Se a cobrança expirar, evite manter na tela um QR Code que já não deveria ser utilizado. Oriente o comprador a gerar uma nova cobrança, caso essa opção esteja disponível no checkout.

Informações para integração

o Pix imediato utiliza payment_method = pix-cob.

O prazo de expiração podeser configurado no objeto Pix enviado na criação da cobrança.

Os dados necessários para apresentar o QR Code e o código Copia e Cola são retornados na Transação.

Para implementar a integração, consulte a Referência da API, onde estão disponíveis os campos aceitos, a unidade utilizada para o tempo de expiração e o formato atualizado do payload.

A confirmação do pagamento deve ser acompanhada pelo estado da Venda e da Transação, utilizando webhooks e consultas à API quando necessário.