Jump to Content
Introdução
Referência de API
Central de Ajuda
Obter Suporte
Status page
Conceitos
Recipes
Referência
Atualizações
v1.0
Introdução
Referência de API
Central de Ajuda
Obter Suporte
Status page
Log In
Referência
Log In
v1.0
Conceitos
Recipes
Referência
Atualizações
PIX/TED Out
Search
JUMP TO
SELECT YOUR LANGUAGE
🇧🇷 Português
🇺🇸 English
Visão Geral
🧭 Introdução à API
🔒 Autenticação
👨🚀 Collections
🔢 Paginação
↔️ Diagramas de Sequência
iuguCobrança
PIX
Boleto Bancário
Cartão de Crédito (PCI)
Cartão de Crédito (não PCI)
Reembolso [PIX]
Reembolso [Boleto Bancário — Sugestão]
Reembolso [Cartão de Crédito]
Criar Método de Pagamento (PCI)
Criar Método de Pagamento (não PCI)
Alterar Cartão Padrão de Assinatura
Gerenciar todos os Métodos de Pagamento (usuário)
Compartilhar Método de Pagamento
iuguRecorrência
Pix (Checkout Transparente)
Boleto Bancário (Checkout Transparente)
Cartão de Crédito (Checkout Transparente)
Checkout iugu (todos os métodos)
iuguBaaS
Criar e Verificar Subconta
Reenviar Documentos de KYC
Ativar e Configurar Métodos de Pagamento
Depósito — PIX
Pagar um Boleto
PIX/TED Out
iuguSplit
Split por Fatura
Split por Assinatura
↪️ Fluxos de Implementação
🗝️ Chave de Idempotência
💳 Cartões de Teste
🪲 Tabela de Erros
0️⃣ Tabela de LRs
Overview
Introduction to the API
Tokens de API
Criar API Token
post
Renovar API Token de Usuário
post
Remover API Token
delete
Listar API Tokens
get
Listar API Tokens das subcontas
get
Faturas
Faturas
Status de Fatura
Criar Fatura
post
Reembolsar Fatura
post
Cancelar Fatura
put
Capturar Fatura
post
Gerar 2ª Via de Fatura
post
Reemitir Fatura Expirada
post
Listar/Buscar Faturas
get
Consultar Fatura
get
Considerar Fatura Paga Externamente
put
Buscar Fatura por IDs externos
get
Buscar Fatura por ID Externos de Subcontas
get
Enviar Fatura por Email
post
Carnês
Criar um carnê
post
Consultar um carnê
get
Cancelar carnê
put
Listar carnês
get
Carnês Customizados
Criar um carnê customizado
post
Consultar um carnê customizado
get
Listar carnês customizados
get
Chargeback
Status de Retorno de Contestação
Disputar Contestação
put
Acatar Contestação
put
Buscar Contestação
get
Listar Contestação
get
Tokens e Cobrança Direta
Tokenização e iugu.js
Criar Token
post
Cobrança Direta
post
Cobrança Direta com 2 Cartões
post
Cartões de Teste
ZERO AUTH
Consultar Zero Auth
post
iugurecorrência
Planos
Criar Plano
post
Editar Plano
put
Remover Plano
delete
Buscar Plano
get
Buscar Plano pelo Identificador
get
Listar Planos
get
Clientes
Criar Cliente
post
Editar Cliente
put
Buscar Cliente
get
Listar Clientes
get
Remover Cliente
delete
Forma de Pagamento
Criar Forma de Pagamento
post
Editar Forma de Pagamento
put
Buscar Forma de Pagamento
get
Listar Formas de Pagamento
get
Remover Forma de Pagamento
delete
Assinaturas
Criar Assinatura
post
Buscar Assinatura
get
Listar Assinaturas
get
Editar Assinatura
put
Simular Alteração de Plano de Assinatura
get
Ativar Assinatura
post
Alterar Plano da Assinatura
post
Suspender Assinatura
post
Remover Assinatura
delete
Créditos
Adicionar Créditos a Assinatura
put
Remover Créditos da Assinatura
put
IUGUBAAS
Conta Bancária iugu
Criar Conta
post
Enviar Verificação de Conta iugu
post
Lista de Bancos, Agência e Conta para Verificação de Conta e Domicílio Bancário
Consultar Envio de Documentos para Verificação de Conta iugu
get
Reenviar Documentos para Verificar Conta iugu
put
Informações da Conta
get
Desativar Conta iugu
post
Extrato
Extrato Financeiro
get
Listar Saques para Domicílio Bancário
get
Listar Transferências entre Contas iugu
get
Pagamento de Contas
Validar Linha Digitável de um Boleto
post
Pagar Boleto
post
Listar Pagamentos de Boletos
get
Depósito
Depósito via QR Code Estático
post
Transferências PIX e TED
Saque para Domicílio Bancário
post
PIX/TED Out
post
Cancelar PIX Agendado
patch
Consultar Comprovante de Transferência para Terceiros
get
Listar Comprovantes de Transferências para Terceiros
get
Recursos PIX
Ativar/desativar Pix
put
Extrair Informações do QR Code Pix
post
Consultas de Chaves PIX
Consultar chave PIX na Conta iugu
get
Listar chaves PIX na Conta iugu
get
Consulta de Bancos
Consulta de Bancos Cadastrados na Iugu
get
Consulta de ISPB e COMPE
get
SAQUE PARA DOMICÍLIO PRÓPRIO
Pedido de Saque/Transferências Próprias
post
Buscar Saques/Transferência Própria
get
Listar Saques/Transferência Próprias
get
TRANSFERÊNCIA ENTRE CONTAS IUGU
Transferir Valor entre contas iugu
post
Buscar Transferência
get
Listar Transferências
get
Conta de Pagamento e Marketplace
Subconta
Criar Subconta
post
Criar Subconta — Propriedades do response
Enviar Verificação de Subconta
post
Consultar Envio de Documentos para Verificação de Conta iugu
get
Reenviar Documentos para Verificar Conta iugu
put
Lista de Bancos, Agência e Conta para Verificação de Conta e Domicílio Bancário
Configurar Conta
post
Editar Subconta
put
Desativar Subconta
post
Adicionar/cadastrar Domicílio Bancário
post
Verificar envio de domicilio bancário
get
Ativar/desativar método Pix
put
Informações da Conta
get
Informações da Conta — Propriedades do response
Listar contas
get
Regras de Split
Criar Splits
post
Buscar Split
get
Listar Splits
get
Consultar Split Atual
get
Listar Splits da Fatura
get
Remover Split Atual
delete
Sócios de Conta
Criar sócio de conta
post
Buscar sócio de conta
get
Listar sócios de conta
get
Atualizar sócio de conta
put
Deletar sócio de conta
delete
Contatos de Conta
Criar contato de conta
post
Atualizar contato de conta
put
Buscar contato de conta
get
Listar contatos de conta
get
Deletar contato de conta
delete
Gatilhos
Lista de Gatilhos
Faturas
Assinaturas
Saque — Mesmo Domicílio Bancário
PIX/TED Out — Transferência para Terceiros
Transferência entre Contas iugu
Depósito
KYC — Verificação de Conta iugu
Método de Pagamento de Cliente
Antecipação de Recebíveis
Pedido de Pagamento — Pagamento de Boletos via Conta iugu
Listar Eventos Disponíveis
get
Criar Gatilho
post
Alterar Gatilho
put
Remover Gatilho
delete
Buscar Gatilho
get
Listar Gatilhos
get
Ativar/Desativar Gatilho
put
Reenviar Gatilho (por período)
get
Logs
Listar Logs
get
Disparar Log Novamente
get
RÉGUA DE COBRANÇA
Consultar Gestão
get
Alterar Gestão
put
Emails transacionais
Listar Identificadores de E-mail Disponíveis
get
Buscar Layout Padrão de E-mail
get
Criar E-mail
post
Editar E-mail
put
Deletar E-mail
delete
Visualizar Template de E-mail
get
Enviar E-mail de Teste
post
Buscar E-mail
get
Listar E-mails
get
Antecipação de Recebíveis
Antecipar Recebíveis
Listar Recebíveis
get
Criar Simulação de Antecipação
post
Verificar Status da Simulação
get
Aprovar Antecipação
post
Verificar Status da Antecipação
get
Relatórios para Conciliação
Listar Transações de Cartão de Crédito
get
Listar Transações de Cartão de Crédito de Subcontas
get
Extrato Financeiro
get
Extrato de Faturas
get
Conciliação de Saques
get
Extrato Consolidado
get
Recebíveis Consolidados
get
Extrato Consolidado de Liquidados
get
Boleto Bancário — Configurar Nome Cedente
Inserir Dados do Cedente
post
Alterar Dados do Cedente
put
Deletar Dados do Cedente
delete
Pagamentos de Boletos
Listar Pagamentos
get
Buscar Pagamento
get
Criar Pedido de Pagamento
post
Validar Pagamento
post
Depósitos
Listar Depósitos
get
Buscar depósito
get
Reembolsar Depósito Pix
put
Transferência para Terceiros
Transferência para Terceiros
post
Cancelar PIX Agendado
patch
Consultar Transferência para Terceiros
get
Consultar Comprovante de Transferência para Terceiros
get
Listar Comprovantes de Transferências para Terceiros
get
Assinatura de requisições
Validate Signature
post
QRCode Estático
Criação QRCode estático
post
Consulta QRCode estático
get
Listagem QRCode estático
get
PIX/TED Out
