Informações do Projeto

Schooling

Post Title

Etapa: Analise e junção de dados sobre o projeto

Configuração:

Nessa etapa colho todas as informações sobre o projeto!!

Ambiente de desenvolvimento iniciado com sucesso, as informações iniciais foram coletadas com sucesso!!


Observações:

Nessa etapa colho todas as informações sobre o projeto!!


Templates que poderão compor o projeto:
 

Selecionado opara apresentação do Schooling: https://ekramit.net/tf/playstone-demo/

Selecionado para ambiente cliente:http://velikorodnov.com/html/owlhouse/index.html


Referencias:

http://www.edu3.com.br/

Etapa: Desenvolvimento do Layout

Configuração:

Inicio da adequação do Layout, template comprado pelo cliente!!


Observações:

Inicio da adequação do Layout, template comprado pelo cliente!!

Etapa: Definição das informações a serem inseridas na plataforma de gerenciamento dos Clientes do Schooling (Escolas)

Configuração:

Conteúdo está marcado como Privado!


Observações:

Conteúdo está marcado como Privado!

Etapa: Integração com a Iugu para sistema de pagamentos Scooling / Inquilinos

Configuração:

Introdução à API

 

A iugu disponibiliza uma interface de programação web, no modelo REST. Por meio dessa interface, é possível conversar com o sistema da iugu, comandando ações, verificando configurações e realizando a sincronização com os seus sistemas.

O endereço base de comunicação é api.iugu.com, acompanhado sempre do protocolo seguro https:// como prefixo. As versões da API são agrupadas por diretório, sufixadas ao endereço base (https://api.iugu.com/v1).

Endereço para comunicação com a API

Este documento trata da versão da API 1.0.

O endereço para se comunicar através desta versão é:
https://api.iugu.com/v1/

Exemplos da utilização prática das chamadas de nossa API podem ser conferidas na seção de conceitos técnicos.

 

SUGERIR EDIÇÃO

Autenticação

 

A autenticação na iugu é feita através da utilização de uma chave de API. Esta chave serve para que o sistema identifique a sua conta, e concede permissões para que o sistema se comunique com a iugu em nome da conta em questão.

Há duas maneiras de se autenticar, sendo a primeira, e mais recomendada, utilizando HTTP Basic Auth. A outra maneira é enviar o API Token num parâmetro de nome api_token.

As chaves de API podem ser TEST (Teste) ou LIVE (Produção), sendo que cada chamada irá se comunicar com os respectivos ambientes e os dados também estarão disponíveis de forma isolada no painel, dependendo do modo que estiver ativado.

Toggle de Produção/Teste no painel

Este toggle não altera a comunicação da API e sim a visão e ações executadas exclusivamente através do painel.

 

Criando suas chaves de API (API Tokens)

Trate suas chaves de API como senhas

Não inclua sua chave de API publicamente em nenhum lugar do seu site ou javascript. Lembre-se que esta chave dá acesso total ao seus dados na iugu.

Para adicionar uma chave de API, acesse o endereço https://app.iugu.com e siga o tutorial abaixo

 

HTTP Basic Auth

Para gerar o header de autenticação HTTP básico deve-se seguir os seguintes passos:

  1. Utilizar em nome de usuário seu API token e utilizar senha em branco separados por um dois pontos (:), exemplo: 2fd7f47f8b96c44e300a60ce35cfe414:
  2. Codificar a string resultante utilizando Base64
  3. Concatenar a string resultando com o sufixo Authorization: Basic
  4. Resultar com uma string final parecida com Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l
  5. Enviar essa informação no Header da request

HTTP Basic Auth

Você pode aprender mais sobre HTTP Basic Auth em https://en.wikipedia.org/wiki/Basic_access_authentication

 

Parâmetro api_token

As requests permitem o envio de um parâmetro chamado api_token onde pode ser enviado o API Token gerado anteriormente em vez de utilizar o HTTP Basic Auth.

Boas práticas

Como boa prática é interessante não misturar o que são de fato parâmetros da request da autenticação da mesma. Portanto, recomendamos a utilização de HTTP Basic Auth.

 

SUGERIR EDIÇÃO

Resposta em JSON ou XML

 

Afim de facilitar a interoperabilidade entre sistemas, todas as nossas chamadas de API podem responder no formato JSON ou XML, conforme a sua escolha, sendo que o padrão é retornar em JSON. Isto é, quando não é especificado um formato.

Como especificar o formato de resposta

Você tem duas formas de especificar o formato de resposta:

  1. Adicionar a extensão ".xml" ou ".json" no final dos endereços de API
  2. Enviar um Header HTTP contento o tipo de conteúdo que você espera. Sendo "Accept: application/json" para JSON e "Accept: application/xml" para XML.

 

SUGERIR EDIÇÃO

Erros

A Iugu API utiliza os próprios Códigos de Status HTTP para indicar sucesso ou falha da chamada. Em geral os códigos iniciados com 2 indicam sucesso, os iniciados com 4 indicam erro (Ex: Falta de parâmetro obrigatório) e iniciados com 5 indicam erro interno nos servidores da Iugu.
Pode conter tanto uma string de erro como um hash contendo o atributo e seus erros.

 

Formato para erros nos status 400, 401 e 404

Copy

{
    "errors": "Unauthorized"
}

Formato para erros status 422

Copy

{
    "errors": {
        "due_date": [
            "should not be in the past"
        ]
    }
}

Erros mais comuns

Português

Inglês

não pode ficar em branco

can't be blank

não pode ficar vazio

can't be empty

deve ser maior que N

must be greater than N

deve ser maior ou igual a N

must be greater than or equal to N

não está incluído na lista

is not included in the list

não é válido

is invalid

deve ser menor que N

must be less than N

deve ser menor ou igual a N

must be less than or equal to N

não é um número

is not a number

não pode estar no passado

should not be in the past

 

SUGERIR EDIÇÃO

Paginação

Em nossas APIs de listagem, usamos dois parâmetros que possibilitam a paginação em sua aplicação.

 

São eles:

start: Determina quantos registros no início da sua listagem serão ignorados.
limit: Determina o máximo de registros que serão retornados.

Obs.: Esse parâmetros funcionam mesmo que não sejam chamados simultaneamente.

Veja abaixo dois exemplos distintos da chamada de API para listagem de faturas:

1) Sem parâmetros de paginação

Copy

curl --request GET \
  --url https://api.iugu.com/v1/invoices

Copy

{
    "facets": {
        "status": {
            "_type": "terms",
            "missing": 0,
            "total": 10,
            "other": 0,
            "terms": [
                {
                    "term": "paid",
                    "count": 5
                },
                {
                    "term": "pending",
                    "count": 5
                }
            ]
        }
    },
    "totalItems": 2,
    "items": [ 
      #Fatura1, #Fatura2, #Fatura3, #Fatura4, #Fatura5, #Fatura6, #Fatura7, #Fatura8, #Fatura9, #Fatura10
    ]
}

2) Com parâmetros de paginação

 

Página 1:

Copy

curl --request GET \
  --url 'https://api.iugu.com/v1/invoices?start=0&limit=5'

Copy

{
    "facets": {
        "status": {
            "_type": "terms",
            "missing": 0,
            "total": 10,
            "other": 0,
            "terms": [
                {
                    "term": "paid",
                    "count": 5
                },
                {
                    "term": "pending",
                    "count": 5
                }
            ]
        }
    },
    "totalItems": 2,
    "items": [ 
      #Fatura1, #Fatura2, #Fatura3, #Fatura4, #Fatura5
    ]
}

 

Página 2:

Copy

curl --request GET \
  --url 'https://api.iugu.com/v1/invoices?start=5&limit=5'

Copy

{
    "facets": {
        "status": {
            "_type": "terms",
            "missing": 0,
            "total": 10,
            "other": 0,
            "terms": [
                {
                    "term": "paid",
                    "count": 5
                },
                {
                    "term": "pending",
                    "count": 5
                }
            ]
        }
    },
    "totalItems": 2,
    "items": [ 
      #Fatura6, #Fatura7, #Fatura8, #Fatura9, #Fatura10
    ]
}

 

SUGERIR EDIÇÃO

Fluxos de Implementação

 

 

Cobrança Direta

 

Cobrança Recorrente

 

Marketplace

 

Fluxos de recebimento para marketplaces

 

SUGERIR EDIÇÃO

Criar fatura

Cria uma fatura para um cliente.

 

 Testar

posthttps://api.iugu.com/v1/invoices

curl --request POST \
  --url https://api.iugu.com/v1/invoices
{
    "id": "0958D2AAD34049AB889583E26DFA0BF1",
    "due_date": "2017-11-30",
    "currency": "BRL",
    "discount_cents": null,
    "email": "teste@teste.com",
    "items_total_cents": 1000,
    "notification_url": null,
    "return_url": null,
    "status": "pending",
    "tax_cents": null,
    "updated_at": "2014-06-17T09:58:05-03:00",
    "total_cents": 1000,
    "paid_at": null,
    "commission_cents": null,
    "secure_id": "0958d2aa-d340-49ab-8895-83e26dfa0bf1-2f4c",
    "secure_url": "http://iugu.com/invoices/0958d2aa-d340-49ab-8895-83e26dfa0bf1-2f4c",
    "customer_id": null,
    "user_id": null,
    "total": "R$ 10,00",
    "taxes_paid": "R$ 0,00",
    "commission": "R$ 0,00",
    "interest": null,
    "discount": null,
    "created_at": "17/06, 09:58 h",
    "refundable": null,
    "installments": null,
    "bank_slip": {
        "digitable_line": "00000000000000000000000000000000000000000000000",
        "barcode_data": "00000000000000000000000000000000000000000000",
        "barcode": "http://iugu.com/invoices/barcode/0958d2aa-d340-49ab-8895-83e26dfa0bf1-2f4c"
    },
    "items": [{
        "id": "11DA8B1662EC4C30BC4C78AEDC619145",
        "description": "Item Um",
        "price_cents": 1000,
        "quantity": 1,
        "created_at": "2014-06-17T09:58:05-03:00",
        "updated_at": "2014-06-17T09:58:05-03:00",
        "price": "R$ 10,00"
    }],
    "variables": [{
        "id": "A897DD8BB6B54AE18CA4C48684E72FB9",
        "variable": "payment_data.transaction_number",
        "value": "1111"
    }],
    "custom_variables": [],
    "logs": []
}

BODY PARAMS

email

string

OBRIGATÓRIO

E-mail do cliente

 

cc_emails

string

Endereços de E-mail para cópia separados por ponto e vírgula.

 

due_date

date

OBRIGATÓRIO

Data do vencimento. (Formato: 'AAAA-MM-DD').

 

ensure_workday_due_date

boolean

Se true, garante que a data de vencimento seja apenas em dias de semana, e não em sábados ou domingos.

truefalse

items

array of objects

OBRIGATÓRIO

Itens da fatura. "price_cents" valor mínimo 100.

description

quantity

price_cents

Add ObjectEdit Array JSONreturn_url

string

Cliente é redirecionado para essa URL após efetuar o pagamento da Fatura pela página de Fatura da Iugu

 

expired_url

string

Cliente é redirecionado para essa URL se a Fatura que estiver acessando estiver expirada

 

notification_url

string

URL chamada para todas as notificações de Fatura, assim como os webhooks (Gatilhos) são chamados

 

fines

boolean

Booleano para Habilitar ou Desabilitar multa por atraso de pagamento

truefalse

late_payment_fine

int32

Determine a multa % a ser cobrada para pagamentos efetuados após a data de vencimento

 

per_day_interest

boolean

Booleano que determina se cobra ou não juros por dia de atraso. 1% ao mês pro rata.

truefalse

discount_cents

int32

Valor dos Descontos em centavos

 

customer_id

string

ID do Cliente

 

ignore_due_email

boolean

Booleano que ignora o envio do e-mail de cobrança

truefalse

subscription_id

string

Amarra esta Fatura com a Assinatura especificada. Esta fatura não causa alterações na assinatura vinculada.

 

payable_with

mixed type

Método de pagamento que será disponibilizado para esta Fatura ("all", "credit_card" ou "bank_slip"). Obs: Caso esta Fatura esteja atrelada à uma Assinatura, a prioridade é herdar o valor atribuído na Assinatura; caso esta esteja atribuído o valor 'all', o sistema considerará o 'payable_with' da Fatura; se não, o sistema considerará o 'payable_with' da Assinatura.

 

credits

int32

Caso tenha o 'subscription_id', pode-se enviar o número de créditos a adicionar nessa Assinatura baseada em créditos, quando a Fatura for paga.

 

custom_variables

array of objects

Variáveis Personalizadas

name

value

Add ObjectEdit Array JSONearly_payment_discount

boolean

Ativa ou desativa os descontos por pagamento antecipado. Quando true, sobrepõe as configurações de desconto da conta.

truefalse

early_payment_discounts

array of objects

Quantidade de dias de antecedência para o pagamento receber o desconto (Se enviado, substituirá a configuração atual da conta)

days

percent

value_cents

Add ObjectEdit Array JSON*atenção*

object

Informações do cliente abaixo "payer" são obrigatórias para a emissão de boletos registrados ou necessárias para seu sistema de antifraude.

 

payer

object

 

payer.cpf_cnpj

string

CPF ou CNPJ do cliente

 

payer.name

string

Nome (utilizado como sacado no boleto)

 

payer.phone_prefix

string

Prefixo (DDD) do telefone em dois dígitos

 

payer.phone

string

Telefone do cliente

 

payer.email

string

Email do cliente

 

payer.address

object

Endereço do cliente, conforme os parâmetros seguintes:

 

payer.address.zip_code

string

CEP

 

payer.address.street

string

Rua

 

payer.address.number

string

Número

 

payer.address.district

string

Bairro

 

payer.address.city

string

Cidade

 

payer.address.state

string

Estado (Ex: SP)

 

payer.address.country

string

País

 

payer.address.complement

string

Complemento

 

order_id

string

Número único que identifica o pedido de compra. Opcional, ajuda a evitar o pagamento da mesma fatura.

 

logs

object

Logs da fatura.

 

logs.description

string

Descrição da Entrada de Log

 

logs.notes

string

Anotações da Entrada de Log

 

 

 

SUGERIR EDIÇÃO

Capturar fatura

Captura uma fatura com status "em análise" (in_analysis)

 

 Testar

posthttps://api.iugu.com/v1/invoices/id/capture

curl --request POST \
  --url https://api.iugu.com/v1/invoices/id/capture
{
    "id": "5A4CBC68F7A647ECADD59D4E1B4B0DDF",
    "due_date": "2015-04-07",
    "currency": "BRL",
    "discount_cents": null,
    "email": "email@email.com",
    "items_total_cents": 15000,
    "notification_url": null,
    "return_url": null,
    "status": "paid",
    "tax_cents": null,
    "updated_at": "2015-04-08T11:06:43-03:00",
    "total_cents": 15000,
    "paid_at": "2015-04-08T11:06:43-03:00",
    "taxes_paid_cents": 705,
    "paid_cents": 15000,
    "cc_emails": null,
    "financial_return_date": "2015-05-08",
    "payable_with": "all",
    "commission_cents": 0,
    "secure_id": "5a4cbc68-f7a6-47ec-add5-9d4e1b4b0ddf-1342",
    "secure_url": "http://iugu.com/invoices/5a4cbc68-f7a6-47ec-add5-9d4e1b4b0ddf-1342",
    "commission": "R$ 0,00",
    "customer_id": "8747577C7C044D38B837844C751D2DCA",
    "customer_ref": "Nome do Cliente",
    "customer_name": "Nome do Cliente",
    "financial_return_dates": [
        {
            "installment": 1,
            "return_date": "2015-05-08",
            "status": "pending"
        }
    ],
    "user_id": "B733FEEDF4774F3A8EA33BF3682D532F",
    "total": "R$ 150,00",
    "taxes_paid": "R$ 7,05",
    "fines_on_occurrence_day": "R$ 0,00",
    "total_on_occurrence_day": "R$ 150,00",
    "fines_on_occurrence_day_cents": 0,
    "total_on_occurrence_day_cents": 15000,
    "advance_fee": null,
    "paid": "R$ 150,00",
    "interest": null,
    "discount": null,
    "created_at": "07/04, 15:09 h",
    "refundable": true,
    "installments": "1",
    "transaction_number": 50019,
    "created_at_iso": "2015-04-07T15:09:56-03:00",
    "updated_at_iso": "2015-04-08T11:06:43-03:00",
    "bank_slip": null,
    "items": [
        {
            "id": "E0174FC31EB94E84A106F7A6F9AE2B6E",
            "description": "Item 1",
            "price_cents": 15000,
            "quantity": 1,
            "created_at": "2015-04-07T15:09:56-03:00",
            "updated_at": "2015-04-07T15:09:56-03:00",
            "price": "R$ 150,00"
        }
    ],
    "variables": [
        {
            "id": "A8C555AF7A6C43EFAF16C8AF26E20FDE",
            "variable": "payment_data.transaction_number",
            "value": "50019"
        }
    ],
    "custom_variables": [],
    "logs": []
}

PATH PARAMS

id

string

OBRIGATÓRIO

ID da Fatura

 

 

 

SUGERIR EDIÇÃO

Reembolsar fatura

Efetua o reembolso de uma Fatura. Somente alguns meios de pagamento permitem o reembolso, como por exemplo o Cartão de Crédito. Após o reembolso, a Fatura fica com o status de "reembolsada" / "refunded".

 

 Testar

posthttps://api.iugu.com/v1/invoices/id/refund

curl --request POST \
  --url https://api.iugu.com/v1/invoices/id/refund
{
    "id": "0958D2AAD34049AB889583E26DFA0BF1",
    "due_date": "2013-11-30",
    "currency": "BRL",
    "discount_cents": null,
    "email": "teste@teste.com",
    "items_total_cents": 1000,
    "notification_url": null,
    "return_url": null,
    "status": "refunded",
    "tax_cents": null,
    "updated_at": "2014-06-17T09:58:05-03:00",
    "total_cents": 1000,
    "paid_at": null,
    "commission_cents": 0,
    "secure_id": "0958d2aa-d340-49ab-8895-83e26dfa0bf1-2f4c",
    "secure_url": "http://iugu.com/invoices/0958d2aa-d340-49ab-8895-83e26dfa0bf1-2f4c",
    "customer_id": null,
    "user_id": null,
    "total": "R$ 10,00",
    "taxes_paid": "R$ 0,00",
    "commission": "R$ 0,00",
    "interest": null,
    "discount": null,
    "created_at": "17/06, 09:58 h",
    "refundable": null,
    "installments": null,
    "bank_slip": {
        "digitable_line": "00000000000000000000000000000000000000000000000",
        "barcode_data": "00000000000000000000000000000000000000000000",
        "barcode": "http://iugu.com/invoices/barcode/0958d2aa-d340-49ab-8895-83e26dfa0bf1-2f4c"
    },
    "items": [{
        "id": "11DA8B1662EC4C30BC4C78AEDC619145",
        "description": "Item Um",
        "price_cents": 1000,
        "quantity": 1,
        "created_at": "2014-06-17T09:58:05-03:00",
        "updated_at": "2014-06-17T09:58:05-03:00",
        "price": "R$ 10,00"
    }],
    "variables": [{
        "id": "A897DD8BB6B54AE18CA4C48684E72FB9",
        "variable": "payment_data.transaction_number",
        "value": "1111"
    }],
    "custom_variables": [],
    "logs": []
}

PATH PARAMS

id

string

OBRIGATÓRIO

ID da Fatura

 

 

 

SUGERIR EDIÇÃO

Cancelar Fatura

Cancela uma Fatura.

 

 Testar

puthttps://api.iugu.com/v1/invoices/id/cancel

curl --request PUT \
  --url https://api.iugu.com/v1/invoices/id/cancel
{
    "id": "0958D2AAD34049AB889583E26DFA0BF1",
    "due_date": "2013-11-30",
    "currency": "BRL",
    "discount_cents": null,
    "email": "teste@teste.com",
    "items_total_cents": 1000,
    "notification_url": null,
    "return_url": null,
    "status": "canceled",
    "tax_cents": null,
    "updated_at": "2014-06-17T09:58:05-03:00",
    "total_cents": 1000,
    "paid_at": null,
    "commission_cents": null,
    "secure_id": "0958d2aa-d340-49ab-8895-83e26dfa0bf1-2f4c",
    "secure_url": "http://iugu.com/invoices/0958d2aa-d340-49ab-8895-83e26dfa0bf1-2f4c",
    "customer_id": null,
    "user_id": null,
    "total": "R$ 10,00",
    "taxes_paid": "R$ 0,00",
    "commission": "R$ 0,00",
    "interest": null,
    "discount": null,
    "created_at": "17/06, 09:58 h",
    "refundable": null,
    "installments": null,
    "bank_slip": {
        "digitable_line": "00000000000000000000000000000000000000000000000",
        "barcode_data": "00000000000000000000000000000000000000000000",
        "barcode": "http://iugu.com/invoices/barcode/0958d2aa-d340-49ab-8895-83e26dfa0bf1-2f4c"
    },
    "items": [{
        "id": "11DA8B1662EC4C30BC4C78AEDC619145",
        "description": "Item Um",
        "price_cents": 1000,
        "quantity": 1,
        "created_at": "2014-06-17T09:58:05-03:00",
        "updated_at": "2014-06-17T09:58:05-03:00",
        "price": "R$ 10,00"
    }],
    "variables": [{
        "id": "A897DD8BB6B54AE18CA4C48684E72FB9",
        "variable": "payment_data.transaction_number",
        "value": "1111"
    }],
    "custom_variables": [],
    "logs": []
}

PATH PARAMS

id

string

OBRIGATÓRIO

ID da Fatura

 

 

 

SUGERIR EDIÇÃO

Gerar 2ª via de fatura

Gera a segunda via de uma fatura com o status "pendente". A fatura atual é cancelada e uma nova é criada com o mesmo status.

 

 Testar

posthttps://api.iugu.com/v1/invoices/id/duplicate

curl --request POST \
  --url https://api.iugu.com/v1/invoices/id/duplicate
{
    "id": "856856F5ADA144F68DA6E5DBEF870434",
    "due_date": "2015-12-30",
    "currency": "BRL",
    "discount_cents": null,
    "email": "email@email.com",
    "items_total_cents": 6000,
    "notification_url": null,
    "return_url": null,
    "status": "pending",
    "tax_cents": null,
    "updated_at": "2015-11-26T10:41:19-02:00",
    "total_cents": 6000,
    "total_paid_cents": 0,
    "paid_at": null,
    "commission_cents": null,
    "taxes_paid_cents": null,
    "paid_cents": null,
    "cc_emails": null,
    "financial_return_date": null,
    "payable_with": "all",
    "overpaid_cents": null,
    "ignore_due_email": false,
    "ignore_canceled_email": null,
    "secure_id": "856856f5-ada1-44f6-8da6-e5dbef870434-fe5d",
    "secure_url": "https://iugu.com/invoices/856856f5-ada1-44f6-8da6-e5dbef870434-fe5d",
    "customer_id": null,
    "customer_ref": null,
    "customer_name": null,
    "user_id": null,
    "total": "R$ 60,00",
    "taxes_paid": "R$ 0,00",
    "total_paid": "R$ 0,00",
    "total_overpaid": "R$ 0,00",
    "fines_on_occurrence_day": null,
    "total_on_occurrence_day": null,
    "fines_on_occurrence_day_cents": null,
    "total_on_occurrence_day_cents": null,
    "advance_fee": null,
    "paid": "R$ 0,00",
    "commission": "R$ 0,00",
    "interest": null,
    "discount": null,
    "created_at": "26/11, 10:41 h",
    "refundable": null,
    "installments": null,
    "transaction_number": 50053,
    "payment_method": null,
    "created_at_iso": "2015-11-26T10:41:19-02:00",
    "updated_at_iso": "2015-11-26T10:41:19-02:00",
    "financial_return_dates": null,
    "bank_slip": {
        "digitable_line": "23793.38128 50000.005004 53000.050806 1 66580000006000",
        "barcode_data": "23791665800000060003381250000005005300005080",
        "barcode": "https://iugu.com/invoices/barcode/856856f5-ada1-44f6-8da6-e5dbef870434-fe5d"
    },
    "items": [
        {
            "id": "6FEE1E9B576D4D8DBB7A1CE5AFB5CFCC",
            "description": "Item Novo",
            "price_cents": 1000,
            "quantity": 1,
            "created_at": "2015-11-26T10:41:19-02:00",
            "updated_at": "2015-11-26T10:41:19-02:00",
            "price": "R$ 10,00"
        },
        {
            "id": "F6AB80CCA459434E980F59846C948B2C",
            "description": "Item 1",
            "price_cents": 5000,
            "quantity": 1,
            "created_at": "2015-11-26T10:41:19-02:00",
            "updated_at": "2015-11-26T10:41:19-02:00",
            "price": "R$ 50,00"
        }
    ],
    "variables": [
        {
            "id": "82139DD9E6704A369AEA0C7F50335EA9",
            "variable": "payment_data.transaction_number",
            "value": "1111"
        }
    ],
    "custom_variables": [],
    "logs": [
        {
            "id": "DF6A3748D2024E60A15189196264070A",
            "description": "Segunda via gerada",
            "notes": "Segunda via gerada da FATURA # 3062A45BC5C240C685C5D6A2B4C78668",
            "created_at": "26/11, 10:41 h"
        }
    ]
}

PATH PARAMS

id

string

OBRIGATÓRIO

ID da fatura

 

BODY PARAMS

due_date

date

OBRIGATÓRIO

Nova data de vencimento no formato AAAA-MM-DD.

 

items

array of objects

Adicione, altere ou remova itens da nova fatura. Para remover, envie "id" do subitem + "_destroy=true"

description

quantity

price_cents

id

_destroy

truefalse

Add ObjectEdit Array JSONignore_due_email

boolean

Ignora o envio do e-mail de cobrança da nova fatura.

truefalse

ignore_canceled_email

boolean

Ignora o envio do e-mail de cancelamento da fatura atual.

truefalse

current_fines_option

boolean

Caso true, aplica multas da fatura original à segunda via.

truefalse

keep_early_payment_discount

boolean

Caso true, copia os descontos de pagamento antecipado da fatura original para a 2ª via.

truefalse

 

 

SUGERIR EDIÇÃO

Buscar Fatura

Retorna os dados de uma Fatura.

 

 Testar

gethttps://api.iugu.com/v1/invoices/id

curl --request GET \
  --url https://api.iugu.com/v1/invoices/id
{
    "id": "0958D2AAD34049AB889583E26DFA0BF1",
    "due_date": "2013-11-30",
    "currency": "BRL",
    "discount_cents": null,
    "email": "teste@teste.com",
    "items_total_cents": 1000,
    "notification_url": null,
    "return_url": null,
    "status": "paid",
    "tax_cents": null,
    "updated_at": "2014-06-17T09:58:05-03:00",
    "total_cents": 1000,
    "paid_at": null,
    "commission_cents": null,
    "secure_id": "0958d2aa-d340-49ab-8895-83e26dfa0bf1-2f4c",
    "secure_url": "http://iugu.com/invoices/0958d2aa-d340-49ab-8895-83e26dfa0bf1-2f4c",
    "customer_id": null,
    "user_id": null,
    "total": "R$ 10,00",
    "taxes_paid": "R$ 0,75",
    "financial_return_date": "2013-12-30",
    "commission": "R$ 0,00",
    "interest": null,
    "discount": null,
    "created_at": "17/06, 09:58 h",
    "refundable": null,
    "installments": null,
    "financial_return_dates": [
      {
        "id": 2471909,
        "installment": 1,
        "return_date": "2017-11-23",
        "status": "done",
        "amount": "R$ 382,78",
        "taxes": "R$ 16,22",
        "executed_date": "23/11, 00:32 h",
        "advanced": false
      }
    ],
    "bank_slip": {
        "digitable_line": "00000000000000000000000000000000000000000000000",
        "barcode_data": "00000000000000000000000000000000000000000000",
        "barcode": "http://iugu.com/invoices/barcode/0958d2aa-d340-49ab-8895-83e26dfa0bf1-2f4c"
    },
    "items": [{
        "id": "11DA8B1662EC4C30BC4C78AEDC619145",
        "description": "Item Um",
        "price_cents": 1000,
        "quantity": 1,
        "created_at": "2014-06-17T09:58:05-03:00",
        "updated_at": "2014-06-17T09:58:05-03:00",
        "price": "R$ 10,00"
    }],
    "variables": [{
        "id": "A897DD8BB6B54AE18CA4C48684E72FB9",
        "variable": "payment_data.transaction_number",
        "value": "1111"
    },
    {
        "variable":"payment_data.occurrence_date",
        "value":"051017"
    },
    {
        "variable":"payment_method",
        "value":"iugu_credit_card_test"
    }
],
    "custom_variables": [],
    "logs": []
}

PATH PARAMS

id

string

OBRIGATÓRIO

ID da Fatura

 

 

 

SUGERIR EDIÇÃO

Listar faturas

Retorna uma lista das faturas em sua conta ordenadas pela data de criação, da mais à menos recente. Por padrão, este endpoint retorna no máximo 100 registros. O campo "totalItems" contém sempre a quantidade total de faturas cadastradas, independentemente dos parâmetros de pesquisa utilizados, e o resultado da pesquisa fica sempre dentro de "items".

 

 Testar

gethttps://api.iugu.com/v1/invoices

curl --request GET \
  --url https://api.iugu.com/v1/invoices
{
    "facets": {
        "status": {
            "_type": "terms",
            "missing": 0,
            "total": 2,
            "other": 0,
            "terms": [
                {
                    "term": "paid",
                    "count": 1
                },
                {
                    "term": "pending",
                    "count": 1
                }
            ]
        }
    },
    "totalItems": 2,
    "items": [
        {
            "id": "E607FCCD119E45C59336DB78B54CF771",
            "due_date": "2013-11-30",
            "currency": "BRL",
            "customer_id": null,
            "discount_cents": null,
            "email": "teste@teste.com",
            "expiration_url": null,
            "notification_url": null,
            "return_url": null,
            "status": "pending",
            "tax_cents": null,
            "updated_at": "2013-11-18T14:58:23-02:00",
            "total_cents": 1000,
            "commission_cents": null,
            "secure_id": "e607fccd-119e-45c5-9336-db78b54cf771-314d",
            "secure_url": "https://iugu.com/invoices/e607fccd-119e-45c5-9336-db78b54cf771-314d",
            "user_id": null,
            "commission": "R$ 0,00",
            "total": "R$ 10,00",
            "created_at": "18 Nov 14:58",
            "items": [
                {
                    "id": "0E9E83C2E8B14AF0ADB2F5F6E97265AA",
                    "description": "Item Um",
                    "price_cents": 1000,
                    "quantity": 1,
                    "created_at": "2013-11-18T14:58:23-02:00",
                    "updated_at": "2013-11-18T14:58:23-02:00",
                    "price": "R$ 10,00"
                }
            ],
            "variables": [],
            "logs": []
        },
        {
            "id": "F47FE578806747FE8FF71C1521934E81",
            "due_date": "2013-10-24",
            "currency": "BRL",
            "customer_id": "32ce45d8-b42b-4aee-a3d1-a1d9227e1790",
            "discount_cents": null,
            "email": "teste@gmail.com",
            "expiration_url": null,
            "notification_url": null,
            "return_url": null,
            "status": "paid",
            "tax_cents": null,
            "updated_at": "2013-10-24T14:21:26-02:00",
            "total_cents": 200,
            "commission_cents": 0,
            "secure_id": "f47fe578-8067-47fe-8ff7-1c1521934e81-3280",
            "secure_url": "https://iugu.com/invoices/f47fe578-8067-47fe-8ff7-1c1521934e81-3280",
            "commission": "R$ 0,00",
            "user_id": null,
            "total": "R$ 2,00",
            "created_at": "24 Oct 14:21",
            "items": [
                {
                    "id": "FBDBAF5E259C492C98E6C2CB493777F7",
                    "description": "Subscription Activation: plan1",
                    "price_cents": 200,
                    "quantity": 1,
                    "created_at": "2013-10-24T14:21:26-02:00",
                    "updated_at": "2013-10-24T14:21:26-02:00",
                    "price": "R$ 2,00"
                }
            ],
            "variables": [],
            "logs": []
        }
    ]
}

QUERY PARAMS

limit

int32

Limita o número de registros retornados em até 100, que é o padrão de retorno desta chamada. Também utilizado em paginação.

 

start

int32

Quantos registros pular do início da pesquisa, usado para paginação.

 

created_at_from

date

Registros criados a partir dessa data passada no parâmetro. Formato (AAAA-MM-DDThh:mm:ss-03:00)

 

created_at_to

date

Registros criados até esta data passada no parâmetro. Formato (AAAA-MM-DDThh:mm:ss-03:00)

 

paid_at_from

date

Registros pagos a partir dessa data passada no parâmetro. Formato (AAAA-MM-DDThh:mm:ss-03:00)

 

paid_at_to

date

Registros pagos até esta data passada no parâmetro. Formato (AAAA-MM-DDThh:mm:ss-03:00)

 

due_date

date

Data de Expiração (AAAA-MM-DD)

 

query

string

Neste parâmetro pode ser passado um texto para pesquisa como e-mail, nome, anotações e variáveis customizadas

 

updated_since

date

Registros atualizados desde o momento passado no parâmetro. Formato (AAAA-MM-DDThh:mm:ss-03:00)

 

sortBy

object

Um hash sendo a chave o nome do campo para ordenação e o valor sendo DESC ou ASC para descendente e ascendente, respectivamente. ex1: sortBy[created_at]=ASC ex2: sortBy[paid_at]=DESC ex3: sortBy[due_date]=ASC

 

customer_id

string

ID do Cliente

 

status_filter

string

Usado para filtrar as assinaturas pelo status (pending, paid, canceled, partially_paid, refunded, expired, authorized)

 

 

 

SUGERIR EDIÇÃO

Enviar por email

Envia a fatura iugu para o email vinculado a ela.

 

 Testar

posthttps://api.iugu.com/v1/invoices/id/send_email

curl --request POST \
  --url https://api.iugu.com/v1/invoices/id/send_email
{
  "id": "9F420E7FD2534A68BF4DC20951E2B371",
  "due_date": "2020-01-01",
  "currency": "BRL",
  "discount_cents": null,
  "email": "email@cliente.com",
  "items_total_cents": 10000,
  "notification_url": null,
  "return_url": null,
  "status": "paid",
  "tax_cents": null,
  "updated_at": "2018-01-04T16:37:13-02:00",
  "total_cents": 10000,
  "total_paid_cents": 10000,
  "paid_at": "2018-01-04T16:37:13-02:00",
  "taxes_paid_cents": 480,
  "paid_cents": 10000,
  "cc_emails": null,
  "financial_return_date": null,
  "payable_with": "credit_card",
  "overpaid_cents": null,
  "ignore_due_email": true,
  "ignore_canceled_email": true,
  "advance_fee_cents": null,
  "commission_cents": 0,
  "early_payment_discount": true,
  "total": "R$ 100,00",
  "taxes_paid": "R$ 4,80",
  "total_paid": "R$ 100,00",
  "total_overpaid": "R$ 0,00",
  "commission": "R$ 0,00",
  "fines_on_occurrence_day": "R$ 0,00",
  "total_on_occurrence_day": "R$ 100,00",
  "fines_on_occurrence_day_cents": 0,
  "total_on_occurrence_day_cents": 10000,
  "advance_fee": null,
  "paid": "R$ 100,00",
  "interest": null,
  "discount": null,
  "created_at": "04/01, 16:37 h",
  "refundable": true,
  "installments": "1",
  "transaction_number": 1111,
  "payment_method": "iugu_credit_card_test",
  "created_at_iso": "2018-01-04T16:37:13-02:00",
  "updated_at_iso": "2018-01-04T16:37:13-02:00",
  "occurrence_date": "2018-01-04",
  "financial_return_dates": null,
  "bank_slip": null,
  "items": [],
  "early_payment_discounts": [],
  "variables": [],
  "custom_variables": [],
  "logs": []
}

PATH PARAMS

id

string

OBRIGATÓRIO

ID da fatura.

 

 

 

SUGERIR EDIÇÃO

Tokenização e iugu.js

 

A maneira mais segura de criar tokens é através da biblioteca iugu.js, que garante a comunicação entre o navegador do usuário final diretamente com nossos servidores.

Saiba mais sobre o iugu.js e Tokenização.

 

SUGERIR EDIÇÃO

Criar Token

O Token é uma representação do meio de pagamento do cliente (por ex: seu cartão de crédito), sendo totalmente seguro, de forma que não é possível que alguém consiga as informações do cartão de crédito do cliente utilizando esse token. O token é gerado para uma transação específica, tornando-o ainda mais seguro.

 

Cuidado

A API de Criação de Token não utiliza a autenticação via api_token.

 

 

Alerta de conformidade com PCI

Esta chamada API deve ser utilizada apenas em aplicações sem compatibilidade com JavaScript como por exemplo aplicações móveis. Se você efetuar esta chamada por dentro de seus servidores estará sujeito a uma auditoria do PCI. Para aplicações WEB, utilize a geração do token de cartão pelo iugu.js

 

 

 Testar

posthttps://api.iugu.com/v1/payment_token

curl --request POST \
  --url https://api.iugu.com/v1/payment_token
{
  "id": "884629730509465AA89387529A56EE3C",
  "method": "credit_card",
  "extra_info": {
    "brand": "VISA",
    "holder_name": "JOHN DOE",
    "display_number": "XXXX-XXXX-XXXX-1111",
    "bin": "411111",
    "month": 10,
    "year": 2020
  },
  "test": true
}

BODY PARAMS

account_id

string

OBRIGATÓRIO

ID de sua Conta na Iugu (O ID de sua conta pode ser encontrado aqui)

 

method

string

OBRIGATÓRIO

Método de Pagamento (atualmente somente credit_card)

 

test

boolean

Valor true para criar tokens de teste. Use cartões de teste

truefalse

data

object

 

data.number

string

OBRIGATÓRIO

Número do Cartão de Crédito

 

data.verification_value

string

OBRIGATÓRIO

CVV do Cartão de Crédito

 

data.first_name

string

OBRIGATÓRIO

Nome do Cliente como está no Cartão

 

data.last_name

string

OBRIGATÓRIO

Sobrenome do Cliente como está no Cartão

 

data.month

string

OBRIGATÓRIO

Mês de Vencimento no Formato "MM" (Ex: 01, 06, 12)

 

data.year

string

OBRIGATÓRIO

Ano de Vencimento no Formato "AAAA" (Ex: 2020, 2030, 2018)

 

 

 

SUGERIR EDIÇÃO

Cobrança direta

Cobrança simples via boleto ou cartão de crédito.

 

 Testar

posthttps://api.iugu.com/v1/charge

curl --request POST \
  --url https://api.iugu.com/v1/charge
//credit_card return
{
  "message": "Autorizado",
  "errors": {},
  "success": true,
  "url": "https://faturas.iugu.com/03937a35-3208-4080-b551-f7307b581bd8-728a",
  "pdf": "https://faturas.iugu.com/03937a35-3208-4080-b551-f7307b581bd8-728a.pdf",
  "identification": null,
  "invoice_id": "03937A3532084080B551F7307B581BD8",
  "LR": "00"
}

//bank_slip return
{
  "success": true,
  "url": "https://faturas.iugu.com/8e312b31-4cca-471d-b6d5-e94febac1592-341a?bs=true",
  "pdf": "https://faturas.iugu.com/8e312b31-4cca-471d-b6d5-e94febac1592-341a.pdf",
  "identification": "00000000000000000000000000000000000000000000000",
  "invoice_id": "8E312B314CCA471DB6D5E94FEBAC1592"
}

BODY PARAMS

method

string

Método de pagamento (Atualmente só suporta "bank_slip", que é boleto bancário. Não é preenchido se enviar parâmetro token)

 

token

string

ID do Token. Não é preenchido caso o método de pagamento seja "bank_slip". Em caso de Marketplace, é possível enviar um token criado pela conta mestre.

 

customer_payment_method_id

string

ID da Forma de Pagamento do Cliente. Em caso de Marketplace, é possível enviar um "customer_payment_method_id" de um Cliente criado pela conta mestre (não é preenchido caso Método de Pagamento seja "bank_slip" ou utilize "token")

 

restrict_payment_method

boolean

Se true, restringe o método de pagamento da cobrança para o definido em method.

truefalse

customer_id

string

ID do Cliente. Utilizado para vincular a Fatura a um Cliente

 

invoice_id

string

ID da Fatura a ser utilizada para pagamento

 

email

string

E-mail do Cliente (não é preenchido caso seja enviado um "invoice_id")

 

months

int32

Número de Parcelas (2 até 12), não é necessário passar 1. Não é preenchido caso o método de pagamento seja "bank_slip"

 

discount_cents

int32

Valor de desconto, em centavos, aplicado sobre os itens criados em caso de não haver fatura vinculada à chamada.

 

bank_slip_extra_days

int32

Define o prazo em dias para o pagamento do boleto. Caso não seja enviado, aplica-se o prazo padrão de 3 dias corridos.

 

keep_dunning

boolean

Por padrão, a fatura é cancelada caso haja falha na cobrança, a não ser que este parâmetro seja enviado como "true". Obs: Funcionalidade disponível apenas para faturas criadas no momento da cobrança.

truefalse

items

array of objects

Itens de cobrança da Fatura que será gerada. "price_cents" valor mínimo 100.

description

quantity

price_cents

Add ObjectEdit Array JSON*atenção*

object

Informações do cliente abaixo "payer" são obrigatórias para a emissão de boletos registrados ou necessárias para seu sistema de antifraude.

 

payer

object

 

payer.cpf_cnpj

string

CPF ou CNPJ

 

payer.name

string

Nome

 

payer.phone_prefix

string

Prefixo do número de telefone

 

payer.phone

string

Número de telefone

 

payer.email

string

E-mail

 

payer.address

object

Endereço do cliente

 

payer.address.street

string

Rua

 

payer.address.number

string

Número

 

payer.address.district

string

Bairro

 

payer.address.city

string

Cidade

 

payer.address.state

string

Estado

 

payer.address.zip_code

string

CEP

 

payer.address.complement

string

Complemento (opcional)

 

order_id

string

Número único que identifica o pedido de compra. Opcional, ajuda a evitar o pagamento da mesma fatura.

 

 

 

SUGERIR EDIÇÃO

Criar Cliente

Cria um objeto cliente

 

 Testar

posthttps://api.iugu.com/v1/customers

curl --request POST \
  --url https://api.iugu.com/v1/customers
{
    "id": "77C2565F6F064A26ABED4255894224F0",
    "email": "email@email.com",
    "name": "Nome do Cliente",
    "notes": "Anotações Gerais",
    "created_at": "2013-11-18T14:58:30-02:00",
    "updated_at": "2013-11-18T14:58:30-02:00",
    "custom_variables":[]
}

BODY PARAMS

email

string

OBRIGATÓRIO

Email do cliente

 

name

string

OBRIGATÓRIO

Nome do cliente

 

notes

string

Notas

 

phone

int32

Número do Telefone - 9 dígitos

 

phone_prefix

int32

Prefixo, apenas números - 3 dígitos (obrigatório caso preencha "phone")

 

cpf_cnpj

string

CPF ou CNPJ do cliente. Obrigatório para emissão de boletos registrados.

 

cc_emails

string

Endereços de E-mail para cópia separados por vírgula

 

zip_code

string

CEP. Obrigatório para emissão de boletos registrados

 

number

string

Número do endereço (obrigatório caso "zip_code" seja enviado).

 

street

string

Rua. Obrigatório caso CEP seja incompleto.

 

city

string

Cidade

 

state

string

Estado

 

district

string

Bairro. Obrigatório caso CEP seja incompleto.

 

complement

string

Complemento de endereço. Ponto de referência.

 

custom_variables

array of objects

Variáveis Personalizadas

name

value

Add ObjectEdit Array JSON

 

 

SUGERIR EDIÇÃO

Alterar Cliente

Alterar os dados de um Cliente. Quaisquer parâmetros não informados não serão alterados.

 

 Testar

puthttps://api.iugu.com/v1/customers/id

curl --request PUT \
  --url https://api.iugu.com/v1/customers/id
{
    "id": "77C2565F6F064A26ABED4255894224F0",
    "email": "email@email.com",
    "name": "Novo Nome do Cliente",
    "notes": "Novas Anotações Gerais",
    "created_at": "2013-11-18T14:58:30-02:00",
    "updated_at": "2013-11-18T14:58:30-02:00",
    "custom_variables":[]
}

PATH PARAMS

id

string

OBRIGATÓRIO

ID do cliente

 

BODY PARAMS

email

string

Email do cliente

 

name

string

Nome do cliente

 

notes

string

Notas

 

phone

int32

Número do Telefone - 9 dígitos

 

phone_prefix

int32

Prefixo, apenas números - 3 dígitos (obrigatório caso preencha "phone")

 

cpf_cnpj

string

CPF ou CNPJ do cliente

 

cc_emails

string

Endereços de E-mail para cópia separados por vírgula

 

zip_code

string

CEP

 

number

string

Número do endereço (obrigatório caso zip_code seja enviado)

 

street

string

Rua

 

city

string

Cidade

 

state

string

Estado

 

district

string

Bairro

 

complement

string

Complemento de endereço. Ponto de referência.

 

default_payment_method_id

string

ID da Forma de Pagamento padrão do cliente, "id" obtido em "Listar formas de pagamentos", quando preenchido, vai fazer cobranças automáticas das faturas geradas para este cliente, na data do vencimento ou após vencimento. Enviar "null" para desvincular o cartão das cobranças automáticas.

 

custom_variables

array of objects

Variáveis Personalizadas, adicionar, alterar ou remover. Para remover, envie "name:$valor" + "_destroy:true" - $valor é a própria chave para remoção do item.

name

value

_destroy

truefalse

Add ObjectEdit Array JSON

 

 

SUGERIR EDIÇÃO

Remover Cliente

Remove permanentemente um cliente. Porém, não permite remover clientes com assinaturas ou faturas vinculadas.

 

 Testar

deletehttps://api.iugu.com/v1/customers/id

curl --request DELETE \
  --url https://api.iugu.com/v1/customers/id
{
    "id": "77C2565F6F064A26ABED4255894224F0",
    "email": "email@email.com",
    "name": "Novo Nome do Cliente",
    "notes": "Novas Anotações Gerais",
    "created_at": "2013-11-18T14:58:30-02:00",
    "updated_at": "2013-11-18T14:58:30-02:00",
    "custom_variables":[]
}

PATH PARAMS

id

string

OBRIGATÓRIO

ID do cliente

 

 

 

SUGERIR EDIÇÃO

Buscar Cliente

Retorna os dados de um cliente

 

 Testar

gethttps://api.iugu.com/v1/customers/id

curl --request GET \
  --url https://api.iugu.com/v1/customers/id
{
    "id": "77C2565F6F064A26ABED4255894224F0",
    "email": "email@email.com",
    "name": "Nome do Cliente",
    "notes": "Anotações Gerais",
    "created_at": "2013-11-18T14:58:30-02:00",
    "updated_at": "2013-11-18T14:58:30-02:00",
    "custom_variables":[]
}

PATH PARAMS

id

string

OBRIGATÓRIO

ID do cliente

 

 

 

SUGERIR EDIÇÃO

Listar Clientes

Retorna uma lista com todos os clientes cadastrados em sua conta ordenados pela data de Criação, sendo o primeiro o que foi criado mais recentemente. O campo totalItems contém a quantidade de clientes encontrados no sistema de acordo com os parametros query. O resultado da pesquisa fica dentro de items.

 

 Testar

gethttps://api.iugu.com/v1/customers

curl --request GET \
  --url https://api.iugu.com/v1/customers
{
    "totalItems": 5,
    "items": [
        {
            "id": "FF3149CE52CB4A789925F154B489BFDD",
            "email": "email@email.com",
            "name": "Nome do Cliente",
            "notes": "Anotações Gerais",
            "created_at": "2013-11-18T14:58:30-02:00",
            "updated_at": "2013-11-18T14:58:30-02:00"
        },
        {
            "id": "912FD57927FA43DEB0223C819E18DDFE",
            "email": "email@email.com",
            "name": "Nome do Cliente",
            "notes": "Anotações Gerais",
            "created_at": "2013-11-18T14:58:30-02:00",
            "updated_at": "2013-11-18T14:58:30-02:00"
        },
        {
            "id": "32CE45D8B42B4AEEA3D1A1D9227E1790",
            "email": "email@gmail.com",
            "name": null,
            "notes": null,
            "created_at": "2013-11-18T14:58:30-02:00",
            "updated_at": "2013-11-18T14:58:30-02:00"
        },
        {
            "id": "1AF1B6EC280149708773FED03EB407AA",
            "email": "teste@gmail.com",
            "name": null,
            "notes": null,
            "created_at": "2013-11-18T14:58:30-02:00",
            "updated_at": "2013-11-18T14:58:30-02:00"
        },
        {
            "id": "D65B556E19ED4173976421E84EE7B251",
            "email": "cliente@gmail.com",
            "name": null,
            "notes": null,
            "created_at": "2013-11-18T14:58:30-02:00",
            "updated_at": "2013-11-18T14:58:30-02:00"
        }
    ]
}

QUERY PARAMS

limit

int32

Limita em até 1.000 o número de registros listados. Caso não seja enviado, aplica-se o limite padrão de 100 registros. Também utilizando em paginação.

 

start

int32

Quantos registros pular do início da pesquisa.

 

created_at_from

date

Registros criados a partir desta data passada no parâmetro. Formato (AAAA-MM-DDThh:mm:ss-03:00)

 

created_at_to

date

Registros criados até esta data passada no parâmetro. Formato (AAAA-MM-DDThh:mm:ss-03:00)

 

query

string

Neste parâmetro pode ser passado um texto para pesquisa como e-mail, nome, anotações e variáveis customizadas

 

updated_since

date

Registros atualizados desde o valor passado no parâmetro. Formato (AAAA-MM-DDThh:mm:ss-03:00)

 

sortBy

object

Um hash sendo a chave o nome do campo para ordenação e o valor sendo DESC ou ASC para descendente e ascendente, respectivamente. ex1: sortBy[created_at]=ASC ex2: sortBy[name]=ASC ex3: sortBy[updated_at]=DESC

 

 

 

SUGERIR EDIÇÃO

Criar Forma de Pagamento

Cria uma forma de pagamento de cliente.

 

 Testar

posthttps://api.iugu.com/v1/customers/customer_id/payment_methods

curl --request POST \
  --url https://api.iugu.com/v1/customers/customer_id/payment_methods
{
    "id": "9B41FB19CBA44913B1EF990A10382E7E",
    "description": "Meu Cartão de Crédito",
    "item_type": "credit_card",
    "data": {
        "holder_name": "Joao Silva",
        "display_number": "XXXX-XXXX-XXXX-1111",
        "brand": "visa",
        "month":12,
        "year":2022
    }
}

PATH PARAMS

customer_id

string

OBRIGATÓRIO

ID do Cliente

 

BODY PARAMS

description

string

OBRIGATÓRIO

Descrição

 

token

string

OBRIGATÓRIO

Token de Pagamento criar

 

set_as_default

boolean

Se "true" define esta Forma de Pagamento como padrão do Cliente, ou seja, para executar cobranças automáticas no cartão salvo.

truefalse

 

 

SUGERIR EDIÇÃO

Alterar Forma de Pagamento

Altera os dados de uma Forma de Pagamento, quaisquer parâmetros não informados não serão alterados.

 

 Testar

puthttps://api.iugu.com/v1/customers/customer_id/payment_methods/id

curl --request PUT \
  --url https://api.iugu.com/v1/customers/customer_id/payment_methods/id
{
    "id": "9B41FB19CBA44913B1EF990A10382E7E",
    "description": "Novo Meu Cartão de Crédito",
    "item_type": "credit_card",
    "data": {
        "holder_name": "Joao Silva",
        "display_number": "XXXX-XXXX-XXXX-1111",
        "brand": "visa",
        "month":10,
        "year":2022
    }
}

PATH PARAMS

customer_id

string

OBRIGATÓRIO

ID do cliente

 

id

string

OBRIGATÓRIO

ID da forma de pagamento

 

BODY PARAMS

description

string

Descrição

 

 

 

SUGERIR EDIÇÃO

Remover Forma de Pagamento

Remove permanentemente uma forma de pagamento de um cliente.

 

 Testar

deletehttps://api.iugu.com/v1/customers/customer_id/payment_methods/id

curl --request DELETE \
  --url https://api.iugu.com/v1/customers/customer_id/payment_methods/id
{
    "id": "9B41FB19CBA44913B1EF990A10382E7E",
    "description": "Novo Meu Cartão de Crédito",
    "item_type": "credit_card",
    "data": {
        "holder_name": "Joao Silva",
        "display_number": "XXXX-XXXX-XXXX-1111",
        "brand": "visa",
        "month":10,
        "year":2022
    }
}

PATH PARAMS

customer_id

string

OBRIGATÓRIO

ID do cliente

 

id

string

OBRIGATÓRIO

ID da forma de pagamento

 

 

 

SUGERIR EDIÇÃO

Buscar Forma de Pagamento

Retorna os dados de uma Forma de Pagamento de um Cliente

 

 Testar

gethttps://api.iugu.com/v1/customers/customer_id/payment_methods/id

curl --request GET \
  --url https://api.iugu.com/v1/customers/customer_id/payment_methods/id
{
    "id": "9B41FB19CBA44913B1EF990A10382E7E",
    "description": "Meu Cartão de Crédito",
    "item_type": "credit_card",
    "data": {
        "holder_name": "Joao Silva",
        "display_number": "XXXX-XXXX-XXXX-1111",
        "brand": "visa",
        "month":10,
        "year":2022
    }
}

PATH PARAMS

customer_id

string

OBRIGATÓRIO

ID do cliente

 

id

string

OBRIGATÓRIO

ID da forma de pagamento

 

 

 

SUGERIR EDIÇÃO

Listar Formas de Pagamento

Retorna uma lista com todas as formas de pagamento de determinado cliente.

 

 Testar

gethttps://api.iugu.com/v1/customers/customer_id/payment_methods

curl --request GET \
  --url https://api.iugu.com/v1/customers/customer_id/payment_methods
[{
    "id": "48D603C05F634244A1D3FC2BFF35D10A",
    "description": "Meu Cartão de Crédito Um",
    "item_type": "credit_card",
    "data": {
        "holder_name": "Joao Silva",
        "display_number": "XXXX-XXXX-XXXX-1111",
        "brand": "visa",
        "month":10,
        "year":2022
    }
}, {
    "id": "9B41FB19CBA44913B1EF990A10382E7E",
    "description": "Meu Cartão de Crédito Dois",
    "item_type": "credit_card",
    "data": {
        "holder_name": "Jose Santos",
        "display_number": "XXXX-XXXX-XXXX-1111",
        "brand": "visa",
        "month":7,
        "year":2019
    }
}]

PATH PARAMS

customer_id

string

OBRIGATÓRIO

ID do cliente

 

 

 

SUGERIR EDIÇÃO

Criar Plano

Cria um plano.

 

 Testar

posthttps://api.iugu.com/v1/plans

curl --request POST \
  --url https://api.iugu.com/v1/plans
{
    "id": "593C92165AF44493B65DE17A216C76D6",
    "name": "Plano Básico",
    "identifier": "basic_plan",
    "interval": 1,
    "interval_type": "months",
    "created_at": "2014-04-23T17:14:15-03:00",
    "updated_at": "2014-04-23T17:14:15-03:00",
    "prices": [{
        "created_at": "2014-04-23T17:14:15-03:00",
        "currency": "BRL",
        "id": "F465EE77AC424DA2B075133C96FF10CA",
        "plan_id": "593C92165AF44493B65DE17A216C76D6",
        "updated_at": "2014-04-23T17:14:15-03:00",
        "value_cents": 1000
    }],
    "features": [{
        "created_at": "2014-04-23T17:14:15-03:00",
        "id": "6101C66D06564E3DB834BCE235A587A6",
        "identifier": "users",
        "important": null,
        "name": "Número de Usuários",
        "plan_id": "593C92165AF44493B65DE17A216C76D6",
        "position": 1,
        "updated_at": "2014-04-23T17:14:15-03:00",
        "value": 10
    }]
}

BODY PARAMS

name

string

OBRIGATÓRIO

Nome do plano

 

identifier

string

OBRIGATÓRIO

Identificador do plano

 

interval

int32

OBRIGATÓRIO

Ciclo do plano (Número inteiro maior que 0). Intervalo até a próxima cobrança.

 

interval_type

string

OBRIGATÓRIO

Tipo de interval ("weeks" ou "months").

 

value_cents

int32

OBRIGATÓRIO

Preço do plano em centavos

 

payable_with

string

Método de pagamento que será disponibilizado para as faturas pertencentes a assinaturas deste plano ('all', 'credit_card' ou 'bank_slip')

 

features

array of objects

name

identifier

value

Add ObjectEdit Array JSON

 

 

SUGERIR EDIÇÃO

Alterar Plano

Altera os dados de um Plano, quaisquer parâmetros não informados não serão alterados. As alterações não irão mudar as Assinaturas que já utilizam o Plano, mas só as novas.

 

 Testar

puthttps://api.iugu.com/v1/plans/id

