Jump to Content
Central do DesenvolvedorIntroduçãoReferência de APICentral de AjudaObter SuporteStatus page
ConceitosRecipesReferênciaAtualizações
v1.0

IntroduçãoReferência de APICentral de AjudaObter SuporteStatus pageLog InCentral do Desenvolvedor
Referência
Log In
v1.0ConceitosRecipesReferênciaAtualizações

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 Tokenpost
  • Renovar API Token de Usuáriopost
  • Remover API Tokendelete
  • Listar API Tokensget
  • Listar API Tokens das subcontasget

Faturas

  • Faturas
    • Status de Fatura
    • Criar Faturapost
    • Reembolsar Faturapost
    • Cancelar Faturaput
    • Capturar Faturapost
    • Gerar 2ª Via de Faturapost
    • Reemitir Fatura Expiradapost
    • Listar/Buscar Faturasget
    • Consultar Faturaget
    • Considerar Fatura Paga Externamenteput
    • Buscar Fatura por IDs externosget
    • Buscar Fatura por ID Externos de Subcontasget
    • Enviar Fatura por Emailpost
  • Carnês
    • Criar um carnêpost
    • Consultar um carnêget
    • Cancelar carnêput
    • Listar carnêsget
    • Carnês Customizados
      • Criar um carnê customizadopost
      • Consultar um carnê customizadoget
      • Listar carnês customizadosget
  • Chargeback
    • Status de Retorno de Contestação
    • Disputar Contestaçãoput
    • Acatar Contestaçãoput
    • Buscar Contestaçãoget
    • Listar Contestaçãoget

Tokens e Cobrança Direta

  • Tokenização e iugu.js
  • Criar Tokenpost
  • Cobrança Diretapost
  • Cobrança Direta com 2 Cartõespost
  • Cartões de Teste

ZERO AUTH

  • Consultar Zero Authpost

iugurecorrência

  • Planos
    • Criar Planopost
    • Editar Planoput
    • Remover Planodelete
    • Buscar Planoget
    • Buscar Plano pelo Identificadorget
    • Listar Planosget
  • Clientes
    • Criar Clientepost
    • Editar Clienteput
    • Buscar Clienteget
    • Listar Clientesget
    • Remover Clientedelete
    • Forma de Pagamento
      • Criar Forma de Pagamentopost
      • Editar Forma de Pagamentoput
      • Buscar Forma de Pagamentoget
      • Listar Formas de Pagamentoget
      • Remover Forma de Pagamentodelete
  • Assinaturas
    • Criar Assinaturapost
    • Buscar Assinaturaget
    • Listar Assinaturasget
    • Editar Assinaturaput
    • Simular Alteração de Plano de Assinaturaget
    • Ativar Assinaturapost
    • Alterar Plano da Assinaturapost
    • Suspender Assinaturapost
    • Remover Assinaturadelete
    • Créditos
      • Adicionar Créditos a Assinaturaput
      • Remover Créditos da Assinaturaput

IUGUBAAS

  • Conta Bancária iugu
    • Criar Contapost
    • Enviar Verificação de Conta iugupost
      • 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 iuguget
      • Reenviar Documentos para Verificar Conta iuguput
    • Informações da Contaget
    • Desativar Conta iugupost
  • Extrato
    • Extrato Financeiroget
    • Listar Saques para Domicílio Bancárioget
    • Listar Transferências entre Contas iuguget
  • Pagamento de Contas
    • Validar Linha Digitável de um Boletopost
    • Pagar Boletopost
    • Listar Pagamentos de Boletosget
  • Depósito
    • Depósito via QR Code Estáticopost
  • Transferências PIX e TED
    • Saque para Domicílio Bancáriopost
    • PIX/TED Outpost
    • Cancelar PIX Agendadopatch
    • Consultar Comprovante de Transferência para Terceirosget
    • Listar Comprovantes de Transferências para Terceirosget
  • Recursos PIX
    • Ativar/desativar Pixput
    • Extrair Informações do QR Code Pixpost
    • Consultas de Chaves PIX
      • Consultar chave PIX na Conta iuguget
      • Listar chaves PIX na Conta iuguget
  • Consulta de Bancos
    • Consulta de Bancos Cadastrados na Iuguget
    • Consulta de ISPB e COMPEget

SAQUE PARA DOMICÍLIO PRÓPRIO

  • Pedido de Saque/Transferências Própriaspost
  • Buscar Saques/Transferência Própriaget
  • Listar Saques/Transferência Própriasget

TRANSFERÊNCIA ENTRE CONTAS IUGU

  • Transferir Valor entre contas iugupost
  • Buscar Transferênciaget
  • Listar Transferênciasget

Conta de Pagamento e Marketplace

  • Subconta
    • Criar Subcontapost
      • Criar Subconta — Propriedades do response
    • Enviar Verificação de Subcontapost
      • Consultar Envio de Documentos para Verificação de Conta iuguget
      • Reenviar Documentos para Verificar Conta iuguput
      • Lista de Bancos, Agência e Conta para Verificação de Conta e Domicílio Bancário
    • Configurar Contapost
    • Editar Subcontaput
    • Desativar Subcontapost
    • Adicionar/cadastrar Domicílio Bancáriopost
      • Verificar envio de domicilio bancárioget
  • Ativar/desativar método Pixput
  • Informações da Contaget
    • Informações da Conta — Propriedades do response
  • Listar contasget
  • Regras de Split
    • Criar Splitspost
    • Buscar Splitget
    • Listar Splitsget
    • Consultar Split Atualget
    • Listar Splits da Faturaget
    • Remover Split Atualdelete
  • Sócios de Conta
    • Criar sócio de contapost
    • Buscar sócio de contaget
    • Listar sócios de contaget
    • Atualizar sócio de contaput
    • Deletar sócio de contadelete
  • Contatos de Conta
    • Criar contato de contapost
    • Atualizar contato de contaput
    • Buscar contato de contaget
    • Listar contatos de contaget
    • Deletar contato de contadelete

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íveisget
  • Criar Gatilhopost
  • Alterar Gatilhoput
  • Remover Gatilhodelete
  • Buscar Gatilhoget
  • Listar Gatilhosget
  • Ativar/Desativar Gatilhoput
  • Reenviar Gatilho (por período)get
  • Logs
    • Listar Logsget
    • Disparar Log Novamenteget

RÉGUA DE COBRANÇA

  • Consultar Gestãoget
  • Alterar Gestãoput

Emails transacionais

  • Listar Identificadores de E-mail Disponíveisget
  • Buscar Layout Padrão de E-mailget
  • Criar E-mailpost
  • Editar E-mailput
  • Deletar E-maildelete
  • Visualizar Template de E-mailget
  • Enviar E-mail de Testepost
  • Buscar E-mailget
  • Listar E-mailsget

Antecipação de Recebíveis

  • Antecipar Recebíveis
  • Listar Recebíveisget
  • Criar Simulação de Antecipaçãopost
  • Verificar Status da Simulaçãoget
  • Aprovar Antecipaçãopost
  • Verificar Status da Antecipaçãoget

Relatórios para Conciliação

  • Listar Transações de Cartão de Créditoget
  • Listar Transações de Cartão de Crédito de Subcontasget
  • Extrato Financeiroget
  • Extrato de Faturasget
  • Conciliação de Saquesget
  • Extrato Consolidadoget
  • Recebíveis Consolidadosget
  • Extrato Consolidado de Liquidadosget

Boleto Bancário — Configurar Nome Cedente

  • Inserir Dados do Cedentepost
  • Alterar Dados do Cedenteput
  • Deletar Dados do Cedentedelete

Pagamentos de Boletos

  • Listar Pagamentosget
  • Buscar Pagamentoget
  • Criar Pedido de Pagamentopost
  • Validar Pagamentopost

Depósitos

  • Listar Depósitosget
  • Buscar depósitoget
  • Reembolsar Depósito Pixput

Transferência para Terceiros

  • Transferência para Terceirospost
  • Cancelar PIX Agendadopatch
  • Consultar Transferência para Terceirosget
  • Consultar Comprovante de Transferência para Terceirosget
  • Listar Comprovantes de Transferências para Terceirosget

Assinatura de requisições

  • Validate Signaturepost

QRCode Estático

  • Criação QRCode estáticopost
  • Consulta QRCode estáticoget
  • Listagem QRCode estáticoget

Reembolso de Faturas

934

Para mais informações sobre Reembolso de faturas