Jump to Content
Referência
v2
Log In
Referência
Log In
Moon (Dark Mode)
Sun (Light Mode)
Everest
Referência
Fluxo de Status (Boleto)
Search
JUMP TO
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 cliente
post
Editar cliente
put
Verifica se o cliente existe pelo documento
get
Obter cliente por documento
get
Cartão de crédito
Criar cartão de crédito por documento
post
Alterar cartão de crédito padrão
put
Obter cartão padrão
get
Listar cartões por cliente
get
Endereço
Criar endereço do cliente
post
Alterar endereço padrão
put
Obter endereço padrão
get
Obter lista de endereços
get
Produtos
Criar produto
post
Editar produto
put
Obter produto por ID
get
Pagamentos
Pedido
Criar pedido via cartão de crédito (autorização)
post
Criar pedido via PIX
post
Criar pedido via boleto
post
Listar metadados por pedido
get
Fluxo de Status
Faturas
Cria uma nova fatura
post
Envia uma fatura por e-mail
post
Obter fatura por ID
get
Obter última cobrança de uma fatura.
get
Listar faturas
get
Fluxo de Status
Carnê
Criar um carnê de pagamento
Gerar boletos
Cobranças
Criar cobrança direta via Cartão de Crédito
post
Capturar uma cobrança via Cartão de Crédito
post
Estornar cobrança via Cartão de Crédito
post
Estornar cobrança via Pix
post
Cancelar Boleto
post
Cancelar um QRCode Pix
post
Obter cobrança por ID
get
Listar cobranças
get
Listar splits
get
Fluxo de Status
Transações
Obter transação por ID
get
Listar transações por Reference ID
get
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 token
post
Consultar Token do Cartão
get
Voucher
Obter cartão tokenizado do voucher
get
Criar cobrança direta via voucher
post
Tokenizar cartão voucher
post
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 assinatura
post
Cancelar assinatura
delete
Obter assinatura por ID
get
Risk Manager
Responder às contestações
FINANCEIRO
Planos e Taxas
Simulador de taxas
post
Recebíveis
Listar Recebíveis por ID de Referência do Pedido
get
Listar Recebíveis por ID da Cobrança
get
Listar Recebíveis por ID de Referência
get
Transferências
Listar Transferências
get
Listar transações pela transferência
get
Split de pagamento
Vendedores
Criar vendedor pessoa jurídica (CNPJ)
post
Criar vendedor pessoa física (CPF)
post
Obter vendedor por ID
get
Recebedores
Criar recebedor pessoa jurídica (CNPJ)
post
Criar recebedor pessoa física (CPF)
post
Obter recebedor por ID
get
Tabelas
Listar códigos dos bancos
get
Listar MCCs
get
Webhooks
Visão geral sobre Webhooks
Eventos
Enviar evento por ID
post
Enviar evento por ID do pedido
post
Redisparo de eventos
post
Obter evento por ID
get
Listar os eventos por parâmetros
get
Listar os eventos por ID do pedido
get
Testes
Cartões para testes
Simular pagamento
Simular um pagamento
post
Simular um pagamento via PIX
post
Powered by
Fluxo de Status (Boleto)
Boleto registrado
Boleto liquidado (Pago)
Boleto cancelado (Baixado)
Table of Contents
Boleto registrado
Boleto liquidado (Pago)
Boleto cancelado (Baixado)