curl --request PUT \
  --url https://api.iugu.com/v1/plans/id
{
    "id": "593C92165AF44493B65DE17A216C76D6",
    "name": "Plano Básico",
    "identifier": "basic_plan_new",
    "interval": 1,
    "interval_type": "months",
    "created_at": "2014-04-23T17:14:15-03:00",
    "updated_at": "2014-04-23T17:14:15-03:00",
    "prices": [{
        "created_at": "2014-04-23T17:14:15-03:00",
        "currency": "BRL",
        "id": "F465EE77AC424DA2B075133C96FF10CA",
        "plan_id": "593C92165AF44493B65DE17A216C76D6",
        "updated_at": "2014-04-23T17:14:15-03:00",
        "value_cents": 1000
    }],
    "features": [{
        "created_at": "2014-04-23T17:14:15-03:00",
        "id": "6101C66D06564E3DB834BCE235A587A6",
        "identifier": "users",
        "important": null,
        "name": "Número de Usuários",
        "plan_id": "593C92165AF44493B65DE17A216C76D6",
        "position": 1,
        "updated_at": "2014-04-23T17:14:15-03:00",
        "value": 10
    }]
}

PATH PARAMS

id

string

OBRIGATÓRIO

ID do plano

 

BODY PARAMS

name

string

Nome do plano

 

interval

int32

Ciclo do plano (Número inteiro maior que 0)

 

interval_type

string

Tipo de interval ("weeks" ou "months")

 

value_cents

int32

Preço do plano em centavos

 

payable_with

string

Método de pagamento que será disponibilizado para as faturas pertencentes a assinaturas deste plano ('all', 'credit_card' ou 'bank_slip')

 

features

array of objects

Descrição das funcionalidades do plano, permite adicionar, alterar ou remover. Para remover, envie "id:$valor" + "_destroy:true" sendo $valor o ID da feature.

id

_destroy

truefalse

value

name

Add ObjectEdit Array JSON

 

 

SUGERIR EDIÇÃO

Remover Plano

Retorna os dados de um Plano.

 

 Testar

deletehttps://api.iugu.com/v1/plans/id

curl --request DELETE \
  --url https://api.iugu.com/v1/plans/id
{
    "id": "593C92165AF44493B65DE17A216C76D6",
    "name": "Plano Básico",
    "identifier": "basic_plan",
    "interval": 1,
    "interval_type": "months",
    "created_at": "2014-04-23T17:14:15-03:00",
    "updated_at": "2014-04-23T17:14:15-03:00",
    "prices": [{
        "created_at": "2014-04-23T17:14:15-03:00",
        "currency": "BRL",
        "id": "F465EE77AC424DA2B075133C96FF10CA",
        "plan_id": "593C92165AF44493B65DE17A216C76D6",
        "updated_at": "2014-04-23T17:14:15-03:00",
        "value_cents": 1000
    }],
    "features": [{
        "created_at": "2014-04-23T17:14:15-03:00",
        "id": "6101C66D06564E3DB834BCE235A587A6",
        "identifier": "users",
        "important": null,
        "name": "Número de Usuários",
        "plan_id": "593C92165AF44493B65DE17A216C76D6",
        "position": 1,
        "updated_at": "2014-04-23T17:14:15-03:00",
        "value": 10
    }]
}

PATH PARAMS

id

string

OBRIGATÓRIO

ID do plano

 

 

 

SUGERIR EDIÇÃO

Buscar Plano

Retorna os dados de um Plano.

 

 Testar

gethttps://api.iugu.com/v1/plans/id

curl --request GET \
  --url https://api.iugu.com/v1/plans/id
{
    "id": "593C92165AF44493B65DE17A216C76D6",
    "name": "Plano Básico",
    "identifier": "basic_plan",
    "interval": 1,
    "interval_type": "months",
    "created_at": "2014-04-23T17:14:15-03:00",
    "updated_at": "2014-04-23T17:14:15-03:00",
    "prices": [{
        "created_at": "2014-04-23T17:14:15-03:00",
        "currency": "BRL",
        "id": "F465EE77AC424DA2B075133C96FF10CA",
        "plan_id": "593C92165AF44493B65DE17A216C76D6",
        "updated_at": "2014-04-23T17:14:15-03:00",
        "value_cents": 1000
    }],
    "features": [{
        "created_at": "2014-04-23T17:14:15-03:00",
        "id": "6101C66D06564E3DB834BCE235A587A6",
        "identifier": "users",
        "important": null,
        "name": "Número de Usuários",
        "plan_id": "593C92165AF44493B65DE17A216C76D6",
        "position": 1,
        "updated_at": "2014-04-23T17:14:15-03:00",
        "value": 10
    }]
}

PATH PARAMS

id

string

OBRIGATÓRIO

ID do plano

 

 

 

SUGERIR EDIÇÃO

Buscar Plano pelo Identificador

Retorna os dados de um plano utilizando um identificador.

 

 Testar

gethttps://api.iugu.com/v1/plans/identifier/identifier

curl --request GET \
  --url https://api.iugu.com/v1/plans/identifier/identifier
{
    "id": "593C92165AF44493B65DE17A216C76D6",
    "name": "Plano Básico",
    "identifier": "basic_plan",
    "interval": 1,
    "interval_type": "months",
    "created_at": "2014-04-23T17:14:15-03:00",
    "updated_at": "2014-04-23T17:14:15-03:00",
    "prices": [{
        "created_at": "2014-04-23T17:14:15-03:00",
        "currency": "BRL",
        "id": "F465EE77AC424DA2B075133C96FF10CA",
        "plan_id": "593C92165AF44493B65DE17A216C76D6",
        "updated_at": "2014-04-23T17:14:15-03:00",
        "value_cents": 1000
    }],
    "features": [{
        "created_at": "2014-04-23T17:14:15-03:00",
        "id": "6101C66D06564E3DB834BCE235A587A6",
        "identifier": "users",
        "important": null,
        "name": "Número de Usuários",
        "plan_id": "593C92165AF44493B65DE17A216C76D6",
        "position": 1,
        "updated_at": "2014-04-23T17:14:15-03:00",
        "value": 10
    }]
}

PATH PARAMS

identifier

string

OBRIGATÓRIO

Identificador do plano

 

 

 

SUGERIR EDIÇÃO

Listar Planos

Retorna uma lista com todos os planos em sua conta ordenadas pela data de Criação, sendo o primeiro o criado mais recentemente. O campo totalItems contém sempre a quantidade de planos cadastrados, independente dos parâmetros de pesquisa utilizados e o resultado da pesquisa fica sempre dentro de items.

 

 Testar

gethttps://api.iugu.com/v1/plans

curl --request GET \
  --url https://api.iugu.com/v1/plans
{
    "totalItems": 1,
    "items": [{
        "id": "593C92165AF44493B65DE17A216C76D6",
        "name": "Plano Básico",
        "identifier": "basic_plan",
        "interval": 1,
        "interval_type": "months",
        "created_at": "2014-04-23T17:14:15-03:00",
        "updated_at": "2014-04-23T17:19:46-03:00",
        "prices": [{
            "created_at": "2014-04-23T17:14:15-03:00",
            "currency": "BRL",
            "id": "F465EE77AC424DA2B075133C96FF10CA",
            "updated_at": "2014-04-23T17:14:15-03:00",
            "value_cents": 1000
        }]
    }]
}

QUERY PARAMS

limit

int32

Limita em até 1.000 o número de registros listados. Caso não seja enviado, aplica-se o limite padrão de 100 registros

 

start

int32

Quantos registros pular do início da pesquisa (muito utilizado para paginação)

 

query

string

Neste parâmetro pode ser passado um texto para pesquisa

 

updated_since

date

Registros atualizados desde o valor passado no parâmetro

 

sortBy

object

Um hash sendo a chave o nome do campo para ordenação e o valor sendo DESC ou ASC para descendente e ascendente, respectivamente. ex1: sortBy[updated_since]=ASC

 

 

 

SUGERIR EDIÇÃO

Criar Assinatura

Cria uma Assinatura.

 

 Testar

posthttps://api.iugu.com/v1/subscriptions

curl --request POST \
  --url https://api.iugu.com/v1/subscriptions
{
    "id": "ECF36F9AAF374D76A48646EDE8FE806D",
    "suspended": false,
    "plan_identifier": "id1",
    "price_cents": 200,
    "currency": "BRL",
    "features": {
        "feat": {
            "name": "Feature",
            "value": 0
        }
    },
    "expires_at": null,
    "created_at": "2013-11-19T11:24:29-02:00",
    "updated_at": "2013-11-19T11:24:43-02:00",
    "customer_name": "Nome do Cliente",
    "customer_email": "email@email.com",
    "cycled_at": null,
    "credits_min": 0,
    "credits_cycle": null,
    "customer_id": "FF3149CE52CB4A789925F154B489BFDD",
    "plan_name": "plan1",
    "customer_ref": "Nome do Cliente",
    "plan_ref": "plan1",
    "active": true,
    "in_trial": null,
    "credits": 0,
    "credits_based": false,
    "recent_invoices": null,
    "subitems": [{
        "id": "6D518D88B33F48FEA8964D5573E220D3",
        "description": "Item um",
        "quantity": 1,
        "price_cents": 1000,
        "price": "R$ 10,00",
        "total": "R$ 10,00"
    }],
    "logs": [{
        "id": "477388CC4C024520B552641724A62970",
        "description": "Fatura criada",
        "notes": "Fatura criada 1x Ativação de Assinatura: plan1 = R$ 2,00;1x Item um = R$ 10,00;",
        "created_at": "2013-11-19T11:24:43-02:00"
    }, {
        "id": "706436F169CE465B806163964A25400A",
        "description": "Assinatura Criada",
        "notes": "Assinatura Criada",
        "created_at": "2013-11-19T11:24:29-02:00"
    }],
    "custom_variables":[]
}

BODY PARAMS

plan_identifier

string

Identificador do Plano. Só é enviado para assinaturas que não são credits_based

 

customer_id

string

OBRIGATÓRIO

ID do Cliente

 

expires_at

date

Data de Expiração "DD-MM-AAAA". (Data da primeira cobrança, as próximas datas de cobrança dependem do "intervalo" do plano vinculado).

 

only_on_charge_success

boolean

Apenas Cria a Assinatura se a Cobrança for bem sucedida. Isso só funciona caso o cliente já tenha uma forma de pagamento padrão cadastrada. Não enviar "expires_at".

truefalse

ignore_due_email

boolean

Desabilita o envio de emails notificando o vencimento de uma fatura em assinaturas que podem ser pagas com boleto bancário

truefalse

payable_with

string

Método de pagamento que será disponibilizado para as Faturas desta Assinatura (all, credit_card ou bank_slip). Obs: Dependendo do valor, este atributo será herdado, pois a prioridade é herdar o valor atribuído ao Plano desta Assinatura; caso este esteja atribuído o valor ‘all’, o sistema considerará o payable_with da Assinatura; se não, o sistema considerará o payable_with do Plano

 

credits_based

boolean

É uma assinatura baseada em créditos? booleano

truefalse

price_cents

int32

Preço em centavos da recarga para assinaturas baseadas em crédito

 

credits_cycle

int32

Quantidade de créditos adicionados a cada ciclo, só enviado para assinaturas credits_based

 

credits_min

int32

Quantidade de créditos que ativa o ciclo, por ex: Efetuar cobrança cada vez que a assinatura tenha apenas 1 crédito sobrando. Esse 1 crédito é o credits_min

 

subitems

array of objects

Adiciona itens de cobrança a mais na assinatura do cliente. "price_cents" valor mínimo 100.

description

price_cents

quantity

recurrent

truefalse

Add ObjectEdit Array JSONcustom_variables

array of objects

Variáveis Personalizadas

name

value

Add ObjectEdit Array JSON

 

 

SUGERIR EDIÇÃO

Ativar Assinatura

Ativa uma Assinatura. Uma Fatura poderá ser gerada para o cliente.

 

 Testar

posthttps://api.iugu.com/v1/subscriptions/id/activate

curl --request POST \
  --url https://api.iugu.com/v1/subscriptions/id/activate
{
    "id": "ECF36F9AAF374D76A48646EDE8FE806D",
    "suspended": false,
    "plan_identifier": "id1",
    "price_cents": 200,
    "currency": "BRL",
    "features": {
        "feat": {
            "name": "Feature",
            "value": 0
        }
    },
    "expires_at": null,
    "created_at": "2013-11-19T11:24:29-02:00",
    "updated_at": "2013-11-19T11:24:43-02:00",
    "customer_name": "Nome do Cliente",
    "customer_email": "email@email.com",
    "cycled_at": null,
    "credits_min": 0,
    "credits_cycle": null,
    "customer_id": "FF3149CE52CB4A789925F154B489BFDD",
    "plan_name": "plan1",
    "customer_ref": "Nome do Cliente",
    "plan_ref": "plan1",
    "active": true,
    "in_trial": null,
    "credits": 0,
    "credits_based": false,
    "recent_invoices": null,
    "subitems": [{
        "id": "6D518D88B33F48FEA8964D5573E220D3",
        "description": "Item um",
        "quantity": 1,
        "price_cents": 1000,
        "price": "R$ 10,00",
        "total": "R$ 10,00"
    }],
    "logs": [{
        "id": "477388CC4C024520B552641724A62970",
        "description": "Fatura criada",
        "notes": "Fatura criada 1x Ativação de Assinatura: plan1 = R$ 2,00;1x Item um = R$ 10,00;",
        "created_at": "2013-11-19T11:24:43-02:00"
    }, {
        "id": "706436F169CE465B806163964A25400A",
        "description": "Assinatura Criada",
        "notes": "Assinatura Criada",
        "created_at": "2013-11-19T11:24:29-02:00"
    }],
    "custom_variables":[]
}

PATH PARAMS

id

string

OBRIGATÓRIO

ID da Assinatura

 

 

 

SUGERIR EDIÇÃO

Suspender Assinatura

Suspende uma Assinatura.

 

 Testar

posthttps://api.iugu.com/v1/subscriptions/id/suspend

curl --request POST \
  --url https://api.iugu.com/v1/subscriptions/id/suspend
{
    "id": "ECF36F9AAF374D76A48646EDE8FE806D",
    "suspended": true,
    "plan_identifier": "id1",
    "price_cents": 200,
    "currency": "BRL",
    "features": {
        "feat": {
            "name": "Feature",
            "value": 0
        }
    },
    "expires_at": null,
    "created_at": "2013-11-19T11:24:29-02:00",
    "updated_at": "2013-11-19T11:24:43-02:00",
    "customer_name": "Nome do Cliente",
    "customer_email": "email@email.com",
    "cycled_at": null,
    "credits_min": 0,
    "credits_cycle": null,
    "customer_id": "FF3149CE52CB4A789925F154B489BFDD",
    "plan_name": "plan1",
    "customer_ref": "Nome do Cliente",
    "plan_ref": "plan1",
    "active": true,
    "in_trial": null,
    "credits": 0,
    "credits_based": false,
    "recent_invoices": null,
    "subitems": [{
        "id": "6D518D88B33F48FEA8964D5573E220D3",
        "description": "Item um",
        "quantity": 1,
        "price_cents": 1000,
        "price": "R$ 10,00",
        "total": "R$ 10,00"
    }],
    "logs": [{
        "id": "477388CC4C024520B552641724A62970",
        "description": "Fatura criada",
        "notes": "Fatura criada 1x Ativação de Assinatura: plan1 = R$ 2,00;1x Item um = R$ 10,00;",
        "created_at": "2013-11-19T11:24:43-02:00"
    }, {
        "id": "706436F169CE465B806163964A25400A",
        "description": "Assinatura Criada",
        "notes": "Assinatura Criada",
        "created_at": "2013-11-19T11:24:29-02:00"
    }],
    "custom_variables":[]
}

PATH PARAMS

id

string

OBRIGATÓRIO

ID da Assinatura

 

 

 

SUGERIR EDIÇÃO

Alterar Assinatura

Altera os dados de uma Assinatura, quaisquer parâmetros não informados não serão alterados.

 

 Testar

puthttps://api.iugu.com/v1/subscriptions/id

curl --request PUT \
  --url https://api.iugu.com/v1/subscriptions/id
{
    "id": "ECF36F9AAF374D76A48646EDE8FE806D",
    "suspended": true,
    "plan_identifier": "id1",
    "price_cents": 200,
    "currency": "BRL",
    "features": {
        "feat": {
            "name": "Feature",
            "value": 0
        }
    },
    "expires_at": null,
    "created_at": "2013-11-19T11:24:29-02:00",
    "updated_at": "2013-11-19T11:24:43-02:00",
    "customer_name": "Nome do Cliente",
    "customer_email": "email@email.com",
    "cycled_at": null,
    "credits_min": 0,
    "credits_cycle": null,
    "customer_id": "FF3149CE52CB4A789925F154B489BFDD",
    "plan_name": "plan1",
    "customer_ref": "Nome do Cliente",
    "plan_ref": "plan1",
    "active": true,
    "in_trial": null,
    "credits": 0,
    "credits_based": false,
    "recent_invoices": null,
    "subitems": [{
        "id": "6D518D88B33F48FEA8964D5573E220D3",
        "description": "Item um",
        "quantity": 1,
        "price_cents": 1000,
        "price": "R$ 10,00",
        "total": "R$ 10,00"
    }],
    "logs": [{
        "id": "477388CC4C024520B552641724A62970",
        "description": "Fatura criada",
        "notes": "Fatura criada 1x Ativação de Assinatura: plan1 = R$ 2,00;1x Item um = R$ 10,00;",
        "created_at": "2013-11-19T11:24:43-02:00"
    }, {
        "id": "706436F169CE465B806163964A25400A",
        "description": "Assinatura Criada",
        "notes": "Assinatura Criada",
        "created_at": "2013-11-19T11:24:29-02:00"
    }],
    "custom_variables":[]
}

PATH PARAMS

id

string

OBRIGATÓRIO

 

BODY PARAMS

plan_identifier

string

Identificador do Plano. Só é enviado para assinaturas que não são credits_based

 

expires_at

date

Data de Expiração (Também é a data da próxima cobrança)

 

payable_with

string

Método de pagamento que será disponibilizado para as Faturas desta Assinatura (all, credit_card ou bank_slip). Obs: Dependendo do valor, este atributo será herdado, pois a prioridade é herdar o valor atribuído ao Plano desta Assinatura; caso este esteja atribuído o valor ‘all’, o sistema considerará o payable_with da Assinatura; se não, o sistema considerará o payable_with do Plano

 

ignore_due_email

boolean

Desabilita o envio de emails notificando o vencimento de uma fatura em assinaturas que podem ser pagas com boleto bancário.

truefalse

credits_based

boolean

É uma assinatura baseada em créditos? booleano

truefalse

price_cents

int32

Preço em centavos da recarga para assinaturas baseadas em crédito

 

credits_cycle

int32

Quantidade de créditos adicionados a cada ciclo, só enviado para assinaturas credits_based

 

credits_min

int32

Quantidade de créditos que ativa o ciclo, por ex: Efetuar cobrança cada vez que a assinatura tenha apenas 1 crédito sobrando. Esse 1 crédito é o credits_min

 

subitems

array of objects

Adiciona itens de cobrança a mais na assinatura do cliente. "price_cents" valor mínimo 100. Para remover, envie "id" do subitem + "_destroy:true"

id

_destroy

truefalse

description

price_cents

quantity

recurrent

truefalse

Add ObjectEdit Array JSONsuspended

boolean

Assinatura suspensa? booleano

truefalse

