Este documento descreve o passo a passo de como integrar o meio de pagamento Pix via API do PagSeguro.
O Pix é uma modalidade de pagamentos criada e regulamentada pelo Banco Central do Brasil (BCB). Permite que uma transação seja realizada a qualquer dia (24x7), inclusive em domingos e feriados e permite a conciliação imediata pois leva apenas alguns segundos para ser concluída.
Importante
Você precisa ter uma chave Pix cadastrada no PagSeguro para que seu Qr Code seja gerado com o arranjo Pix. (veja como cadastrar uma chave pix)
Autenticação
Veja como obter suas chaves de acesso (token) neste link.
Criando um pedido com QR Code Pix
Através desse endpoint é possível criar um pedido com Qr Code Pix, basta realizar a integração através da API de pedidos conforme especificado abaixo.
Criação de pedido com Qr Code Pix
No ambiente de Sandbox é possível utilizar o endpoint abaixo para simular o pagamento de um Qr Code Pix, assim, o integrador consegue mapear e desenvolver a integração validando o fluxo de ponta a ponta.
Simular o pagamento de um Qr Code Pix em sandbox
Solicitando uma Devolução Pix
Assim que um QR Code Pix for pago, é possível solicitar a devolução total ou parcial em até 90 dias. Importante ressaltar que a devolução acontece de forma assíncrona, sendo confirmada através da notificação enviada na URL de callback.
Caso seja feita a devolução de forma parcial o status dessa cobrança permanecerá como PAID. Quando o valor devolvido atingir o valor total do Pix, o status da cobrança mudará para CANCELED.
Webhook
Nós enviamos uma notificação para seu servidor sempre que ocorrer algum evento.
Você receberá esse payload, onde, através do objeto charge será possível verificar o status da cobrança para realizar a conciliação.
O webhook é acionado para:
- Notificação de pagamento
- Status paid, significa que o qr code foi pago;
- Status canceled, houve uma falha no processo de pagamento (o qr code continuará ativo e passível de pagamento até sua data de expiração).
- Notificação de devolução
- O processo de solicitação de devolução for concluído (com sucesso ou falha).
Caso não tenha recebido uma notificação até a expiração do Qr Code, recomendamos que seja realizada a consulta do pedido para verificar se o pagamento foi realizado ou está em andamento.
Na consulta do order será retornado o seguinte payload.
Alguns cenários possíveis:
- Bloco "charges" vazio, indica que não houve pagamento do pedido.
- Bloco "charges" com a tag status "PAID", o pedido foi pago.
- Bloco "charges" com a tag status "AUTHORIZED", o pedido está em andamento, podendo ser pago ou cancelado. Nesse caso deve ser consultado posteriormente.
- Bloco "charges" com a tag status "CANCELED", a charge está cancelada.
Solicitar homologação
Uma vez que você já esteja apto a usar seu produto em Produção é preciso solicitar sua homologação, para isso, basta seguir os passos descritos neste link.
Vai utilizar o Pix através de uma automação comercial ou não encontrou o que procurava? Basta abrir um chamado através deste link.