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
statusHTTP,datada resposta eheadersda 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
- Uma conta Iugu
- API token em Iugu → Configurações → API
- Chave de integração
iugu_api_keyem 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
- Copie seu token de API Iugu (live ou test)
- Codifique em Base64
YOUR_TOKEN: - Em Configurações → Chaves de API, adicione:
- Nome:
iugu_api_key - Valor: token codificado em Base64
- Nome:
Etapa 2 — Adicionar o nó
Arraste Iugu de Payments para o canvas.
Etapa 3 — Configurar a requisição
| Campo | Obrigatório | Descrição |
|---|---|---|
| URL / Endpoint | Sim | URL completa da API Iugu |
| Method | Não | GET, POST, PUT, DELETE (padrão: GET) |
| Headers (JSON) | Não | Headers adicionais ou de sobrescrita |
| Body (JSON) | Não | Corpo da requisição para POST/PUT |
Endpoints comuns
| Operação | Método | URL |
|---|---|---|
| Listar cobranças | GET | https://api.iugu.com/v1/charges |
| Criar cobrança | POST | https://api.iugu.com/v1/charge |
| Criar fatura | POST | https://api.iugu.com/v1/invoices |
| Obter fatura | GET | https://api.iugu.com/v1/invoices/{id} |
| Criar cliente | POST | https://api.iugu.com/v1/customers |
| Criar assinatura | POST | https://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.
Etapa 4 — Enviar link da fatura
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ída | Descrição |
|---|---|
status | Código de status HTTP |
data | Corpo JSON da resposta parseado |
headers | Headers 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
- Webhook do CRM — orçamento aprovado com itens de linha
- Variable — formatar array de items para Iugu
- Iugu POST
/invoices - Enviar WhatsApp —
{{iugu_1.data.secure_url}}
Lembrete de cobrança de assinatura
- Schedule semanal
- Iugu GET
/invoices?status=pending - Loop + Send message lembrete por fatura vencida
Confirmação de pagamento
- Webhook — gatilho Iugu
invoice.paid - Iugu GET detalhes da fatura
- 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
| Item | Valor |
|---|---|
| Base URL | https://api.iugu.com/v1/ |
| Auth | Basic (API token) |
| Docs oficiais | Iugu API reference |
| Webhooks | Iugu triggers |
Relacionados
Este artigo foi útil?
Precisa de mais ajuda? Falar com suporte