skip_charge

boolean

Ignorar Cobrança? booleano

truefalse

custom_variables

array of objects

Variáveis Personalizadas

name

value

Add ObjectEdit Array JSON

 

 

SUGERIR EDIÇÃO

Simular Alteração de Plano de Assinatura

Simula a alteração de plano de uma assinatura.

 

 Testar

gethttps://api.iugu.com/v1/subscriptions/id/change_plan_simulation/plan_identifier

curl --request GET \
  --url https://api.iugu.com/v1/subscriptions/id/change_plan_simulation/plan_identifier
{
  "cost": 19990,
  "discount": 0,
  "cycles": 1,
  "expires_at": "2016-08-25",
  "new_plan": "id2",
  "old_plan": "id1"
}

PATH PARAMS

id

string

OBRIGATÓRIO

ID da Assinatura

 

plan_identifier

string

OBRIGATÓRIO

Identificador do Plano

 

 

 

SUGERIR EDIÇÃO

Alterar Plano da Assinatura

Altera o Plano de uma Assinatura. Uma Fatura cobrando a mudança de plano poderá ser gerada para o cliente.

 

 Testar

posthttps://api.iugu.com/v1/subscriptions/id/change_plan/plan_identifier

curl --request POST \
  --url https://api.iugu.com/v1/subscriptions/id/change_plan/plan_identifier
{
    "id": "ECF36F9AAF374D76A48646EDE8FE806D",
    "suspended": false,
    "plan_identifier": "id2",
    "price_cents": 200,
    "currency": "BRL",
    "features": {
        "feat": {
            "name": "Feature",
            "value": 10
        }
    },
    "expires_at": null,
    "created_at": "2013-11-19T11:24:29-02:00",
    "updated_at": "2013-11-19T11:24:43-02:00",
    "customer_name": "Nome do Cliente",
    "customer_email": "email@email.com",
    "cycled_at": null,
    "credits_min": 0,
    "credits_cycle": null,
    "customer_id": "FF3149CE52CB4A789925F154B489BFDD",
    "plan_name": "plan1",
    "customer_ref": "Nome do Cliente",
    "plan_ref": "plan1",
    "active": true,
    "in_trial": null,
    "credits": 0,
    "credits_based": false,
    "recent_invoices": null,
    "subitems": [{
        "id": "6D518D88B33F48FEA8964D5573E220D3",
        "description": "Item um",
        "quantity": 1,
        "price_cents": 1000,
        "price": "R$ 10,00",
        "total": "R$ 10,00"
    }],
    "logs": [{
        "id": "477388CC4C024520B552641724A62970",
        "description": "Fatura criada",
        "notes": "Fatura criada 1x Ativação de Assinatura: plan1 = R$ 2,00;1x Item um = R$ 10,00;",
        "created_at": "2013-11-19T11:24:43-02:00"
    }, {
        "id": "706436F169CE465B806163964A25400A",
        "description": "Assinatura Criada",
        "notes": "Assinatura Criada",
        "created_at": "2013-11-19T11:24:29-02:00"
    }],
    "custom_variables":[]
}

PATH PARAMS

id

string

OBRIGATÓRIO

ID da Assinatura

 

plan_identifier

string

OBRIGATÓRIO

Identificador do Plano

 

 

 

SUGERIR EDIÇÃO

Adicionar Créditos a Assinatura

Adiciona créditos a uma assinatura.

 

 Testar

puthttps://api.iugu.com/v1/subscriptions/id/add_credits

curl --request PUT \
  --url https://api.iugu.com/v1/subscriptions/id/add_credits
{
    "id": "ECF36F9AAF374D76A48646EDE8FE806D",
    "suspended": false,
    "plan_identifier": "id2",
    "price_cents": 200,
    "currency": "BRL",
    "features": {
        "feat": {
            "name": "Feature",
            "value": 10
        }
    },
    "expires_at": null,
    "created_at": "2013-11-19T11:24:29-02:00",
    "updated_at": "2013-11-19T11:24:43-02:00",
    "customer_name": "Nome do Cliente",
    "customer_email": "email@email.com",
    "cycled_at": null,
    "credits_min": 0,
    "credits_cycle": null,
    "customer_id": "FF3149CE52CB4A789925F154B489BFDD",
    "plan_name": "plan1",
    "customer_ref": "Nome do Cliente",
    "plan_ref": "plan1",
    "active": true,
    "in_trial": null,
    "credits": 10,
    "credits_based": false,
    "recent_invoices": null,
    "subitems": [{
        "id": "6D518D88B33F48FEA8964D5573E220D3",
        "description": "Item um",
        "quantity": 1,
        "price_cents": 1000,
        "price": "R$ 10,00",
        "total": "R$ 10,00"
    }],
    "logs": [{
        "id": "477388CC4C024520B552641724A62970",
        "description": "Fatura criada",
        "notes": "Fatura criada 1x Ativação de Assinatura: plan1 = R$ 2,00;1x Item um = R$ 10,00;", 
        "created_at": "2013-11-19T11:24:43-02:00"
    }, {
        "id": "706436F169CE465B806163964A25400A",
        "description": "Assinatura Criada",
        "notes": "Assinatura Criada",
        "created_at": "2013-11-19T11:24:29-02:00"
    }],
    "custom_variables":[]
}

PATH PARAMS

id

string

OBRIGATÓRIO

 

BODY PARAMS

quantity

int32

Quantidade de créditos a adicionar

 

 

 

SUGERIR EDIÇÃO

Remover Créditos da Assinatura

Adiciona créditos a uma assinatura.

 

 Testar

puthttps://api.iugu.com/v1/subscriptions/id/remove_credits

curl --request PUT \
  --url https://api.iugu.com/v1/subscriptions/id/remove_credits
{
    "id": "ECF36F9AAF374D76A48646EDE8FE806D",
    "suspended": false,
    "plan_identifier": "id2",
    "price_cents": 200,
    "currency": "BRL",
    "features": {
        "feat": {
            "name": "Feature",
            "value": 10
        }
    },
    "expires_at": null,
    "created_at": "2013-11-19T11:24:29-02:00",
    "updated_at": "2013-11-19T11:24:43-02:00",
    "customer_name": "Nome do Cliente",
    "customer_email": "email@email.com",
    "cycled_at": null,
    "credits_min": 0,
    "credits_cycle": null,
    "customer_id": "FF3149CE52CB4A789925F154B489BFDD",
    "plan_name": "plan1",
    "customer_ref": "Nome do Cliente",
    "plan_ref": "plan1",
    "active": true,
    "in_trial": null,
    "credits": 5,
    "credits_based": false,
    "recent_invoices": null,
    "subitems": [{
        "id": "6D518D88B33F48FEA8964D5573E220D3",
        "description": "Item um",
        "quantity": 1,
        "price_cents": 1000,
        "price": "R$ 10,00",
        "total": "R$ 10,00"
    }],
    "logs": [{
        "id": "477388CC4C024520B552641724A62970",
        "description": "Fatura criada",
        "notes": "Fatura criada 1x Ativação de Assinatura: plan1 = R$ 2,00;1x Item um = R$ 10,00;",
        "created_at": "2013-11-19T11:24:43-02:00"
    }, {
        "id": "706436F169CE465B806163964A25400A",
        "description": "Assinatura Criada",
        "notes": "Assinatura Criada",
        "created_at": "2013-11-19T11:24:29-02:00"
    }],
    "custom_variables":[]
}

PATH PARAMS

id

string

OBRIGATÓRIO

 

BODY PARAMS

quantity

int32

Quantidade de créditos a adicionar

 

 

 

SUGERIR EDIÇÃO

Remover Assinatura

Remove uma Assinatura permanentemente.

 

 Testar

deletehttps://api.iugu.com/v1/subscriptions/id

curl --request DELETE \
  --url https://api.iugu.com/v1/subscriptions/id
{
    "id": "ECF36F9AAF374D76A48646EDE8FE806D",
    "suspended": true,
    "plan_identifier": "id1",
    "price_cents": 200,
    "currency": "BRL",
    "features": {
        "feat": {
            "name": "Feature",
            "value": 0
        }
    },
    "expires_at": null,
    "created_at": "2013-11-19T11:24:29-02:00",
    "updated_at": "2013-11-19T11:24:43-02:00",
    "customer_name": "Nome do Cliente",
    "customer_email": "email@email.com",
    "cycled_at": null,
    "credits_min": 0,
    "credits_cycle": null,
    "customer_id": "FF3149CE52CB4A789925F154B489BFDD",
    "plan_name": "plan1",
    "customer_ref": "Nome do Cliente",
    "plan_ref": "plan1",
    "active": true,
    "in_trial": null,
    "credits": 0,
    "credits_based": false,
    "recent_invoices": null,
    "subitems": [{
        "id": "6D518D88B33F48FEA8964D5573E220D3",
        "description": "Item um",
        "quantity": 1,
        "price_cents": 1000,
        "price": "R$ 10,00",
        "total": "R$ 10,00"
    }],
    "logs": [{
        "id": "477388CC4C024520B552641724A62970",
        "description": "Fatura criada",
        "notes": "Fatura criada 1x Ativação de Assinatura: plan1 = R$ 2,00;1x Item um = R$ 10,00;",
        "created_at": "2013-11-19T11:24:43-02:00"
    }, {
        "id": "706436F169CE465B806163964A25400A",
        "description": "Assinatura Criada",
        "notes": "Assinatura Criada",
        "created_at": "2013-11-19T11:24:29-02:00"
    }],
    "custom_variables":[]
}

PATH PARAMS

id

string

OBRIGATÓRIO

ID da Assinatura

 

 

 

SUGERIR EDIÇÃO

Buscar Assinatura

Retorna os dados de uma Assinatura.

 

 Testar

gethttps://api.iugu.com/v1/subscriptions/id

curl --request GET \
  --url https://api.iugu.com/v1/subscriptions/id
{
    "id": "ECF36F9AAF374D76A48646EDE8FE806D",
    "suspended": false,
    "plan_identifier": "id1",
    "price_cents": 200,
    "currency": "BRL",
    "features": {
        "feat": {
            "name": "Feature",
            "value": 0
        }
    },
    "expires_at": null,
    "created_at": "2013-11-19T11:24:29-02:00",
    "updated_at": "2013-11-19T11:24:43-02:00",
    "customer_name": "Nome do Cliente",
    "customer_email": "email@email.com",
    "cycled_at": null,
    "credits_min": 0,
    "credits_cycle": null,
    "customer_id": "FF3149CE52CB4A789925F154B489BFDD",
    "plan_name": "plan1",
    "customer_ref": "Nome do Cliente",
    "plan_ref": "plan1",
    "active": true,
    "in_trial": null,
    "credits": 0,
    "credits_based": false,
    "recent_invoices": null,
    "subitems": [{
        "id": "6D518D88B33F48FEA8964D5573E220D3",
        "description": "Item um",
        "quantity": 1,
        "price_cents": 1000,
        "price": "R$ 10,00",
        "total": "R$ 10,00"
    }],
    "logs": [{
        "id": "477388CC4C024520B552641724A62970",
        "description": "Fatura criada",
        "notes": "Fatura criada 1x Ativação de Assinatura: plan1 = R$ 2,00;1x Item um = R$ 10,00;",
        "created_at": "2013-11-19T11:24:43-02:00"
    }, {
        "id": "706436F169CE465B806163964A25400A",
        "description": "Assinatura Criada",
        "notes": "Assinatura Criada",
        "created_at": "2013-11-19T11:24:29-02:00"
    }],
    "custom_variables":[]
}

PATH PARAMS

id

string

OBRIGATÓRIO

ID da Assinatura

 

 

 

SUGERIR EDIÇÃO

Listar Assinaturas

Retorna uma lista com as assinaturas geradas pela sua conta, ordenadas pela data de criação, da mais nova para a mais antiga. O nó totalItems retorna sempre a quantidade total de assinaturas cadastradas, independentemente dos parâmetros de pesquisa utilizados, e o resultado da pesquisa fica sempre dentro de items. Por padrão, retorna no máximo 100 itens.

 

 Testar

gethttps://api.iugu.com/v1/subscriptions

curl --request GET \
  --url https://api.iugu.com/v1/subscriptions
{
    "facets": {
        "suspended": {
            "_type": "filter",
            "count": 1
        },
        "active": {
            "_type": "filter",
            "count": 1
        },
        "due": {
            "_type": "filter",
            "count": 1
        }
    },
    "totalItems": 3,
    "items": [{
        "id": "ECF36F9AAF374D76A48646EDE8FE806D",
        "suspended": false,
        "plan_identifier": "id2",
        "price_cents": 200,
        "currency": "BRL",
        "features": {
            "feat": {
                "name": "Feature",
                "value": 10
            }
        },
        "expires_at": null,
        "created_at": "2013-11-19T11:24:29-02:00",
        "updated_at": "2013-11-19T11:24:43-02:00",
        "customer_name": "Nome do Cliente",
        "customer_email": "email@email.com",
        "cycled_at": null,
        "customer_id": "FF3149CE52CB4A789925F154B489BFDD",
        "plan_name": "plan1",
        "customer_ref": "Nome do Cliente",
        "plan_ref": "plan1",
        "active": true,
        "in_trial": null,
        "recent_invoices": null,
        "subitems": [{
            "id": "6D518D88B33F48FEA8964D5573E220D3",
            "description": "Item um",
            "quantity": 1,
            "price_cents": 1000,
            "price": "R$ 10,00",
            "total": "R$ 10,00"
        }],
        "logs": [{
            "id": "477388CC4C024520B552641724A62970",
            "description": "Fatura criada",
            "notes": "Fatura criada 1x Ativação de Assinatura: plan1 = R$ 2,00;1x Item um = R$ 10,00;",
            "created_at": "2013-11-19T11:24:43-02:00"
        }, {
            "id": "706436F169CE465B806163964A25400A",
            "description": "Assinatura Criada",
            "notes": "Assinatura Criada",
            "created_at": "2013-11-19T11:24:29-02:00"
        }]
    }, {
        "id": "ECF36F9AAF374D76A48646EDE8FE806D",
        "suspended": false,
        "plan_identifier": "id2",
        "price_cents": 200,
        "currency": "BRL",
        "features": {
            "feat": {
                "name": "Feature",
                "value": 10
            }
        },
        "expires_at": null,
        "created_at": "2013-11-19T11:24:29-02:00",
        "updated_at": "2013-11-19T11:24:43-02:00",
        "customer_name": "Nome do Cliente",
        "customer_email": "email@email.com",
        "cycled_at": null,
        "customer_id": "FF3149CE52CB4A789925F154B489BFDD",
        "plan_name": "plan1",
        "customer_ref": "Nome do Cliente",
        "plan_ref": "plan1",
        "active": true,
        "in_trial": null,
        "recent_invoices": null,
        "subitems": [{
            "id": "6D518D88B33F48FEA8964D5573E220D3",
            "description": "Item um",
            "quantity": 1,
            "price_cents": 1000,
            "price": "R$ 10,00",
            "total": "R$ 10,00"
        }],
        "logs": [{
            "id": "477388CC4C024520B552641724A62970",
            "description": "Fatura criada",
            "notes": "Fatura criada 1x Ativação de Assinatura: plan1 = R$ 2,00;1x Item um = R$ 10,00;",
            "created_at": "2013-11-19T11:24:43-02:00"
        }, {
            "id": "706436F169CE465B806163964A25400A",
            "description": "Assinatura Criada",
            "notes": "Assinatura Criada",
            "created_at": "2013-11-19T11:24:29-02:00"
        }]
    }, {
        "id": "ECF36F9AAF374D76A48646EDE8FE806D",
        "suspended": false,
        "plan_identifier": "id2",
        "price_cents": 200,
        "currency": "BRL",
        "features": {
            "feat": {
                "name": "Feature",
                "value": 10
            }
        },
        "expires_at": null,
        "created_at": "2013-11-19T11:24:29-02:00",
        "updated_at": "2013-11-19T11:24:43-02:00",
        "customer_name": "Nome do Cliente",
        "customer_email": "email@email.com",
        "cycled_at": null,
        "customer_id": "FF3149CE52CB4A789925F154B489BFDD",
        "plan_name": "plan1",
        "customer_ref": "Nome do Cliente",
        "plan_ref": "plan1",
        "active": true,
        "in_trial": null,
        "recent_invoices": null,
        "subitems": [{
            "id": "6D518D88B33F48FEA8964D5573E220D3",
            "description": "Item um",
            "quantity": 1,
            "price_cents": 1000,
            "price": "R$ 10,00",
            "total": "R$ 10,00"
        }],
        "logs": [{
            "id": "477388CC4C024520B552641724A62970",
            "description": "Fatura criada",
            "notes": "Fatura criada 1x Ativação de Assinatura: plan1 = R$ 2,00;1x Item um = R$ 10,00;",
            "created_at": "2013-11-19T11:24:43-02:00"
        }, {
            "id": "706436F169CE465B806163964A25400A",
            "description": "Assinatura Criada",
            "notes": "Assinatura Criada",
            "created_at": "2013-11-19T11:24:29-02:00"
        }]
    }]
}

QUERY PARAMS

limit

int32

Limita em até 100 o número de registros listados.

 

start

int32

Quantos registros pular do início da pesquisa, utilizado para paginação

 

created_at_from

date

Registros criados a partir do momento passado no parâmetro

 

created_at_to

date

Registros criados até o momento passado no parâmetro

 

query

string

Texto para pesquisa

 

updated_since

date

Registros atualizados desde o momento passado no parâmetro

 

sortBy

object

Um hash sendo a chave o nome do campo para ordenação e o valor sendo DESC ou ASC para descendente e ascendente, respectivamente. ex1: sortBy[created_at_to]=ASC ex2: sortBy[created_at_to]=DESC

 

customer_id

string

ID do Cliente

 

status_filter

string

Usado para filtrar as assinaturas pelo status (due, active, suspended)

 

 

 

SUGERIR EDIÇÃO

Transferir Valor

Transfere um determinado valor de sua conta para a conta destino.

 

 Testar

posthttps://api.iugu.com/v1/transfers

curl --request POST \
  --url https://api.iugu.com/v1/transfers
{
    "id": "1234565F6F06412345ED425581234567",
    "created_at": "2013-11-19T11:24:29-02:00",
    "amount_cents": "1000",
    "amount_localized": "R$ 10,00",
    "receiver": {
      "id": "77C2565F6F064A26ABED4255894224F0",
      "name": "Nome da Conta" 
    },
    "custom_variables": [{
        "name": "nome_da_variavel",
        "value": "valor_da_variavel"
    }]
}

BODY PARAMS

receiver_id

string

Account ID da conta que irá receber o valor

 

amount_cents

int32

Valor a transferir em centavos

 

custom_variables

array of objects

Variáveis Personalizadas

name

value

Add ObjectEdit Array JSON

 

 

SUGERIR EDIÇÃO

Buscar Transferência

Retorna as informações de uma transferência de valores.

 

 Testar

gethttps://api.iugu.com/v1/transfers/id

curl --request GET \
  --url https://api.iugu.com/v1/transfers/id
{
    "id": "1234565F6F06412345ED425581234567",
    "created_at": "2013-11-19T11:24:29-02:00",
    "amount_cents": "1000",
    "amount_localized": "R$ 10,00",
    "receiver": {
      "id": "77C2565F6F064A26ABED4255894224F0",
      "name": "Nome da Conta" 
    },
    "custom_variables": [{
        "name": "nome_da_variavel",
        "value": "valor_da_variavel"
    }]
}

