Jump to Content
Bempaggo - Documentação
Referência
Log InBempaggo - Documentação
Referência
Log In
Referência

Introdução

  • 🧭 Introdução
  • 🌐 Ambientes
  • 🔐 Autenticação
  • 🧩 Códigos da API
    • Status e Tipos
    • Fluxo de Status (Boleto)
    • Fluxo de Status (Cartão de crédito)
  • 📝 Metadata
  • 📦 Collection no Postman

INICIO RÁPIDO

  • 📘 Criando uma autorização de pagamento com cartão de crédito
  • 📘 Criando um pagamento com cartão de crédito
  • 📘 Criando uma fatura avulsa
  • 📘 Criando uma fatura recorrente

cadastros

  • Clientes
    • Criar clientepost
    • Editar clienteput
    • Verifica se o cliente existe pelo documentoget
    • Obter cliente por documentoget
  • Cartão de crédito
    • Criar cartão de crédito por documentopost
    • Alterar cartão de crédito padrãoput
    • Obter cartão padrãoget
    • Listar cartões por clienteget
  • Endereço
    • Criar endereço do clientepost
    • Alterar endereço padrãoput
    • Obter endereço padrãoget
    • Obter lista de endereçosget
  • Produtos
    • Criar produtopost
    • Editar produtoput
    • Obter produto por IDget

Pagamentos

  • Pedido
    • Criar pedido via cartão de crédito (autorização)post
    • Criar pedido via PIXpost
    • Criar pedido via boletopost
    • Listar metadados por pedidoget
    • Fluxo de Status
  • Faturas
    • Cria uma nova faturapost
    • Envia uma fatura por e-mailpost
    • Obter fatura por IDget
    • Obter última cobrança de uma fatura.get
    • Listar faturasget
    • Fluxo de Status
  • Carnê
    • Criar um carnê de pagamento
    • Gerar boletos
  • Cobranças
    • Criar cobrança direta via Cartão de Créditopost
    • Capturar uma cobrança via Cartão de Créditopost
    • Estornar cobrança via Cartão de Créditopost
    • Estornar cobrança via Pixpost
    • Cancelar Boletopost
    • Cancelar um QRCode Pixpost
    • Obter cobrança por IDget
    • Listar cobrançasget
    • Listar splitsget
    • Fluxo de Status
  • Transações
    • Obter transação por IDget
    • Listar transações por Reference IDget
  • Transações 3DS 2.0
    • Passo 1 - Solicitando uma autorização com 3DS 2.0
    • Passo 2 - Desafio
    • Passo 3 - Recebendo confirmação de pagamento
  • Tokenização
    • Criar tokenpost
    • Consultar Token do Cartãoget
  • Voucher
    • Obter cartão tokenizado do voucherget
    • Criar cobrança direta via voucherpost
    • Tokenizar cartão voucherpost
  • Data Only
  • Códigos de Retorno – Cartão de Crédito e Débito

SPLIT DE PAGAMENTO

  • Transação com Split

Recorrência

  • Assinaturas
    • Criar assinaturapost
    • Cancelar assinaturadelete
    • Obter assinatura por IDget

Risk Manager

  • Responder às contestações

FINANCEIRO

  • Planos e Taxas
    • Simulador de taxaspost
  • Recebíveis
    • Listar Recebíveis por ID de Referência do Pedidoget
    • Listar Recebíveis por ID da Cobrançaget
    • Listar Recebíveis por ID de Referênciaget
  • Transferências
    • Listar Transferênciasget
    • Listar transações pela transferênciaget

Split de pagamento

  • Vendedores
    • Criar vendedor pessoa jurídica (CNPJ)post
    • Criar vendedor pessoa física (CPF)post
    • Obter vendedor por IDget
  • Recebedores
    • Criar recebedor pessoa jurídica (CNPJ)post
    • Criar recebedor pessoa física (CPF)post
    • Obter recebedor por IDget
  • Tabelas
    • Listar códigos dos bancosget
    • Listar MCCsget

Webhooks

  • Visão geral sobre Webhooks
  • Eventos
    • Enviar evento por IDpost
    • Enviar evento por ID do pedidopost
    • Redisparo de eventospost
    • Obter evento por IDget
    • Listar os eventos por parâmetrosget
    • Listar os eventos por ID do pedidoget

Testes

  • Cartões para testes
  • Simular pagamento
    • Simular um pagamentopost
    • Simular um pagamento via PIXpost
Powered by 

🌐 Ambientes

Para executar uma operação, combine a URL base do ambiente com a URL da operação desejada e envie utilizando o verbo HTTP conforme descrito na operação.

Ex.: https://apisandbox.bempaggo.io/api/v2/charges/.

Envie a requisição para a URL utilizando o método HTTP adequado à operação.

AmbienteURL
Sandboxhttps://apisandbox.bempaggo.io/api/v2
Produçãohttps://api.bempaggo.io/api/v2