Skip to main content
O Pix é o pagamento instantâneo do Banco Central: funciona 24 horas por dia e confirma em segundos. Na AbacatePay, cada cobrança Pix tem um QR Code e um código copia e cola próprios, e o valor entra no seu saldo assim que o cliente paga. O vídeo também está em Pix.

Quando usar o Pix

Os valores das taxas estão em Taxas.
  • Venda de valor baixo ou que precisa de confirmação na hora: Pix.
  • Venda de valor alto: cartão, com parcelamento.
  • Cliente sem cartão que quer pagar depois: boleto.
  • Cobrança recorrente por Pix: Pix Automático, em que o cliente autoriza uma vez e as cobranças da assinatura saem sozinhas.
  • Receber numa chave fixa, sem criar cobrança: Pix por chave.

Como funciona o Pix

O Pix está disponível no checkout, no link de pagamento e no checkout transparente. No checkout e no link, o QR Code aparece na tela de pagamento da AbacatePay. No checkout transparente, você recebe o QR Code pela API e mostra no seu site.
  • Valor mínimo: R$ 1,00 (100 centavos). O banco de quem paga pode ter limites próprios de Pix.
  • QR Code e copia e cola: o cliente escaneia o QR Code ou cola o código no app do banco. Os dois já trazem o valor, e o cliente não digita nada.
  • Saldo: o valor, já sem a taxa, entra no seu saldo na AbacatePay e fica disponível para saque.
Na API, o QR Code vem em brCodeBase64 (imagem PNG em base64, pronta para usar num <img>) e o copia e cola em brCode (texto, bom para mandar por WhatsApp, e-mail ou SMS).

Quanto tempo o Pix vale

Depois do prazo, a cobrança passa para EXPIRED e o QR Code não aceita mais pagamento. A resposta da API traz o momento exato em expiresAt.

Quem pagou

O banco informa à AbacatePay o nome e o CPF/CNPJ de quem fez o Pix. Esses dados chegam em payerInformation:
  • nos webhooks checkout.* e transparent.*;
  • na consulta do checkout, em GET /v2/checkouts/get, que também traz o banco de origem quando ele é informado.
O CPF/CNPJ vem mascarado. No webhook, isSameAsCustomer diz se quem pagou tem o mesmo CPF/CNPJ do cliente da cobrança:
Se o checkout não pedir os dados do cliente (flag skip_customer, veja Checkout), a cobrança sai sem cliente, e quem pagou chega só por payerInformation.

Exigir o mesmo CPF ou CNPJ do cliente

No checkout transparente, ensureSameTaxId: true faz o Pix só ser aceito se quem paga tiver o mesmo CPF/CNPJ de customer.taxId. Se outra pessoa tentar pagar o QR Code, o banco recusa o pagamento. Use em cobranças nominais, como mensalidades e faturas.
  • Exige customer com taxId. Sem ele, a API responde ensureSameTaxId requires a customer with taxId.
  • Vale só para Pix no checkout transparente.
  • Nem toda conta tem a trava disponível. Quando não tem, a API responde ensureSameTaxId is not supported by the current PIX provider.
  • No Modo Teste, a trava não é aplicada.

Dividir o Pix com subcontas

Com data.splits, parte de um Pix do checkout transparente vai para o saldo das suas subcontas quando o cliente paga. As regras estão em Subcontas e split.

Status do Pix

Esses são os status da cobrança Pix do checkout transparente (pix_char_...). No checkout e no link, o status do checkout acompanha o pagamento: veja Checkout. O MED (Mecanismo Especial de Devolução) é o processo do Banco Central para o pagador contestar um Pix, em caso de fraude ou golpe. Enquanto a contestação está aberta, a cobrança fica UNDER_DISPUTE.

Pelo dashboard

  1. Em Sua Loja → Links de pagamento, clique em Criar link de pagamento. Para uma cobrança avulsa, use Sua Loja → Cobranças → Criar cobrança.
  2. Em Métodos de pagamento, marque Pix.
  3. Mande o link ao cliente. Ele escolhe Pix e paga com o QR Code ou com o botão Copiar código PIX.
  4. Acompanhe os pagamentos em Sua Loja → Cobranças.
O Pix do checkout transparente só é criado pela API. As cobranças dele aparecem na aba Checkout Transparente de Sua Loja → Cobranças.

Pela API

Inclua "PIX" em methods. Se você omitir methods, o checkout aceita Pix e cartão. Veja Criar um checkout e Criar um link de pagamento.

No checkout transparente

Chame POST /v2/transparents/create com method: "PIX". Só data.amount é obrigatório:
A resposta traz o QR Code, o copia e cola e a validade:

Consultar o status

Para saber se um Pix do checkout transparente foi pago, use GET /v2/transparents/check. Ele devolve só id, status e expiresAt, e aceita apenas Pix: com um id de boleto ou de cartão, a resposta é Pix QR Code not found. Para ver a cobrança completa, use GET /v2/transparents/get. Prefira os webhooks a consultar a API em intervalos: a confirmação chega assim que o cliente paga.

Notificações

O conteúdo de cada evento está em eventos de checkout e eventos do checkout transparente. Não há evento de expiração: use expiresAt ou consulte o status. Para configurar, veja Webhooks.

Testar no Modo Teste

  • Checkout e link de pagamento: na tela do Pix, clique em Simular Pagamento.
  • Checkout transparente: chame POST /v2/transparents/simulate-payment com o id da cobrança. A simulação existe só para Pix e só no Modo Teste.
  • Expiração: no Modo Teste, a cobrança expira de verdade no prazo de expiresIn, que aceita a partir de 60 segundos. Use um prazo curto para testar o EXPIRED.

Perguntas frequentes

24 horas. No checkout transparente, você muda o prazo com expiresIn. O QR Code de autorização do Pix Automático vale 1 hora.
R1,00(‘100‘centavos).Paraboleto,omıˊnimoeˊR 1,00 (`100` centavos). Para boleto, o mínimo é R 3,00.
Sim. Assim que o cliente paga, o valor entra no seu saldo na AbacatePay. Para mandar para a sua conta bancária, faça um saque.
Pelo webhook checkout.completed ou transparent.completed, pelo dashboard em Sua Loja → Cobranças ou, no checkout transparente, pela rota /transparents/check.
Não. No checkout e no link, ele volta à tela de pagamento e gera outro QR Code. No checkout transparente, crie uma cobrança nova.
Sim, no checkout transparente. Envie ensureSameTaxId: true com o customer.taxId. Veja Exigir o mesmo CPF ou CNPJ do cliente.
Sim. O reembolso devolve o valor ao pagador. Veja Reembolsos.