Documentation Index
Fetch the complete documentation index at: https://docs.pagamentos.dev/llms.txt
Use this file to discover all available pages before exploring further.
O que é Pix?
Pix é o sistema de pagamentos instantâneos do Brasil, desenvolvido pelo Banco
Central. Com ele, é possível realizar transferências e pagamentos em segundos,
24 horas por dia, 7 dias por semana.
Para criar uma cobrança via Pix, utilize o método pg.cobrancas.create com o
metodoPagamento definido como 'pix':
import { pg } from './pagamentos'
const cobranca = await pg.cobrancas.create({
valor: 1000, // R$10,00 - valor em centavos
metodoPagamento: 'pix',
cliente: {
nome: 'João Silva',
documento: '123.456.789-00'
}
})
console.log(cobranca.qrcode) // QR code para pagamento
console.log(cobranca.copiaECola) // Código copia e cola
Parâmetros específicos do Pix
Você pode passar opções adicionais dentro do campo pix:
| Propriedade | Tipo | Descrição |
|---|
expiracaoEmSegundos | number | Tempo de expiração do QR code em segundos |
descricao | string | Descrição que aparecerá no comprovante do pagador |
const cobranca = await pg.cobrancas.create({
valor: 1000,
metodoPagamento: 'pix',
cliente: {
nome: 'João Silva',
documento: '123.456.789-00'
},
pix: {
expiracaoEmSegundos: 3600, // 1 hora
descricao: 'Assinatura Premium'
}
})
Consultando o status
Após criar a cobrança, você pode consultar o status para verificar se o
pagamento foi realizado:
const cobranca = await pg.cobrancas.get('id-da-cobranca')
console.log(cobranca.status) // 'pendente', 'pago', 'cancelado', etc.
Recebendo notificações
O método recomendado para acompanhar o status de um pagamento Pix é utilizando
webhooks. Dessa forma, seu sistema é notificado
automaticamente quando o pagamento é confirmado.
Provedores suportados
Os seguintes provedores oferecem suporte ao Pix:
