Skip to main content

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 é?

O pagamento via cartão de crédito permite que seus clientes paguem à vista ou parcelado, oferecendo maior flexibilidade e potencial de conversão. A pagamentos.dev abstrai a complexidade da tokenização e processamento, permitindo que você crie cobranças de forma simples e segura.

​
Criando uma cobrança com cartão de crédito

Para criar uma cobrança via cartão de crédito, utilize o método pg.cobrancas.create com o metodoPagamento definido como 'cartaoCredito': 
import { pg } from './pagamentos'

const cobranca = await pg.cobrancas.create({
  valor: 10000, // R$100,00 - valor em centavos
  metodoPagamento: 'cartaoCredito',
  cliente: {
    nome: 'Carlos Pereira',
    documento: '456.789.123-00'
  },
  cartaoCredito: {
    token: 'token-do-cartao-gerado-pelo-provedor',
    parcelas: 1
  }
})

​
Parâmetros específicos do cartão de crédito

O campo cartaoCredito é obrigatório para esse método de pagamento:
PropriedadeTipoObrigatórioDescrição
tokenstringSimToken do cartão gerado pelo provedor
parcelasnumberNãoQuantidade de parcelas (padrão: 1)
O token do cartão deve ser gerado de forma segura, preferencialmente no frontend utilizando a SDK do provedor ou os componentes da pagamentos.dev. Nunca envie os dados do cartão (número, CVV, etc.) diretamente para o seu backend.

​
Parcelamento

Você pode oferecer parcelamento ajustando a propriedade parcelas: 
const cobranca = await pg.cobrancas.create({
  valor: 12000, // R$120,00
  metodoPagamento: 'cartaoCredito',
  cliente: {
    nome: 'Carlos Pereira',
    documento: '456.789.123-00'
  },
  cartaoCredito: {
    token: 'token-do-cartao',
    parcelas: 3 // 3x de R$40,00
  }
})
A disponibilidade de parcelamento e as regras de juros dependem do provedor conectado. Consulte a documentação do provedor para mais detalhes.

​
Consultando o status

Após criar a cobrança, você pode consultar o status para verificar se o pagamento foi aprovado: 
const cobranca = await pg.cobrancas.get('id-da-cobranca')

console.log(cobranca.status) // 'pendente', 'pago', 'cancelado', 'falha', etc.

​
Recebendo notificações

Utilize webhooks para receber notificações sobre mudanças de status, como aprovação, cancelamento ou estorno do pagamento.

​
Provedores suportados

Os seguintes provedores oferecem suporte ao cartão de crédito:
Os provedores AbacatePay e Woovi não oferecem suporte ao cartão de crédito. Caso precise utilizar esse método, escolha outro provedor ou combine múltiplos provedores usando o roteamento inteligente.