PATH PARAMS

id

string

OBRIGATÓRIO

ID da transferência

 

 

 

SUGERIR EDIÇÃO

Listar Transferências

Retorna uma lista com as transferências efetuadas pela conta. Por padrão, retorna no máximo 100 registros.

 

 Testar

gethttps://api.iugu.com/v1/transfers

curl --request GET \
  --url https://api.iugu.com/v1/transfers
{
    "sent": [
    {
      "id": "1234565F6F06412345ED425581234567",
      "created_at": "2013-11-19T11:24:29-02:00",
      "amount_cents": "1000",
      "amount_localized": "R$ 10,00",
      "receiver": {
        "id": "77C2565F6F064A26ABED4255894224F0",
        "name": "Nome da Conta"
      }
    }
  ],
  "received": [
    {
      "id": "1234565F6F06132345ED425581234567",
      "created_at": "2013-12-19T11:24:29-02:00",
      "amount_cents": "2000",
      "amount_localized": "R$ 20,00",
      "sender": {
        "id": "77C2565F6F0611111BED4255894224F0",
        "name": "Conta Teste"
      }
    }
  ]
}

QUERY PARAMS

custom_variables_name

string

Filtra as transferências bancárias pelo nome da variável customizada

 

custom_variables_value

string

Filtra as transferências bancárias pelo valor da variável customizada

 

limit

int32

Limita em até 100 o número de registros listados, usado para paginação.

 

start

int32

Quantos registros pular do início da pesquisa, usado para paginação.

 

 

 

SUGERIR EDIÇÃO

Criar subconta

Permite a criação de subcontas (contas de pagamento) para contas com permissão de marketplace ou parceiro de negócios.

 

Atenção!

Salve os dados de retorno em seu banco de dados, principalmente o user_token, usado como api_token para autenticar as chamadas da API nas subcontas.

 

 

Cuidado

Subcontas NÃO podem ser excluídas.

 

 

 Testar

posthttps://api.iugu.com/v1/marketplace/create_account

curl --request POST \
  --url https://api.iugu.com/v1/marketplace/create_account
{
    "account_id": "49196DF60BC64B6EB42DEC9C5D81C2CC",
    "name": "Subconta",
    "live_api_token": "8c018fa32cbae33a47f0ec27f2e84d8c",
    "test_api_token": "aef793f12f6c67b93a4d39a4f42b7e98",
    "user_token": "1015cd6f9ddc96a357403f994f907cfd"
}

BODY PARAMS

name

string

Nome da subconta. Se não enviado, o ID da conta é utilizado por padrão.

 

commission_percent

string

Deprecado, ver comissions.percent. Porcentagem de comissão enviado para a conta que gerencia o marketplace (valor entre 0 e 70).

 

commissions

object

 

commissions.cents

integer

Valor em centavos.

 

commissions.percent

float

Valor em porcentagem.

 

commissions.credit_card_cents

integer

Valor em centavos a ser cobrado apenas em transações no cartão de crédito. Precisa do parâmetro cents acima configurado.

 

commissions.credit_card_percent

float

Valor em porcentagem a ser cobrado apenas em transações no cartão de crédito. Precisa do parâmetro percent acima configurado.

 

commissions.bank_slip_cents

integer

Valor em centavos a ser cobrado apenas em transações no boleto. Precisa do parâmetro cents acima configurado.

 

commissions.bank_slip_percent

float

Valor em porcentagem a ser cobrado apenas em transações no boleto. Precisa do parâmetro percent acima configurado.

 

 

 

SUGERIR EDIÇÃO

Configurar conta

Configura parâmetros de uma conta de pagamentos.

 

 Testar

posthttps://api.iugu.com/v1/accounts/configuration

curl --request POST \
  --url https://api.iugu.com/v1/accounts/configuration
{
    "id": "63C332E29A1B44B386991BF2A6B96D43",
    "name": "Conta Demo",
    "created_at": "2013-02-15T12:20:28-02:00",
    "updated_at": "2014-06-26T10:48:46-03:00",
    "can_receive?": true,
    "is_verified?": true,
    "last_verification_request_status": "accepted",
    "last_verification_request_data": null,
    "last_verification_request_feedback": null,
    "change_plan_type": 1,
    "subscriptions_trial_period": 0,
    "disable_emails": false,
    "last_withdraw": null,
    "total_subscriptions": 79,
    "reply_to": null,
    "webapp_on_test_mode": false,
    "marketplace": false,
    "default_return_url": "",
    "auto_withdraw": true,
    "balance": "R$ 0,00",
    "protected_balance": "R$ 0,00",
    "payable_balance": "R$ 0,00",
    "receivable_balance": "R$ 0,00",
    "commission_balance": "R$ 0,00",
    "volume_last_month": "R$ 804,20",
    "volume_this_month": "R$ 0,00",
    "taxes_paid_last_month": "R$ 46,57",
    "taxes_paid_this_month": "R$ 0,00",
    "custom_logo_url": null,
    "custom_logo_small_url": null,
    "informations": [{
        "key": "charge_limit",
        "value": "50000"
    }, {
        "key": "return_days",
        "value": "1"
    }, {
        "key": "account_type",
        "value": "Tipo da Conta"
    }, {
        "key": "bank",
        "value": "Banco"
    }, {
        "key": "commission_percent",
        "value": "1"
    }, {
        "key": "iugu_credit_card_percent_1",
        "value": "0.04"
    }, {
        "key": "automatic_transfer",
        "value": "true"
    }],
    "configuration": {
        "commission_percent": 1,
        "bank_slip": {
            "active": true,
            "extra_due": "1",
            "reprint_extra_due": "1"
        },
        "credit_card": {
            "active": true,
            "soft_descriptor": "TESTE",
            "installments": true,
            "installments_pass_interest": true,
            "max_installments": "12",
            "max_installments_without_interest": "2",
            "two_step_transaction": true
        }
    }
}

BODY PARAMS

commission_percent

string

Deprecado, ver comissions.percent. Percentual de comissionamento enviado para a conta que gerencia o marketplace (Valor entre 0 e 70)

 

commissions

object

 

commissions.cents

integer

Valor em centavos.

 

commissions.percent

float

Valor em porcentagem.

 

commissions.credit_card_cents

integer

Valor em centavos a ser cobrado apenas em transações no cartão de crédito. Precisa do parâmetro cents acima configurado.

 

commissions.credit_card_percent

float

Valor em porcentagem a ser cobrado apenas em transações no cartão de crédito. Precisa do parâmetro percent acima configurado.

 

commissions.bank_slip_cents

integer

Valor em centavos a ser cobrado apenas em transações no boleto. Precisa do parâmetro cents acima configurado.

 

commissions.bank_slip_percent

float

Valor em porcentagem a ser cobrado apenas em transações no boleto. Precisa do parâmetro percent acima configurado.

 

auto_withdraw

boolean

Saque automático?

truefalse

fines

boolean

Multas?

truefalse

per_day_interest

boolean

Juros de mora?

truefalse

late_payment_fine

int32

Valor da multa em % (Ex: 2)

 

auto_advance

boolean

Antecipação Automática. Só pode ser atribuído caso a conta tenha a funcionalidade de Novo Adiantamento habilitado (entre em contato com o Suporte para habilitar)

truefalse

auto_advance_type

string

Opções de Antecipação Automática. Obrigatório caso auto_advance seja true. Recebe os valores 'daily' (Antecipação diária), 'weekly' (Antecipação semanal, que ocorre no dia da semana determinado pelo usuário), 'monthly' (Antecipação mensal, que ocorre no dia do mês determinado pelo usuário) e 'days_after_payment' (Antecipação que ocorre em um número de dias após o pagamento especificado pelo usuário)

 

auto_advance_option

int32

Obrigatório caso auto_advance seja true e auto_advance_type diferente de 'daily'. Em caso de auto_advance_type = weekly, recebe valores de 0 a 6 (Número correspondente ao dia da semana que a antecipação será realizada, 0 para domingo, 1 para segunda e assim por diante). Em caso de auto_advance_type = monthly, recebe valores de 1 a 28 (Número correspondente ao dia do mês que a antecipação será realizada). Em caso de auto_advance_type = days_after_payment, recebe valores de 1 a 30 (Número de dias após o pagamento em que a antecipação será realizada)

 

bank_slip

object

Configurações de boleto bancário

 

bank_slip.active

boolean

Ativo?

truefalse

bank_slip.extra_due

integer

Dias de Vencimento Extras no Boleto (Ex: 2)

 

bank_slip.reprint_extra_due

integer

Dias de Vencimento Extras na 2a Via do Boleto (Ex: 1)

 

credit_card

object

Configurações de cartão de crédito

 

credit_card.active

boolean

Ativo?

truefalse

credit_card.soft_descriptor

string

Descrição que apareça na Fatura do Cartão do Cliente (Máx: 12 Caracteres)

 

credit_card.installments

boolean

Parcelamento ativo?

truefalse

credit_card.max_installments

integer

Número máximo de parcelas (Nr entre 1 a 12)

 

credit_card.max_installments_without_interest

integer

Número de parcelas sem cobrança de juros ao cliente (Nr entre 1 a 12). *somente contas antigas

 

credit_card.two_step_transaction

boolean

Habilita o fluxo de pagamento em duas etapas (Autorização e Captura)

truefalse

credit_card.installments_pass_interest

boolean

Repasse de Juros de Parcelamento ativo? *somente contas antigas

truefalse

payment_email_notification

boolean

boolean Ativa ou desativa a notificação de pagamento

truefalse

payment_email_notification_receiver

string

Email que deve receber as notificações de pagamento (Obrigatório caso payment_email_notification seja true)

 

early_payment_discount

boolean

Ativa ou desativa o desconto por pagamento antecipado

truefalse

early_payment_discounts

array of objects

Configuração do desconto a ser aplicado

days

percent

Add ObjectEdit Array JSON

 

 

SUGERIR EDIÇÃO

Atualizar subconta

Atualiza os parâmetros de uma conta de pagamentos.

IMPORTANTE: Para esta chamada, no lugar do token de API da conta (api_token), deve-se utilizar o token de usuário (user_token), gerado no retorno da chamada de criação de subconta.

 

 Testar

puthttps://api.iugu.com/v1/accounts/id

curl --request PUT \
  --url https://api.iugu.com/v1/accounts/id

Try the API to see results

PATH PARAMS

id

string

OBRIGATÓRIO

ID da conta a ser atualizada.

 

BODY PARAMS

name

string

Nome da conta.

 

subscriptions_billing_days

int32

Número de dias antes do vencimento da assinatura para criação da fatura referente ao próximo ciclo.

 

subscriptions_trial_period

int32

Duração (em dias) do período de testes de uma assinatura.

 

default_return_url

string

URL padrão para a qual direcionar o cliente após o pagamento de uma fatura via web.

 

owner_emails_to_notify

string

Lista de emails, separados por vígula, que devem receber notificações específicas para usuários com permissão de "dono".

 

 

 

SUGERIR EDIÇÃO

Enviar verificação de subconta

Permite enviar documentos para verificação de subcontas. Todas as subcontas devem ter sua documentação verificada para emitir faturas no modo de produção.

 

Atenção

Esta API obriga a utilização do user_token na autenticação da chamada. Prazo de aprovação: um dia útil.

 

 

Cuidado

No envio da verificação, é solicitado escolher entre conta PF ou PJ ("data.person_type").

Se person_type == "Pessoa Física", é OBRIGATÓRIO informar números válidos de CPF e de conta bancária PF vinculada ao CPF cadastrado.
Se person_type == "Pessoa Jurídica", é OBRIGATÓRIO informar números válidos de CNPJ válido e de conta bancária PJ vinculada ao CNPJ cadastrado.

 

 

 Testar

posthttps://api.iugu.com/v1/accounts/account_id/request_verification

curl --request POST \
  --url https://api.iugu.com/v1/accounts/account_id/request_verification
{
    "id": "EC696038CCCE456893568C886AEBFD4F",
    "data": {
        "price_range": "Subconta",
        "physical_products": "false",
        "business_type": "Serviços de Limpeza",
        "person_type": "Pessoa Física",
        "automatic_transfer": "true",
        "cpf": "123.123.123-12",
        "name": "Nome da Pessoa",
        "address": "Av. Paulista 320 cj 10",
        "cep": "01419-000",
        "city": "São Paulo",
        "state": "São Paulo",
        "telephone": "11-91231-1234",
        "bank": "Itaú",
        "bank_ag": "1234",
        "account_type": "Corrente",
        "bank_cc": "11231-2",
        "document_id": 1,
        "document_cpf": 2,
        "document_activity": 3
    },
    "account_id": "49196DF60BC64B6EB42DEC9C5D81C2CC",
    "created_at": "2014-03-14T11:12:18-03:00"
}

PATH PARAMS

account_id

string

OBRIGATÓRIO

ID da sub-conta

 

BODY PARAMS

data

object

 

data.price_range

string

OBRIGATÓRIO

Valor máximo da venda ('Até R$ 100,00', 'Entre R$ 100,00 e R$ 500,00', 'Mais que R$ 500,00')

 

data.physical_products

boolean

OBRIGATÓRIO

Vende produtos físicos?

truefalse

data.business_type

string

OBRIGATÓRIO

Descrição do negócio

 

data.person_type

string

OBRIGATÓRIO

'Pessoa Física' ou 'Pessoa Jurídica'

 

data.automatic_transfer

boolean

OBRIGATÓRIO

Saque automático (Recomendamos que envie 'true')

truefalse

data.cnpj

string

CNPJ caso Pessoa Jurídica

 

data.cpf

string

CPF caso Pessoa Física

 

data.company_name

string

Nome da Empresa, caso Pessoa Jurídica

 

data.name

string

Nome caso Pessoa Física

 

data.address

string

OBRIGATÓRIO

Endereço

 

data.cep

string

OBRIGATÓRIO

CEP

 

data.city

string

OBRIGATÓRIO

Cidade

 

data.state

string

OBRIGATÓRIO

Estado

 

data.telephone

string

OBRIGATÓRIO

Telefone

 

data.resp_name

string

OBRIGATÓRIO

Nome do Responsável, caso Pessoa Jurídica

 

data.resp_cpf

string

OBRIGATÓRIO

CPF do Responsável, caso Pessoa Jurídica

 

data.bank

string

OBRIGATÓRIO

'Itaú', 'Bradesco', 'Caixa Econômica', 'Banco do Brasil', 'Santander', 'Banrisul', 'Sicredi', 'Sicoob', 'Inter', 'BRB'

 

data.bank_ag

string

OBRIGATÓRIO

Agência da Conta

 

data.account_type

string

OBRIGATÓRIO

'Corrente', 'Poupança'

 

data.bank_cc

string

OBRIGATÓRIO

Número da Conta

 

files

object

Documentos para verificação. (opcional)

 

files.id

file

Multipart do Documento (RG, CPF)

files.cpf

file

Multipart do CPF (Caso não tenha CPF no id)

files.activity

file

Multipart de um documento que comprove a atividade exercida pela empresa/pessoa da conta

 

Com toda chamada deste endpoint, a iugu valida, por padrão, o dígito verificador das informações bancárias enviadas. Veja na tabela abaixo o formato padrão esperado:

Banco Agência Conta
Banco do Brasil 9999-D 99999999-D
Santander 9999 99999999-D
Caixa Econômica 9999 XXX99999999-D (X: Operação)
Bradesco 9999-D 9999999-D
Itaú 9999 99999-D
Banrisul 9999 999999999-D
Sicredi 9999 999999
Sicoob (Bancoob) 9999 999999999-D
Inter 9999 999999999-D
BRB 9999 999999999-D

 

SUGERIR EDIÇÃO

Informações da Conta

Retorna as informações de uma conta. Use o LIVE_API_TOKEN da sub-conta na autenticação.

 

 Testar

gethttps://api.iugu.com/v1/accounts/id

curl --request GET \
  --url https://api.iugu.com/v1/accounts/id
{
    "id": "49196DF60BC64B6EB42DEC9C5D81C2CC",
    "name": "Subconta",
    "created_at": "2014-03-14T07:57:24-03:00",
    "updated_at": "2014-03-14T07:57:25-03:00",
    "can_receive?": false,
    "is_verified?": false,
    "last_verification_request_status": "pending",
    "last_verification_request_data": {
        "price_range": "Subconta",
        "physical_products": "false",
        "business_type": "Serviços de Limpeza",
        "person_type": "Pessoa Física",
        "automatic_transfer": "true",
        "cpf": "123.123.123-12",
        "name": "Nome da Pessoa",
        "address": "Av. Paulista 320 cj 10",
        "cep": "01419-000",
        "city": "São Paulo",
        "state": "São Paulo",
        "telephone": "11-91231-1234",
        "bank": "Itaú",
        "bank_ag": "1234",
        "account_type": "Corrente",
        "bank_cc": "11231-2",
        "document_id": "1:ledermantel_art.png",
        "document_cpf": "2:ledermantel_art.png",
        "document_activity": "3:ledermantel_art.png"
    },
    "last_verification_request_feedback": null,
    "change_plan_type": 1,
    "subscriptions_trial_period": 0,
    "disable_emails": false,
    "last_withdraw": null,
    "total_subscriptions": 0,
    "reply_to": null,
    "webapp_on_test_mode": false,
    "marketplace": false,
    "auto_withdraw": false,
    "balance": "R$ 0,00",
    "balance_available_for_withdraw":"R$ 0,00",
    "balance_in_protest":"R$ 0,00",
    "protected_balance": "R$ 0,00",
    "payable_balance": "R$ 0,00",
    "receivable_balance": "R$ 0,00",
    "commission_balance": "R$ 0,00",
    "volume_last_month": "R$ 0,00",
    "volume_this_month": "R$ 0,00",
    "taxes_paid_last_month": "R$ 0,00",
    "taxes_paid_this_month": "R$ 0,00",
    "custom_logo_url": null,
    "custom_logo_small_url": null,
    "informations": [{
        "key": "commission_percent",
        "value": "10.0"
    }]
}

PATH PARAMS

id

string

OBRIGATÓRIO

ID da sub-conta

 

 

 

SUGERIR EDIÇÃO

Adicionar Domicílio Bancário

Envia dados para cadastrar ou alterar o domicílio bancário da conta que recebe saques e transferências.

 

Atenção

Informe uma conta bancária válida vinculada ao CPF/CNPJ cadastrado na verificação da subconta.
Não é possível receber valores em uma conta bancária que tenha um titular diferente do cadastrado na subconta.

 

 

 Testar

posthttps://api.iugu.com/v1/bank_verification

curl --request POST \
  --url https://api.iugu.com/v1/bank_verification
{
    "success": true
}

BODY PARAMS

agency

string

OBRIGATÓRIO

Agência Bancária

 

account

string

OBRIGATÓRIO

Nr da Conta

 

account_type

string

OBRIGATÓRIO

Tipo da Conta ("cc" para Conta Corrente e "cp" para Conta Poupança)

 

bank

string

OBRIGATÓRIO

Número do Banco. "001" -> Banco do Brasil | "033" -> Santander | "104" -> Caixa Econômica | "237" -> Bradesco | "341" -> Itaú | "041" -> Banrisul | "748" -> Sicredi | "756" -> Sicoob | "077" -> Inter | "070" -> BRB

 

