Automações

API REST Iugu flexível — faturas, cobranças, clientes e assinaturas.

Nó Iugu

O nó de workflow Iugu é um cliente REST flexível para a API Iugu — cobrança, faturas, assinaturas e métodos de pagamento para o mercado brasileiro. Configure URL, método HTTP, headers e body para chamar qualquer endpoint Iugu.

ID do nó no editor: iugu_payment
URL padrão: GET https://api.iugu.com/v1/charges

O que faz

  • Envia requisições HTTP autenticadas para a API v1 da Iugu
  • Suporta GET, POST, PUT e DELETE
  • Retorna status HTTP, data da resposta e headers da resposta
  • Auth padrão: Authorization: Basic {{iugu_api_key}}

Ideal para criar cobranças, faturas, gerenciar clientes e consultar status de pagamento sem montar requisições HTTP brutas do zero.

Pré-requisitos

  1. Uma conta Iugu
  2. API token em Iugu → Configurações → API
  3. Chave de integração iugu_api_key em Configurações → Chaves de API

A autenticação Basic da Iugu usa o token da API como username com senha vazia: codifique em Base64 API_TOKEN: (token + dois-pontos).

Como configurar

Etapa 1 — Definir credenciais

  1. Copie seu token de API Iugu (live ou test)
  2. Codifique em Base64 YOUR_TOKEN:
  3. Em Configurações → Chaves de API, adicione:
    • Nome: iugu_api_key
    • Valor: token codificado em Base64

Etapa 2 — Adicionar o nó

Arraste Iugu de Payments para o canvas.

Etapa 3 — Configurar a requisição

CampoObrigatórioDescrição
URL / EndpointSimURL completa da API Iugu
MethodNãoGET, POST, PUT, DELETE (padrão: GET)
Headers (JSON)NãoHeaders adicionais ou de sobrescrita
Body (JSON)NãoCorpo da requisição para POST/PUT

Endpoints comuns

OperaçãoMétodoURL
Listar cobrançasGEThttps://api.iugu.com/v1/charges
Criar cobrançaPOSThttps://api.iugu.com/v1/charge
Criar faturaPOSThttps://api.iugu.com/v1/invoices
Obter faturaGEThttps://api.iugu.com/v1/invoices/{id}
Criar clientePOSThttps://api.iugu.com/v1/customers
Criar assinaturaPOSThttps://api.iugu.com/v1/subscriptions

Exemplo — criar fatura (POST):

  • URL: https://api.iugu.com/v1/invoices
  • Method: POST
  • Body:
{
  "email": "{{contact.email}}",
  "due_date": "{{variables.due_date}}",
  "items": [
    {
      "description": "Monthly service",
      "quantity": 1,
      "price_cents": {{variables.price_cents}}
    }
  ],
  "payer": {
    "cpf_cnpj": "{{variables.customer_cpf}}",
    "name": "{{contact.name}}"
  }
}

Exemplo — criar cobrança direta (POST):

  • URL: https://api.iugu.com/v1/charge
  • Method: POST
  • Body:
{
  "token": "{{variables.iugu_payment_token}}",
  "invoice_id": "{{variables.invoice_id}}"
}

Cobranças diretas costumam exigir um token de pagamento gerado no cliente via Iugu.js — nunca envie dados brutos de cartão pelos workflows.

Respostas de fatura Iugu incluem secure_url ou campos similares em data:

Pay your invoice: {{iugu_1.data.secure_url}}

Inspecione a saída da execução para os nomes exatos dos campos na sua versão da API.

Saídas do nó

Campo de saídaDescrição
statusCódigo de status HTTP
dataCorpo JSON da resposta parseado
headersHeaders da resposta

Dicas e boas práticas

  • Use token de API de teste durante o desenvolvimento — a Iugu fornece tokens live/test separados
  • Fatura vs cobrança: faturas geram páginas de pagamento; cobranças processam pagamentos tokenizados
  • Configure webhooks Iugu (Gatilhos) para invoice.status_changed, payment_failed, etc.
  • Valores em faturas usam price_cents — centavos inteiros
  • Armazene IDs de clientes Iugu nos contatos do WhatsWave para cobrança recorrente
  • Encadeie nós: criar cliente → criar fatura → enviar WhatsApp com secure_url
  • Use GET com ID da fatura para consultar status se webhooks não estiverem configurados

Exemplos de casos de uso

Enviar fatura após aprovação do orçamento

  1. Webhook do CRM — orçamento aprovado com itens de linha
  2. Variable — formatar array de items para Iugu
  3. Iugu POST /invoices
  4. Enviar WhatsApp{{iugu_1.data.secure_url}}

Lembrete de cobrança de assinatura

  1. Schedule semanal
  2. Iugu GET /invoices?status=pending
  3. Loop + Send message lembrete por fatura vencida

Confirmação de pagamento

  1. Webhook — gatilho Iugu invoice.paid
  2. Iugu GET detalhes da fatura
  3. Atualização CRM + mensagem de agradecimento no WhatsApp

FAQ

Qual a diferença entre /charge e /charges?
/charge (singular) cria/processa uma cobrança; /charges (plural) lista cobranças. Use o endpoint adequado à sua operação.

Por que 401 Unauthorized?
Token não codificado em Base64 com dois-pontos no final, ou uso de token live em modo teste.

Posso aceitar PIX via Iugu?
Sim — configure métodos pagáveis nas faturas; a Iugu gera opções PIX/boleto/cartão na página da fatura.

O método padrão é GET — como criar recursos?
Defina Method como POST e preencha Body (JSON).

Este nó é suficiente para assinaturas?
Sim — POST em /subscriptions com identificador do plano e ID do cliente conforme a documentação Iugu.

Referência da API

ItemValor
Base URLhttps://api.iugu.com/v1/
AuthBasic (API token)
Docs oficiaisIugu API reference
WebhooksIugu triggers

Relacionados

Este artigo foi útil?

Precisa de mais ajuda? Falar com suporte

Central de Ajuda