document

file

Documento de Comprovação dos Dados Bancários (Enviar via multipart ou base64) - (envio opcional)

 

 

Formatação dos campos com automatic_validation

Banco Agência Conta
Banco do Brasil 9999-D 99999999-D
Santander 9999 99999999-D
Caixa Econômica 9999 XXX99999999-D (X: Operação)
Bradesco 9999-D 9999999-D
Itaú 9999 99999-D
Banrisul 9999 999999999-D
Sicredi 9999 999999
Sicoob 9999 999999999-D
Inter 9999 999999999-D
BRB 9999 999999999-D

 

SUGERIR EDIÇÃO

Verificar Envio de Domicilio Bancario

Consultar dados enviados para alterar domicílio bancário.

 

 Testar

gethttps://api.iugu.com/v1/bank_verification

curl --request GET \
  --url https://api.iugu.com/v1/bank_verification
[
  {
    "id": "F7D999A13D17459991A77456F061C3E0",
    "status": "pending",
    "created_at":"2017-10-05T14:31:32-03:00",
    "updated_at":"2017-10-05T14:31:32-03:00",
    "account": "1234567-8",
    "agency": "4321-0",
    "operation": null,
    "feedback": null,
    "bank": "Bradesco"
  },
  {
    "id": "7F26B51BFC5A4C09B18DCAB6805141BE",
    "status": "rejected",
    "created_at":"2016-11-29T08:59:25-02:00",
    "updated_at":"2016-11-29T09:00:56-02:00",
    "account": "1234-5",
    "agency": "1234",
    "operation": null,
    "feedback": "Recusado, envio de teste",
    "bank": "Itaú"
  }
]

 

 

SUGERIR EDIÇÃO

Pedido de Saque

Faz um pedido de Saque de um valor.

 

 Testar

posthttps://api.iugu.com/v1/accounts/id/request_withdraw

curl --request POST \
  --url https://api.iugu.com/v1/accounts/id/request_withdraw
{
    "id": "2B925E434B324F46827580F6BC0638AB",
    "amount": "500.0"
}

PATH PARAMS

id

string

OBRIGATÓRIO

ID da sub-conta

 

BODY PARAMS

amount

float

Valor do Saque (Formato: 500.0 para 500 reais)

 

custom_variables

array of objects

Variáveis personalizadas

name

value

Add ObjectEdit Array JSON

 

 

SUGERIR EDIÇÃO

Listar Contas

Lista as contas de um marketplace ou parceiro de negócios.

 

 Testar

gethttps://api.iugu.com/v1/marketplace

curl --request GET \
  --url https://api.iugu.com/v1/marketplace
{
  "totalItems": 2,
  "items": [
    {
      "id": "63EC0B8F0FA74B6589AA8B005FEF20FA",
      "name": "Nome da Subconta",
      "verified": true
    },
    {
      "id": "883F3B8F0FA749D3B1AA8B00093FF32F",
      "name": "Nome da Segunda Subconta",
      "verified": true
    }
  ]
}

QUERY PARAMS

limit

int32

Limita em até 1.000 o número de registros listados. Caso não seja enviado, aplica-se o limite padrão de 100 registros

 

start

int32

Quantos registros pular do início da pesquisa

 

query

string

Neste parâmetro pode ser passado um texto para pesquisa

 

 

 

SUGERIR EDIÇÃO

Renovar Api Token de Usuário

Renova o api token de usuário de uma conta

 

 Testar

posthttps://api.iugu.com/v1/profile/renew_access_token

curl --request POST \
  --url https://api.iugu.com/v1/profile/renew_access_token
{
"new_user_token": "2b753b7f12f5263d28144545beef0236"
}

 

 

SUGERIR EDIÇÃO

Criar API Token

Cria um "api_token" em uma subconta.

 

Atenção

Essa API obriga a utilização do "user_api_token" na autenticação da chamada.

 

 

 Testar

posthttps://api.iugu.com/v1/account_id/api_tokens

curl --request POST \
  --url https://api.iugu.com/v1/account_id/api_tokens
{
  "id": "A0036E328D254004AEA7FD9FE808CDA5",
  "token": "048e378481b750ffbc3ab9e0c0fee11",
  "api_type": "TEST",
  "description": "Token de Teste",
  "created_at": "2017-06-28T13:31:04-03:00"
}

PATH PARAMS

account_id

string

OBRIGATÓRIO

ID da conta em que o token será criado

 

BODY PARAMS

api_type

string

OBRIGATÓRIO

Tipo de API. 'LIVE' para ambiente de produção e 'TEST' para ambiente de testes. "Case Sensitive"

 

description

string

OBRIGATÓRIO

Descrição

 

 

 

SUGERIR EDIÇÃO

Remover API Token

Remove um "api_token" em uma subconta.

 

Atenção

Essa API obriga a utilização do "user_api_token" na autenticação da chamada.

 

 

 Testar

deletehttps://api.iugu.com/v1/account_id/api_tokens/id

curl --request DELETE \
  --url https://api.iugu.com/v1/account_id/api_tokens/id
{
  "id": "47A426FA62C0411584988A495A445E5F",
  "token": "700057ef6329852fc87622d661e43653",
  "api_type": "LIVE",
  "description": "Token de produção",
  "created_at": "2017-06-28T13:34:16-03:00"
}

PATH PARAMS

account_id

string

OBRIGATÓRIO

ID da conta em que o token será removido

 

id

string

OBRIGATÓRIO

ID do Token

 

 

 

SUGERIR EDIÇÃO

Listar API Tokens

Listar os "api_tokens" em uma subconta.

 

Atenção

Essa API obriga a utilização do "user_api_token" na autenticação da chamada.

 

 

 Testar

gethttps://api.iugu.com/v1/account_id/api_tokens

curl --request GET \
  --url https://api.iugu.com/v1/account_id/api_tokens
[
  {
    "id": "9314B461BE4846E59503E5C8FACC01BA",
    "token": "c3a2fa6f0ccb92f4ebb4f26c8f856ea",
    "api_type": "LIVE",
    "description": "Token de produção",
    "created_at": "2017-06-28T13:48:32-03:00"
  },
  {
    "id": "E736BD081CA04A10B152C3479D2EEA51",
    "token": "b0ee0ac4e6a9eb41465d435556b8822",
    "api_type": "TEST",
    "description": "Token de teste",
    "created_at": "2017-06-28T13:34:07-03:00"
  }
]

PATH PARAMS

account_id

string

OBRIGATÓRIO

ID da conta para listar seus tokens

 

 

 

SUGERIR EDIÇÃO

Listar Eventos Disponíveis

Lista todos os eventos disponíveis para criação de um Gatilho

 

 Testar

gethttps://api.iugu.com/v1/web_hooks/supported_events

curl --request GET \
  --url https://api.iugu.com/v1/web_hooks/supported_events
[
  "all",
  "invoice.created",
  "invoice.status_changed",
  "invoice.refund",
  "invoice.payment_failed",
  "invoice.dunning_action",
  "invoice.due",
  "invoice.installment_released",
  "invoice.released",
  "subscription.suspended",
  "subscription.activated",
  "subscription.created",
  "subscription.renewed",
  "subscription.expired",
  "subscription.changed",
  "referrals.verification",
  "referrals.bank_verification",
  "withdraw_request.created",
  "withdraw_request.status_changed"
]

 

 

SUGERIR EDIÇÃO

Criar Gatilho

Cria gatilho

 

 Testar

posthttps://api.iugu.com/v1/web_hooks

curl --request POST \
  --url https://api.iugu.com/v1/web_hooks
{
  "id": "D57FCEA0EB7A4647B05E1B562035D9CA",
  "url": "https://endpoint_gatilho.in/123",
  "authorization": "my_key",
  "event": "invoice.created"
}

BODY PARAMS

event

string

OBRIGATÓRIO

Nome do evento desejado

 

url

string

OBRIGATÓRIO

Endpoint para qual o gatilho será enviado

 

authorization

string

Grave uma chave / key para usar como "Basic Authentication" na validação do recebimento dos gatilhos.

 

 

 

SUGERIR EDIÇÃO

Alterar Gatilho

Altera um gatilho

 

 Testar

puthttps://api.iugu.com/v1/web_hooks/id

curl --request PUT \
  --url https://api.iugu.com/v1/web_hooks/id
{
  "id": "D57FCEA0EB7A4647B05E1B562035D9CA",
  "url": "https://endpoint_gatilho.in/123",
  "authorization": "my_key",
  "event": "invoice.status_changed"
}

BODY PARAMS

event

string

Nome do evento desejado

 

url

string

Endpoint para qual o gatilho será enviado

 

authorization

string

Grave uma chave / key para usar como "Basic Authentication" na validação do recebimento dos gatilhos.

 

 

 

SUGERIR EDIÇÃO

Remover Gatilho

Remove um gatilho

 

 Testar

deletehttps://api.iugu.com/v1/web_hooks/id

curl --request DELETE \
  --url https://api.iugu.com/v1/web_hooks/id
{
  "id": "D57FCEA0EB7A4647B05E1B562035D9CA",
  "url": "https://endpoint_gatilho/12345",
  "authorization": null,
  "event": "invoice.status_changed"
}

PATH PARAMS

id

string

OBRIGATÓRIO

ID do Gatilho

 

 

 

SUGERIR EDIÇÃO

Buscar Gatilho

 

 Testar

gethttps://api.iugu.com/v1/web_hooks/id

curl --request GET \
  --url https://api.iugu.com/v1/web_hooks/id
{
  "id": "D57FCEA0EB7A4647B05E1B562035D9CA",
  "url": "https://endpoint_gatilho.in/12345",
  "authorization": "my_key",
  "event": "invoice.status_changed"
}

PATH PARAMS

id

string

OBRIGATÓRIO

ID do Gatilho

 

 

 

SUGERIR EDIÇÃO

Listar Gatilhos

Retorna a lista de gatilhos de uma conta

 

 Testar

gethttps://api.iugu.com/v1/web_hooks

curl --request GET \
  --url https://api.iugu.com/v1/web_hooks
[
  {
    "id": "A7399634A4F1423E8F8B199DA79F45AD",
    "url": "https://endpoint_gatilho.in/12345",
    "authorization": "jT5EnMEz",
    "event": "all"
  },
  {
    "id": "D57FCEA0EB7A4647B05E1B562035D9CA",
    "url": "https://endpoint_gatilho.in/09877",
    "authorization": "uE7Xjl6l",
    "event": "invoice.status_changed"
  }
]

 

 

SUGERIR EDIÇÃO

Consultar Gestão

Retorna configuração atual da gestão de cobranças.

 

 Testar

gethttps://api.iugu.com/v1/dunning_steps

curl --request GET \
  --url https://api.iugu.com/v1/dunning_steps
[
    {
        "day": 3,
        "action": "charge"
    },
    {
        "day": 6,
        "action": "charge"
    },
    {
        "day": 9,
        "action": "charge"
    },
    {
        "day": 10,
        "action": "expire"
    }
]

 

 

SUGERIR EDIÇÃO

Alterar Gestão

Alterar a configuração da gestão de cobranças.

 

Atenção

Esta API obriga a utilização do live_api_token na autenticação da chamada. Pois é uma configuração global, afeta ambiente de teste e produção.

 

 

 Testar

puthttps://api.iugu.com/v1/dunning_steps

curl --request PUT \
  --url https://api.iugu.com/v1/dunning_steps
[
    {
        "day": 3,
        "action": "charge"
    },
    {
        "day": 6,
        "action": "charge"
    },
    {
        "day": 9,
        "action": "charge"
    },
    {
        "day": 10,
        "action": "expire"
    }
]

BODY PARAMS

steps

array of objects

Action = "charge" ou "expire" / day = intervalo da cobrança

action

day

Add ObjectEdit Array JSON

 

 

SUGERIR EDIÇÃO

Listar Identificadores de Email Disponíveis

Retorna lista de emails disponíveis para personalização

 

 Testar

gethttps://api.iugu.com/v1/emails/supported_emails

curl --request GET \
  --url https://api.iugu.com/v1/emails/supported_emails
[
  "invoice_reminder",
  "invoice_due",
  "invoice_receipt",
  "invoice_canceled",
  "invoice_refund",
  "subscription_charge_failure",
  "subscription_created",
  "subscription_changed",
  "subscription_suspended",
  "subscription_trial_remainder",
  "subscription_trial_ended"
]

 

 

SUGERIR EDIÇÃO

Buscar Layout Padrão de Email

Retorna layout padrão de email

 

 Testar

gethttps://api.iugu.com/v1/emails/default_layout/identifier

curl --request GET \
  --url https://api.iugu.com/v1/emails/default_layout/identifier
{
  "subject": "{{ invoice.account_name }} - {{ 'emails.invoice_refund' | t }} {{ invoice.total }}",
  "template": "<div style=\"max-width:640px; position: relative; padding: 20px 20px 20px 20px;\">\n\n  <!-- LOGO  -->\n  {% if invoice.custom_logo %}\n    <img src=\"{{ invoice.custom_logo }}\", style=\"max-width: 120px; max-height: 60px;\", alt=\"{{ invoice.account_name }}\" />\n  {% endif %}\n\n  <!-- INVOICE INFORMATION -->\n  {% if invoice.customer_ref %}\n    {% assign name = invoice.customer_ref %}\n  {% else %}\n    {% assign name = invoice.email %}\n  {% endif %}\n  <div style=\"font-size: 20px; margin-top: 20px\">{{ 'emails.invoice_refund_receipt_for' | t }} {{ name }}</div>\n\n  <div style=\"margin-top: 20px\">{{ 'emails.you_received_refund' | t: account_name: invoice.account_name }}</div>\n\n  <table cellspacing=0 cellpadding=2 style=\"width: 100%; margin-top: 20px\">\n    <thead style=\"text-align: left; font-size: 14px; color: #9A9A9A\">\n      <tr>\n        <th style=\"border-bottom: 2px solid #ccc; width: 30%\">{{ 'transaction' | t | upcase }}</th>\n        <th style=\"border-bottom: 2px solid #ccc\">#{{ invoice.id }}</th>\n      </tr>\n    </thead>\n    <tbody style=\"font-size: 12px\">\n      <tr>\n        <td style=\"font-size: 10px; color: #9A9A9A; padding-top: 5px\">{{ 'transferor' | t | upcase }}</td>\n      </tr>\n      <tr>\n        <td style=\"font-size: 11px\"><strong>{{ 'name' | t | upcase }}</strong></td>\n        <td>{{ invoice.account_name }}</td>\n      </tr>\n      <tr>\n        <td style=\"font-size: 11px\"><strong>{{ 'cpf_cnpj' | t | upcase }}</strong></td>\n        <td>{{ invoice.account_cpf_cnpj }}</td>\n      </tr>\n      <tr>\n        <td style=\"font-size: 11px\"><strong>{{ 'email' | t | upcase }}</strong></td>\n        <td>{{ invoice.account_reply_to }}</td>\n      </tr>\n      <tr>\n        <td style=\"font-size: 10px; color: #9A9A9A; padding-top: 7px\">FATURA</td>\n      </tr>\n      <tr>\n        <td style=\"font-size: 11px\"><strong>{{ 'emails.generated_in' | t | upcase }}</strong></td>\n        <td>{{ invoice.created_at | date: '%d/%m/%Y' }}</td>\n      </tr>\n      <tr>\n        <td style=\"font-size: 11px\"><strong>{{ 'emails.due_date' | t | upcase }}</strong></td>\n        <td>{{ invoice.due_date | date: '%d/%m/%Y' }}</td>\n      </tr>\n      <tr>\n        <td style=\"font-size: 11px\"><strong>{{ 'payment_method' | t | upcase }}</strong></td>\n        <td>{{ 'payments.methods.' | append: invoice.payment_method | t }}</td>\n      </tr>\n      <tr>\n        <td style=\"font-size: 10px; color: #9A9A9A; padding-top: 7px\">{{ 'client' | t | upcase }}</td>\n      </tr>\n      {% if name == invoice.email %}\n        <tr>\n          <td style=\"font-size: 11px\"><strong>{{ 'email' | t | upcase }}</strong></td>\n          <td>{{ invoice.email }}</td>\n        </tr>\n      {% else %}\n        <tr>\n          <td style=\"font-size: 11px\"><strong>{{ 'name' | t | upcase }}</strong></td>\n          <td>{{ name }}</td>\n        </tr>\n        <tr>\n          <td style=\"font-size: 11px\"><strong>{{ 'email' | t | upcase }}</strong></td>\n          <td>{{ invoice.email }}</td>\n        </tr>\n      {% endif %}\n    </tbody>\n  </table>\n\n  <!-- SUMMARY -->\n  <div style=\"font-size: 15px; margin-top: 20px; color: #808080\">{{ 'emails.summary' | t | upcase }}</div>\n\n  <table cellspacing=0 cellpadding=2 style=\"width: 100%; text-align: right; margin-top: 10px\">\n    <thead style=\"text-align: right; font-size: 10px; color: #9A9A9A\">\n      <tr>\n        <th style=\"text-align: left\">{{ 'description' | t }}</th>\n        <th>{{ 'quantity' | t | replace: ':', '' }}</th>\n        <th>{{ 'value' | t }}</th>\n        <th>{{ 'total' | t }}</th>\n      </tr>\n    <tbody style=\"font-size: 12px\">\n      {% for item in invoice.items %}\n        <tr>\n          <td style=\"border-top: 1px solid #cccccc; text-align: left\">{{ item.description }}</td>\n          <td style=\"border-top: 1px solid #cccccc\">{{ item.quantity }}</td>\n          <td style=\"border-top: 1px solid #cccccc\">{{ item.price }}</td>\n          <td style=\"border-top: 1px solid #cccccc\">{{ item.total }}</td>\n        </tr>\n      {% endfor %}\n      <tr style=\"color: #3E4444\">\n        <td style=\"border-top: 2px solid #cccccc\"></td>\n        <td style=\"border-top: 2px solid #cccccc\"></td>\n        <td style=\"border-top: 2px solid #cccccc\"><strong>TOTAL</strong></td>\n        <td style=\"border-top: 2px solid #cccccc\"><strong>{{ invoice.total }}</strong></td>\n      </tr>\n    </tbody>\n  </table>      \n\n  <div style=\"margin-top: 20px; color: #808080; font-size: 14px\">{{ 'emails.the_amount_above' | t }}</div>\n\n  <div style=\"color: #808080; font-size: 14px\">{{ 'emails.for_more_information' | t }}</div>\n\n  <div style=\"margin-top: 20px; color: #808080\">{{ 'emails.email_valid_as_proof' | t }}</div>\n</div>\n"
}

PATH PARAMS

identifier

string

OBRIGATÓRIO

Identificador do Email

 

 

 

SUGERIR EDIÇÃO

Criar Email

 

 Testar

posthttps://api.iugu.com/v1/emails

curl --request POST \
  --url https://api.iugu.com/v1/emails
{
  "id": "1FAC04103DB746D2B78DECCE17602621",
  "identifier": "invoice_refund",
  "template": "Template do email",
  "subject": "Assunto do email",
  "active": true
}

BODY PARAMS

identifier

string

OBRIGATÓRIO

Identificador do email (Deve ser enviado um dos itens retornados pela API de 'Listar Emails Disponíveis')

 

template

string

OBRIGATÓRIO

Template do email

 

subject

string

OBRIGATÓRIO

Assunto do email

 

active

boolean

OBRIGATÓRIO

Determina se o email ficará ativo ou não logo após a criação

truefalse

 

 

SUGERIR EDIÇÃO

Alterar Email

Altera um email

 

 Testar

puthttps://api.iugu.com/v1/emails/id

curl --request PUT \
  --url https://api.iugu.com/v1/emails/id
{
  "id": "1FAC04103DB746D2B78DEFBE17602621",
  "identifier": "invoice_due",
  "template": "Segundo template do email",
  "subject": "Assunto do email",
  "active": true
}

PATH PARAMS

id

string

OBRIGATÓRIO

ID do Email

 

BODY PARAMS

identifier

string

Identificador do email (Deve ser enviado um dos itens retornados pela API de 'Listar Emails Disponíveis')

 

template

string

Template do email

 

subject

string

Assunto do email

 

active

string

Determina se o email ficará ativo ou não

 

 

 

SUGERIR EDIÇÃO

Remover Email

Remove um email

 

 Testar

deletehttps://api.iugu.com/v1/emails/id

curl --request DELETE \
  --url https://api.iugu.com/v1/emails/id
{
  "id": "1FAC04103DB746D2B78DEFBE17602621",
  "identifier": "invoice_due",
  "template": "Segundo template do email",
  "subject": "Assunto do email",
  "active": true
}

PATH PARAMS

id

string

OBRIGATÓRIO

ID do Email

 

 

 

SUGERIR EDIÇÃO

Visualizar Templade de Email

Retorna template salvo para determinado email

 

 Testar

gethttps://api.iugu.com/v1/emails/preview/identifier

curl --request GET \
  --url https://api.iugu.com/v1/emails/preview/identifier
{
  "preview": "Template do email"
}

PATH PARAMS

identifier

string

OBRIGATÓRIO

Identificador do Email

 

 

 

SUGERIR EDIÇÃO

Enviar Email de Teste

Envia email real para visualização do layout

 

 Testar

posthttps://api.iugu.com/v1/emails/test/identifier

curl --request POST \
  --url https://api.iugu.com/v1/emails/test/identifier
{
  "success": true
}

PATH PARAMS

identifier

string

OBRIGATÓRIO

Identificador do Email

 

BODY PARAMS

to

string

Email para qual deve ser enviado

 

 

 

SUGERIR EDIÇÃO

Buscar Email

Retorna os dados de um determinado email

 

 Testar

gethttps://api.iugu.com/v1/emails/id

curl --request GET \
  --url https://api.iugu.com/v1/emails/id
{
  "id": "1FAC04103DB746D2B78DEFBE17602621",
  "identifier": "invoice_refund",
  "template": "Template do email",
  "subject": "Assunto do email",
  "active": true
}

PATH PARAMS

id

string

OBRIGATÓRIO

ID do Email

 

 

 

SUGERIR EDIÇÃO

Listar Emails

Retorna a lista de emails

 

 Testar

gethttps://api.iugu.com/v1/emails

curl --request GET \
  --url https://api.iugu.com/v1/emails
[
  {
    "id": "1FAC04103DB746D2B78DEFBE17602621",
    "identifier": "invoice_refund",
    "template": "Template do email",
    "subject": "Assunto do email",
    "active": true
  }
]

 

 

SUGERIR EDIÇÃO

Buscar Transferência Bancária

Retorna as informações de uma transferência bancária.

 

 Testar

gethttps://api.iugu.com/v1/withdraw_requests/id

curl --request GET \
  --url https://api.iugu.com/v1/withdraw_requests/id
{
    "id": "530706A3862D4BB49C8AC9637B850CDE",
    "status": "pending",
    "created_at": "2015-11-26T10:02:23-02:00",
    "updated_at": "2015-11-26T10:02:23-02:00",
    "reference": null,
    "amount": "R$ 10,00",
    "account_name": "Conta",
    "account_id": "A682CECA59D74527B984CA529D7C2ED4",
    "feedback": null,
    "bank_address": {
        "bank": "Bradesco",
        "bank_cc": "11231-2",
        "bank_ag": "1234",
        "account_type": "Corrente"
    }
}

PATH PARAMS

id

string

OBRIGATÓRIO

ID da transferência.

 

 

 

SUGERIR EDIÇÃO

Listar Transferência Bancária

Retorna a lista de todas as transferências bancárias.

 

 Testar

gethttps://api.iugu.com/v1/withdraw_requests

curl --request GET \
  --url https://api.iugu.com/v1/withdraw_requests
{
    "totalItems": 2,
    "items": [
        {
            "id": "530706A3862D4BB49C8AC9637B850CDE",
            "status": "pending",
            "created_at": "2015-11-26T10:02:23-02:00",
            "updated_at": "2015-11-26T10:02:23-02:00",
            "reference": null,
            "amount": "R$ 10,00",
            "account_name":  "Conta",
            "account_id": "A682CECA59D74527B984CA529D7C2ED4",
            "bank_address": "{"bank":"Bradesco","bank_cc":"11231-2","bank_ag":"1234","account_type":"Corrente"}"
        },
        {
            "id": "35FC23B99C4643569943B7C70DC05014",
            "status": "pending",
            "created_at": "2015-11-25T17:33:53-02:00",
            "updated_at": "2015-11-25T17:33:53-02:00",
            "reference": null,
            "amount": "R$ 10,00",
            "account_name": "Conta",
            "account_id": "A682CECA59D74527B984CA529D7C2ED4",
            "bank_address": "{"bank":"Bradesco","bank_cc":"11231-2","bank_ag":"1234","account_type":"Corrente"}"
        }
    ]
}

QUERY PARAMS

custom_variables_name

string

Filtra as transferências bancárias pelo nome da variável customizada

 

custom_variables_value

string

Filtra as transferências bancárias pelo valor da variável customizada

 

 

 

SUGERIR EDIÇÃO

Listar Recebíveis

 

 Testar

gethttps://api.iugu.com/v1/financial_transaction_requests

curl --request GET \
  --url https://api.iugu.com/v1/financial_transaction_requests
{
  "totalItems": 2,
  "items": [
    {
      "id": 1735543,
      "description": "Fatura 79C426613C1C4AD7B0A1588FAE12A907 Parcela: Única",
      "scheduled_date": "2017-06-30",
      "invoice_id": "79C426613C1C4AD7B0A1588FAE12A907",
      "customer_ref": "João da Silva",
      "total": "R$ 380,00",
      "taxes": "R$ 0,00",
      "client_share": "R$ 380,00",
      "commission": "R$ 0,00",
      "number_of_installments": 6,
      "installment": 3
    },
    {
      "id": 1736181,
      "description": "Fatura 834C31C2281B4ECBB63A2BD31ABD0E55 Parcela: Única",
      "scheduled_date": "2017-06-30",
      "invoice_id": "834C31C2281B4ECBB63A2BD31ABD0E55",
      "customer_ref": "João da Silva",
      "total": "R$ 380,00",
      "taxes": "R$ 0,00",
      "client_share": "R$ 380,00",
      "commission": "R$ 0,00",
      "number_of_installments": 1,
      "installment": 1
    }
  ]
}

QUERY PARAMS

limit

int32

Quantidade de recebíveis retornadas (recomendamos usar no máximo limit=100)

 

start

int32

Quantos registros pular do início da pesquisa, usado para paginação (verificar modo de uso no inicio da documentação)

 

 

 

SUGERIR EDIÇÃO

Simular Antecipação de Recebíveis

 

 Testar

gethttps://api.iugu.com/v1/financial_transaction_requests/advance_simulation

curl --request GET \
  --url 'https://api.iugu.com/v1/financial_transaction_requests/advance_simulation?transactions=transactions'

Try the API to see results

QUERY PARAMS

transactions

array of integers

OBRIGATÓRIO

Lista de IDs dos recebíveis cuja antecipação você deseja simular.

 

 

SUGERIR EDIÇÃO

Antecipar recebíveis

Antecipa o valor das parcelas de cobranças pagas com cartão de crédito, dados os IDs dessas parcelas. Processa no máximo 200 transações de uma só vez.

 

 Testar

posthttps://api.iugu.com/v1/financial_transaction_requests/advance

curl --request POST \
  --url https://api.iugu.com/v1/financial_transaction_requests/advance

Try the API to see results

BODY PARAMS

transactions

array of integers

Lista de IDs dos recebíveis a serem antecipados. Não pode conter mais que 200 IDs.

 

 

SUGERIR EDIÇÃO

Disputar Contestação

Abre uma disputa sobre a contestação.

 

 Testar

puthttps://api.iugu.com/v1/chargebacks/id/contest

curl --request PUT \
  --url https://api.iugu.com/v1/chargebacks/id/contest
{
    "id": "D5F4DC1583BC4B19A77814A2C5ABC092",
    "invoice_id": "C4E1B42BBC5146ACAAB27B03ED5D34F8",
    "status": "contested_by_client",
    "expires_at": "2017-06-27"
}

PATH PARAMS

id

string

OBRIGATÓRIO

ID da contestação

 

BODY PARAMS

file_1

file

Primeiro arquivo que comprove a legitimidade da transação

file_2

file

Segundo arquivo que comprove a legitimidade da transação

file_3

file

Terceiro arquivo que comprove a legitimidade da transação

file_4

file

Quarto arquivo que comprove a legitimidade da transação

file_5

file

Quinto arquivo que comprove a legitimidade da transação

 

 

SUGERIR EDIÇÃO

Acatar Contestação

Acata a solicitação de contestação.

 

 Testar

puthttps://api.iugu.com/v1/chargebacks/id/accept

curl --request PUT \
  --url https://api.iugu.com/v1/chargebacks/id/accept
{
  "id": "14B31AF16A254F3C9E22927989B879D8",
  "invoice_id": "C9FD4AB9603B4E919559ADD9082895B7",
  "status": "accepted",
  "expires_at": "2017-07-05"
}

PATH PARAMS

id

string

OBRIGATÓRIO

ID da contestação

 

 

 

SUGERIR EDIÇÃO

Buscar Contestação

Retorna as informações de uma contestação.

 

 Testar

gethttps://api.iugu.com/v1/chargebacks/id

curl --request GET \
  --url https://api.iugu.com/v1/chargebacks/id
{
  "id": "14B31AF16A254F3C9E22927989B879D8",
  "invoice_id": "C9FD4AB9603B4E919559ADD9082895B7",
  "status": "pending",
  "expires_at": "2017-07-05"
}

PATH PARAMS

id

string

OBRIGATÓRIO

ID da contestação

 

 

 

SUGERIR EDIÇÃO

Listar Contestação

Retorna uma lista com todas as contestações de sua conta.

 

 Testar

gethttps://api.iugu.com/v1/chargebacks

curl --request GET \
  --url https://api.iugu.com/v1/chargebacks
{
    "facets": {
        "pending": {
            "_type": "filter",
            "count": 2
        }
    },
    "items": [
        {
            "id": "14B31AF16A254F3C9E22927989B879D8",
            "invoice_id": "C9FD4AB9603B4E919559ADD9082895B7",
            "status": "pending",
            "expires_at": "2017-07-05"
        },
        {
            "id": "D5F4DC1583BC4B19A77814A2C5ABC092",
            "invoice_id": "C4E1B42BBC5146ACAAB27B03ED5D34F8",
            "status": "pending",
            "expires_at": "2017-06-27"
        }
    ]
}

 

 

SUGERIR EDIÇÃO

Extrato Financeiro

Retorna o extrato financeiro de uma conta.

 

Atenção

Esta API obriga a utilização do live_api_token na autenticação da chamada. Somente em modo "produção" há movimentação de saldo na conta iugu.

 

 

 Testar

gethttps://api.iugu.com/v1/accounts/financial

curl --request GET \
  --url https://api.iugu.com/v1/accounts/financial
{
    "transactions": [
        {
            "amount": "99.90 BRL",
            "type": "credit",
            "description": "Fatura 4D6859EF38C14F42A694193F65FCFA0A Parcela: Única",
            "entry_date": "2017-06-27",
            "reference": "4D6859EF38C14F42A694193F65FCFA0A",
            "reference_type": "Invoice",
            "account_id": "57FD9F82ED004D959497226A196ED654",
            "transaction_type": "invoice_return",
            "balance": "99.90 BRL",
            "customer_ref": "João"
        },
        {
            "amount": "-4.79 BRL",
            "type": "debit",
            "description": "Tarifas - Fatura 4D6859EF38C14F42A694193F65FCFA0A Parcela: Única",
            "entry_date": "2017-06-27",
            "reference": "4D6859EF38C14F42A694193F65FCFA0A",
            "reference_type": "Invoice",
            "account_id": "57FD9F82ED004D959497226A196ED654",
            "transaction_type": "invoice_return",
            "balance": "95.11 BRL",
            "customer_ref": "José"
        },
        {
            "amount": "99.90 BRL",
            "type": "credit",
            "description": "Fatura C4E1B42BBC5146ACAAB27B03ED5D34F8 Parcela: Única",
            "entry_date": "2017-06-27",
            "reference": "C4E1B42BBC5146ACAAB27B03ED5D34F8",
            "reference_type": "Invoice",
            "account_id": "57FD9F82ED004D959497226A196ED654",
            "transaction_type": "invoice_return",
            "balance": "195.01 BRL",
            "customer_ref": "José"
        },
        {
            "amount": "-4.79 BRL",
            "type": "debit",
            "description": "Tarifas - Fatura C4E1B42BBC5146ACAAB27B03ED5D34F8 Parcela: Única",
            "entry_date": "2017-06-27",
            "reference": "C4E1B42BBC5146ACAAB27B03ED5D34F8",
            "reference_type": "Invoice",
            "account_id": "57FD9F82ED004D959497226A196ED654",
            "transaction_type": "invoice_return",
            "balance": "190.22 BRL",
            "customer_ref": "João"
        },
        {
            "amount": "-3.42 BRL",
            "type": "debit",
            "description": "Antecipação de Recebíveis - R$ 190,22 - custo: R$ 3,42",
            "entry_date": "2017-06-27",
            "reference": null,
            "reference_type": null,
            "account_id": "57FD9F82ED004D959497226A196ED654",
            "transaction_type": "advance",
            "balance": "186.80 BRL",
            "customer_ref": ""
        }
    ],
    "initial_balance": {
        "amount": "0.00 BRL",
        "entry_date": "2017-05-28"
    },
    "initial_date": "2017-05-28T00:00:00-03:00",
    "final_date": "2017-06-27T16:10:24-03:00"
}

QUERY PARAMS

year

string

Ano

 

month

string

Mês

 

day

string

Dia

 

limit

int32

Limita em até 1.000 o número de registros listados. Embora recomendamos usar no máximo limit=100

 

start

int32

Quantos registros pular do início da pesquisa, usado para paginação. (ver no inicio da documentação)

 

 

 

SUGERIR EDIÇÃO

Extrato de Faturas

Retorna o extrato de faturas de uma conta.

 

 Testar

gethttps://api.iugu.com/v1/accounts/invoices

curl --request GET \
  --url https://api.iugu.com/v1/accounts/invoices

Try the API to see results

QUERY PARAMS

limit

int32

Limita em até 1.000 o número de registros listados. Embora recomendamos usar no máximo limit=100

 

start

int32

Quantos registros pular do início da pesquisa, utilizado para paginação. (ver no inicio da documentação)

 

year

string

Ano

 

month

string

Mês

 

status

string

Filtrar pelo status da fatura. ("pending", "paid", "partially_paid", "refunded", "expired", "canceled", "in_protest", "chargeback")

 

 

 

SUGERIR EDIÇÃO

Conciliação de faturas

Retorna todas as faturas criadas em ambiente de produção (LIVE) que tenham um determinado status e tenham sido atualizadas em determinado período (entre fromto). No caso de marketplaces ou parceiros de negócios, retorna também as faturas das subcontas que atendam a esses critérios.

 

 Testar

gethttps://api.iugu.com/v1/invoice_conciliations

curl --request GET \
  --url https://api.iugu.com/v1/invoice_conciliations

Try the API to see results

BODY PARAMS

status

string

Status das faturas. Por padrão, todos os tipos de faturas são considerados: draftpendingpaidpartially_paidpayment_in_progresscanceledexpiredrefundedchargebackin_analysis ou in_protest.

 

from

date-time

Data e hora a partir das quais as faturas foram atualizadas (updated_at). Por padrão: 1 dia atrás. Formato: 2018-05-01T14:30:00-03:00.

 

to

date-time

Data e hora até as quais as faturas foram atualizadas (updated_at). Por padrão: data e hora presentes. Formato: 2018-05-01T14:30:00-03:00.

 

start

int32

Usado para paginação. Define o número de registros que serão "pulados" na busca pelas faturas.

 

limit

int32

Usado para paginação. Define o número máximo de registros retornados pelo endpoint.

 

 

 

SUGERIR EDIÇÃO

Conciliação de saques

Retorna todos os pedidos de saques criados em ambiente de produção (LIVE) que tenham um determinado status e tenham sido atualizados em determinado período (entre fromto). No caso de marketplaces ou parceiros de negócios, retorna também os pedidos de saques de subcontas que atendam a esses critérios.

 

 Testar

gethttps://api.iugu.com/v1/withdraw_conciliations

curl --request GET \
  --url https://api.iugu.com/v1/withdraw_conciliations

Try the API to see results

BODY PARAMS

status

string

Status dos saques. Por padrão, todos os tipos de saques são considerados: pendingprocessingaccepted ou rejected.

 

from

date-time

Data e hora a partir das quais os saques foram atualizados (updated_at). Por padrão: 1 dia atrás. Formato: 2018-05-01T14:30:00-03:00.

 

to

date-time

Data e hora até as quais os saques foram atualizadas (updated_at). Por padrão: data e hora presentes. Formato: 2018-05-01T14:30:00-03:00.

 

start

int32

Usado para paginação. Define o número de registros que serão "pulados" na busca pelos saques.

 

limit

int32

Usado para paginação. Define o número máximo de registros retornados pelo endpoint.

 

 

 

SUGERIR EDIÇÃO

Simula repasse antecipação

Simula os valores que devem ser cobrados do cliente, para vendas a vista ou a prazo no cartão de crédito, para repassar ao cliente, os custos da antecipação de recebíveis.

Valor a ser cobrado a mais do cliente para que receba de forma antecipada, o mesmo valor que receberia no prazo.

 

 Testar

gethttps://api.iugu.com/v1/utilities/interest

curl --request GET \
  --url 'https://api.iugu.com/v1/utilities/interest?total_cents=total_cents&tax=0.025'
{
    "interest": "2.25%",
    "installments": 1,
    "interest_cents": 897,
    "total_with_interest_cents": 40797
}

QUERY PARAMS

total_cents

string

OBRIGATÓRIO

Valor da cobrança a ser calculado, em centavos

 

tax

string

OBRIGATÓRIO

Tarifa de antecipação do seu plano iugu.

 

anticipation_days

string

Antecipar a venda em quantos dias após a transação. Se não enviar, será considerado uma antecipação para o dia 0 (zero)

 

installments

string

Quantidade de Parcelas da venda. Pode enviar o número específico da parcela. Se não enviar, vai listar de 2x até 12x

 


Observações:

Em andamento

Etapa: Mapa do Sistema

Configuração:

Conteúdo está marcado como Privado!


Observações:

Conteúdo está marcado como Privado!