Gatilhos
A iugu disponibiliza a funcionalidade de gatilhos (webhooks) para facilitar a integração entre sistemas.
O que você irá aprender com esse artigo?
- Conceito Básico
- Eventos
Conceito Básico
Gatilhos (ou Webhooks) são endereços (URLs) para onde a Iugu dispara avisos (Via método POST) para certos eventos que ocorrem em sua conta.
As chamadas são enviadas com content-type application/x-www-form-urlencoded.
Os gatilhos podem ser cadastrados pelo painel da iugu, menu: Administração > Gatilhos
ou via API em criar gatilho.
IP's de Saída para Liberação de Gatilhos
Caso seja feito algum tipo de controle via Firewall, segue abaixo a lista de IP's de saída da iugu:
- 18.228.74.69
- 18.229.169.205
- 18.229.210.231
- 54.207.210.151
Atenção!
O seu servidor deverá retornar um HTTP 200 para a iugu quando dispararmos as notificações. Caso ele retorne algo diferente de 200 (como HTTP 404, 500, etc), nós vamos disparar a mesma notificação novamente 5 vezes num intervalo de 5 minutos.
Atenção ao limite de URL's cadastradas
Atualmente, suportamos a criação de até 20 URL's de gatilhos por conta. Porém, os links podem ser adicionados e removidos sem nenhuma restrição.
Eventos
Segue abaixo os eventos e seus respectivos dados enviados.
Fatura Criada
Esse gatilho será enviado toda vez que criado uma fatura na plataforma, geralmente é usado para identificar quando foi criado uma nova fatura da assinatura.
| Parâmetro | Dados |
|---|---|
| event | invoice.created |
| data[id] | ID da Fatura Ex: 1757E1D7FD5E410A9C563024250015BF |
| data[account_id] | ID da Conta Ex: 70CA234077134ED0BF2E0E46B0EDC36F |
| data[status] | Estado da Fatura (pending, paid, canceled, partially_paid,externally_paid, refunded, expired, authorized, in_protest, chargeback) Ex: pending |
| data[subscription_id] | ID da Assinatura a qual essa Fatura foi criada (Somente é enviado caso a fatura seja de uma assinatura) Ex: F4115E5E28AE4CCA941FCCCCCABE9A0A |
| data[source] | API, Alia, subscription: faturas criadas pela rotina de faturamento de assinaturas internal: faturas criadas internamente, hojej só é usado quando tem duplicidade de pagamentos Ex: api |
| data[order_id] | Número único que identifica o pedido de compra. Opcional, ajuda a evitar o pagamento da mesma fatura. Ex: N77579_31658163 |
| data[external_reference] | Informação de referência externa, possibilitando a realização de pesquisa EX: N55548889 |
event: invoice.created
data[id]: 1757E1D7FD5E410A9C563024250015BF
data[account_id]: 70CA234077134ED0BF2E0E46B0EDC36F
data[status]: pending
data[subscription_id]: F4115E5E28AE4CCA941FCCCCCABE9A0A
data[source]: api
data[order_id]: N77579_31658163
data[external_reference]: N55548889
RAW BODY
event=invoice.created&data%5Bid%5D=1757E1D7FD5E410A9C563024250015BF&
data%5Bstatus%5D=pending&data%5Baccount_id%5D=70CA234077134ED0BF2E0E46B0EDC36F&
data%5Bsubscription_id%5D=F4115E5E28AE4CCA941FCCCCCABE9A0A
Mudança de estado da fatura
Esse gatilho será disparado quando uma fatura tem seu status atualizado na plataforma, geralmente é usado para validar quando ocorreu, ou não, o pagamento de uma fatura e disponibilizar um produto, ou serviço
| Parâmetro | Dados |
|---|---|
| event | invoice.status_changed |
| data[id] | ID da Fatura Ex: 1757E1D7FD5E410A9C563024250015BF |
| data[account_id] | ID da Conta Ex: 70CA234077134ED0BF2E0E46B0EDC36F |
| data[status] | Estado da Fatura (pending,paid, canceled, partially_paid, refunded, expired, authorized, externally_paid, in_protest, chargeback) Ex: paid |
| data[payment_method] | Método utilizado para pagamento da fatura Ex: iugu_bank_slip, iugu_credit_card ou iugu_pix |
| data[paid_at] | Data de realização do pagamento Ex: 2022-03-21T11:07:36.667Z |
| data[payer_cpf_cnpj] | CPF ou CNPJ do pagador da fatura Ex: 66535209008 |
| data[subscription_id] | ID da Assinatura a qual essa Fatura foi criada (Somente é enviado caso a fatura seja de uma assinatura) Ex: F4115E5E28AE4CCA941FCCCCCABE9A0A |
| data[pix_end_to_end_id] | End To End ID Para transações Pix |
| data[paid_cents] | Valor pago da fatura em centavos |
| data[order_id] | Número único que identifica o pedido de compra. Opcional, ajuda a evitar o pagamento da mesma fatura. Ex: N77579_31658163 |
| data[external_reference] | Informação de referência externa, possibilitando a realização de pesquisa EX: N55548889 |
event: invoice.status_changed
data[id]: 84F982E1A10F4FF1B483B829F4762C2C
data[account_id]: E6495D15290D47D3950C2A723D07A24E
data[status]: paid
data[payment_method]: iugu_pix
data[paid_at]: 2022-03-21T11:07:36.667Z
data[payer_cpf_cnpj]: 66535209008
data[subscription_id]: F4115E5E28AE4CCA941FCCCCCABE9A0A
data[order_id]: N77579_31658163
data[external_reference]: N55548889
RAW BODY
event=invoice.status_changed&data%5Bid%5D=84F982E1A10F4FF1B483B829F4762C2C&data%5Bstatus%5D=paid&data%5Baccount_id%5D=E6495D15290D47D3950C2A723D07A24E&data%5Bpayment_method%5D=iugu_pix&data%5Bpaid_at%5D=2022-03-21T11%3A07%3A36.667Z&data%5Bpayer_cpf_cnpj%5D=66535209008&
data%5Bsubscription_id%5D=F4115E5E28AE4CCA941FCCCCCABE9A0A
Status de registro de fatura
Esse gatilho é disparado uma vez que um boleto é registrado na plataforma, onde é possível validar seu status atual, geralmente é usado para validar se o boleto foi registrado com sucesso, cancelado, ou se está em processamento
| event | invoice.bank_slip_status |
| data[id] | ID da Fatura Ex: 1757E1D7FD5E410A9C563024250015BF |
| data[account_id] | ID da Conta Ex: 70CA234077134ED0BF2E0E46B0EDC36F |
| data[status] | Estado do registro (processing, registered, canceled, none, error) Ex: processing |
| data[external_reference] | Informação de referência externa, possibilitando a realização de pesquisa EX: N55548889 |
event: invoice.bank_slip_status
data[id]: 1757E1D7FD5E410A9C563024250015BF
data[account_id]: 70CA234077134ED0BF2E0E46B0EDC36F
data[status]: processing
data[external_reference]: N55548889
event=invoice.bank_slip_status&data%5Bid%5D=1757E1D7FD5E410A9C563024250015BF&
data%5Bstatus%5D=processing&data%5Baccount_id%5D=70CA234077134ED0BF2E0E46B0EDC36F
Reembolso de fatura
Esse gatilho é disparado quando realizado o reembolso de uma fatura de forma manual no painel da iugu, geralmente é usado para atualizar o status da aplicação que recebe os gatilhos
| Parâmetro | Dados |
|---|---|
| event | invoice.refund |
| data[id] | ID da Fatura Ex: 1757E1D7FD5E410A9C563024250015BF |
| data[account_id] | ID da Conta Ex: 70CA234077134ED0BF2E0E46B0EDC36F |
| data[status] | refunded |
| data[subscription_id] | ID da Assinatura a qual essa Fatura foi criada (Somente é enviado caso a fatura seja de uma assinatura) Ex: F4115E5E28AE4CCA941FCCCCCABE9A0A |
| data[order_id] | Número único que identifica o pedido de compra. Opcional, ajuda a evitar o pagamento da mesma fatura. Ex: N77579_31912363 |
| data[external_reference] | Informação de referência externa, possibilitando a realização de pesquisa EX: N55548889 |
event: invoice.refund
data[id]: 1757E1D7FD5E410A9C563024250015BF
data[account_id]: 70CA234077134ED0BF2E0E46B0EDC36F
data[status]: refunded
data[subscription_id]: F4115E5E28AE4CCA941FCCCCCABE9A0A
data[order_id]: N77579_31912363
data[external_reference]: N55548889
RAW BODY
event=invoice.refund&data%5Bid%5D=1757E1D7FD5E410A9C563024250015BF&
data%5Bstatus%5D=refunded&data%5Baccount_id%5D=70CA234077134ED0BF2E0E46B0EDC36F&
data%5Bsubscription_id%5D=F4115E5E28AE4CCA941FCCCCCABE9A0A
Falha no pagamento da fatura
Esse gatilho é disparado quando ocorre uma rejeição em uma transação de cartão de crédito, comumente é usado para clientes que utilizam assinatura
| Parâmetro | Dados |
|---|---|
| event | invoice.payment_failed |
| data[id] | ID da Fatura Ex: 1757E1D7FD5E410A9C563024250015BF |
| data[account_id] | ID da Conta Ex: 70CA234077134ED0BF2E0E46B0EDC36F |
| data[status] | pending |
| data[subscription_id] | ID da Assinatura a qual essa Fatura foi criada (Somente é enviado caso a fatura seja de uma assinatura) Ex: F4115E5E28AE4CCA941FCCCCCABE9A0A |
| data[lr] | Código de retorno da operadora do cartão Ex: 51 Ver Tabela de LR |
| data[external_reference] | Informação de referência externa, possibilitando a realização de pesquisa EX: N55548889 |
event: invoice.payment_failed
data[id]: 1757E1D7FD5E410A9C563024250015BF
data[account_id]: 70CA234077134ED0BF2E0E46B0EDC36F
data[status]: pending
data[subscription_id]: F4115E5E28AE4CCA941FCCCCCABE9A0A
data[lr]: 51
data[external_reference]: N55548889
RAW BODY
event=invoice.payment_failed&data%5Bid%5D=1757E1D7FD5E410A9C563024250015BF&
data%5Bstatus%5D=pending&data%5Baccount_id%5D=70CA234077134ED0BF2E0E46B0EDC36F&
data%5Bsubscription_id%5D=F4115E5E28AE4CCA941FCCCCCABE9A0A&data%5Blr%5D=51
Vencimento de Fatura
Esse gatilho é disparado quando uma fatura tem sua data de vencimento atingida.
| Parâmetro | Dados |
|---|---|
| event | invoice.due |
| data[id] | ID da Fatura Ex: 1757E1D7FD5E410A9C563024250015BF |
| data[account_id] | ID da Conta Ex: 70CA234077134ED0BF2E0E46B0EDC36F |
| data[status] | pending |
| data[subscription_id] | ID da Assinatura a qual essa Fatura foi criada (Somente é enviado caso a fatura seja de uma assinatura) Ex: F4115E5E28AE4CCA941FCCCCCABE9A0A |
| data[external_reference] | Informação de referência externa, possibilitando a realização de pesquisa EX: N55548889 |
event: invoice.due
data[id]: 1757E1D7FD5E410A9C563024250015BF
data[account_id]: 70CA234077134ED0BF2E0E46B0EDC36F
data[status]: pending
data[subscription_id]: F4115E5E28AE4CCA941FCCCCCABE9A0A
data[external_reference]: N55548889
RAW BODY
event=invoice.due&data%5Bid%5D=1757E1D7FD5E410A9C563024250015BF&
data%5Bstatus%5D=pending&data%5Baccount_id%5D=70CA234077134ED0BF2E0E46B0EDC36F&
data%5Bsubscription_id%5D=F4115E5E28AE4CCA941FCCCCCABE9A0A
Ação de gestão de cobrança
Esse gatilho é disparado quando ocorre uma tentativa de cobrança por parte da iugu e a mesma não ocorre com sucesso.
Essa notificação será enviada de acordo com a configuração da régua de cobrança configurada na plataforma.
| Parâmetro | Dados |
|---|---|
| event | invoice.dunning_action |
| data[id] | ID da Fatura Ex: 1757E1D7FD5E410A9C563024250015BF |
| data[account_id] | ID da Conta Ex: 70CA234077134ED0BF2E0E46B0EDC36F |
| data[status] | Estado da Fatura (pending ou expired) Ex: pending |
| data[subscription_id] | ID da Assinatura a qual essa Fatura foi criada (Somente é enviado caso a fatura seja de uma assinatura) Ex: F4115E5E28AE4CCA941FCCCCCABE9A0A |
| data[action] | Ação realizada pela gestão de cobrança (charge ou expire) Ex: charge |
| data[external_reference] | Informação de referência externa, possibilitando a realização de pesquisa EX: N55548889 |
event: invoice.dunning_action
data[id]: 1757E1D7FD5E410A9C563024250015BF
data[account_id]: 70CA234077134ED0BF2E0E46B0EDC36F
data[status]: pending
data[subscription_id]: F4115E5E28AE4CCA941FCCCCCABE9A0A
data[action]: charge
data[external_reference]: N55548889
RAW BODY
event=invoice.dunning_action&data%5Bid%5D=1757E1D7FD5E410A9C563024250015BF&
data%5Bstatus%5D=pending&data%5Baccount_id%5D=70CA234077134ED0BF2E0E46B0EDC36F&
data%5Bsubscription_id%5D=F4115E5E28AE4CCA941FCCCCCABE9A0A&
data%5Baction%5D=charge
Parcela da fatura liberada
Esse gatilho é disparado uma vez que ocorrer o pagamento de uma parcela de um parcelamento, onde será informado o valor pago e o número da parcela.
Aviso
Este gatilho é enviado somente em ambiente produção. (live mode)
| Parâmetro | Dados |
|---|---|
| event | invoice.installment_released |
| data[id] | ID da Fatura Ex: 1757E1D7FD5E410A9C563024250015BF |
| data[account_id] | ID da Conta Ex: 70CA234077134ED0BF2E0E46B0EDC36F |
| data[status] | paid |
| data[subscription_id] | ID da Assinatura a qual essa Fatura foi criada (Somente é enviado caso a fatura seja de uma assinatura) Ex: F4115E5E28AE4CCA941FCCCCCABE9A0A |
| data[installment] | Número da parcela liberada Ex: 1 |
| data[number_of_installments] | Total de parcelas da fatura Ex: 12 |
| data[amount] | Valor da parcela liberada Ex: 10.00 |
| data[amount_cents] | Valor a transferir em centavos Ex: 10081 |
| data[order_id] | Número único que identifica o pedido de compra. Opcional, ajuda a evitar o pagamento da mesma fatura. Ex: N77579_31912363 |
| data[external_reference] | Informação de referência externa, possibilitando a realização de pesquisa EX: N55548889 |
event: invoice.installment_released
data[id]: 1757E1D7FD5E410A9C563024250015BF
data[account_id]: 70CA234077134ED0BF2E0E46B0EDC36F
data[status]: paid
data[subscription_id]: F4115E5E28AE4CCA941FCCCCCABE9A0A
data[installment]: 1
data[number_of_installments]: 12
data[amount]: 10.00
data[amount_cents]: 10081
data[order_id]: N77579_31912363
data[external_reference]: N55548889
RAW BODY
event=invoice.installment_released&data%5Bid%5D=1757E1D7FD5E410A9C563024250015BF&
data%5Bstatus%5D=paid&data%5Baccount_id%5D=70CA234077134ED0BF2E0E46B0EDC36F&
data%5Bsubscription_id%5D=F4115E5E28AE4CCA941FCCCCCABE9A0A&
data%5Binstallment%5D=1&data%5Bnumber_of_installments%5D=12&
data%5Bamount%5D=10.00
Fatura liberada
Esse gatilho é disparado uma vez que liquidado todas as parcelas de uma fatura em um pagamento, ou quando ocorre o pagamento de uma fatura com método de cartão de crédito (à vista ou parcelado).
Para o método de pagamento boleto quando o valor da fatura é compensado, será disparado o gatilho. Já para o Pix o gatilho é disparado uma vez que ocorrer o pagamento.
Aviso
Este gatilho é enviado somente em ambiente produção. (live mode)
| Parâmetro | Dados |
|---|---|
| event | invoice.released |
| data[id] | ID da Fatura Ex: 1757E1D7FD5E410A9C563024250015BF |
| data[status] | paid |
| data[account_id] | |
| data[number_of_installments] | Total de parcelas da fatura Ex: 12 |
| data[payment_method] | Método utilizado para pagamento da fatura Ex: iugu_bank_slip ou iugu_credit_card |
| data[subscription_id] | ID da Assinatura a qual essa Fatura foi criada (Somente é enviado caso a fatura seja de uma assinatura) Ex: F4115E5E28AE4CCA941FCCCCCABE9A0A |
| data[amount] | Valor da parcela liberada Ex: 1000 |
| data[total] | Total cobrado. Ex: : 45800000 |
| data[taxes] | Número único que identifica o pedido de compra. Opcional, ajuda a evitar o pagamento da mesma fatura. Ex: 250 |
| data[fines] | Booleano para Habilitar ou Desabilitar multa por atraso de pagamento Ex: 0 |
| data[discount] | Valor dos Descontos Ex: 10.00 |
| data[client_share] | Valor da fatura descontando as tarifas de processamento e comissões. Ex: 45799750 |
| data[net_value] | valor da fatura descontando as tarifas de processamento e comissões. Ex: 45799750 |
| data[early_payment_discount] | Ativa ou desativa os descontos por pagamento antecipado. Quando true, sobrepõe as configurações de desconto da conta. Ex: 0 |
| data[occurrence_date] | Data da ocorrência Ex: '2022-07-12' |
| data[account_number_last_digits] | Se o pagamento for em pix, ele traz os últimos 4 números da conta bancaria do pagador. Ex: '3730' |
| data[paid_at] | Pago em: Ex: 2022-07-12 17:33:20.699791368 |
| data[external_reference] | Informação de referência externa, possibilitando a realização de pesquisa EX: N55548889 |
event: invoice.released
data[id]: 1757E1D7FD5E410A9C563024250015BF
data[account_id]: 70CA234077134ED0BF2E0E46B0EDC36F
data[status]: paid
data[subscription_id]: F4115E5E28AE4CCA941FCCCCCABE9A0A
data[number_of_installments]: 12
data[amount]: 10.00
data[payment_method]: iugu_bank_slip
data[total]: 45800000
data[taxes]: 250
data[fines]: 0
data[discount]: 1000
data[client_share]: 45799750
data[net_value]: 45799750
data[early_payment_discount]: 0
data[occurrence_date]: '2022-07-12'
data[account_number_last_digits]: '3730'
data[paid_at]: 2022-07-12 17:33:20.699791368
data[external_reference]: N55548889
RAW BODY
event=invoice.released&data%5Bid%5D=1757E1D7FD5E410A9C563024250015BF&
data%5Bstatus%5D=paid&data%5Baccount_id%5D=70CA234077134ED0BF2E0E46B0EDC36F&
data%5Bsubscription_id%5D=F4115E5E28AE4CCA941FCCCCCABE9A0A&
data%5Bnumber_of_installments%5D=12&data%5Bamount%5D=10.00&
data%5Bpayment_method%5D=iugu_bank_slip
Assinatura suspensa
Esse gatilho é disparado uma vez que ocorrer a suspensão de uma assinatura.
| Parâmetro | Dados |
|---|---|
| event | subscription.suspended |
| data[id] | ID da Assinatura Ex: F4115E5E28AE4CCA941FCCCCCABE9A0A |
| data[account_id] | ID da Conta Ex: 70CA234077134ED0BF2E0E46B0EDC36F |
event: subscription.suspended
data[id]: 1757E1D7FD5E410A9C563024250015BF
data[account_id]: 70CA234077134ED0BF2E0E46B0EDC36F
RAW BODY
event=subscription.suspended&data%5Bid%5D=1757E1D7FD5E410A9C563024250015BF&
data%5Baccount_id%5D=70CA234077134ED0BF2E0E46B0EDC36F
Assinatura expirada
Esse gatilho é disparado quando uma assinatura tem o seu término concluído, ou seja, não tem mais nenhuma cobrança definida para ela.
| Parâmetro | Dados |
|---|---|
| event | subscription.expired |
| data[id] | ID da Assinatura Ex: F4115E5E28AE4CCA941FCCCCCABE9A0A |
| data[account_id] | ID da Conta Ex: 70CA234077134ED0BF2E0E46B0EDC36F |
| data[customer_name] | Nome do Cliente Ex: John Doe |
| data[customer_email] | E-mail do Cliente Ex: [email protected] |
| data[expires_at] | Data de Expiração (Vencimento) Ex: 2017-06-15 |
event: subscription.expired
data[id]: 1757E1D7FD5E410A9C563024250015BF
data[account_id]: 70CA234077134ED0BF2E0E46B0EDC36F
data[customer_name]: John Doe
data[customer_email]: [email protected]
data[expires_at]: 2017-06-15
RAW BODY
event=subscription.expired&data%5Bid%5D=1757E1D7FD5E410A9C563024250015BF&
data%5Baccount_id%5D=70CA234077134ED0BF2E0E46B0EDC36F&
data%5Bcustomer_name%5D=John%20Doe&data%5Bcustomer_email%[email protected]&
data%5Bexpires_at%5D=2017-06-15
Assinatura ativada
Esse gatilho é disparado quando uma assinatura tem o seu status alterado para ativo.
| Parâmetro | Dados |
|---|---|
| event | subscription.activated |
| data[id] | ID da Assinatura Ex: F4115E5E28AE4CCA941FCCCCCABE9A0A |
| data[account_id] | ID da Conta Ex: 70CA234077134ED0BF2E0E46B0EDC36F |
event: subscription.activated
data[id]: 1757E1D7FD5E410A9C563024250015BF
data[account_id]: 70CA234077134ED0BF2E0E46B0EDC36F
RAW BODY
event=subscription.activated&data%5Bid%5D=1757E1D7FD5E410A9C563024250015BF&
data%5Baccount_id%5D=70CA234077134ED0BF2E0E46B0EDC36F
Assinatura criada
Esse gatilho é disparado quando uma assinatura é criada em uma conta iugu.
| Parâmetro | Dados |
|---|---|
| event | subscription.created |
| data[id] | ID da Assinatura Ex: F4115E5E28AE4CCA941FCCCCCABE9A0 |
| data[account_id] | ID da Conta Ex: 70CA234077134ED0BF2E0E46B0EDC36F |
| data[customer_name] | Nome do Cliente Ex: John Doe |
| data[customer_email] | E-mail do Cliente Ex: [email protected] |
event: subscription.created
data[id]: 1757E1D7FD5E410A9C563024250015BF
data[account_id]: 70CA234077134ED0BF2E0E46B0EDC36F
data[customer_name]: John Doe
data[customer_email]: [email protected]
RAW BODY
event=subscription.expired&data%5Bid%5D=1757E1D7FD5E410A9C563024250015BF&
data%5Baccount_id%5D=70CA234077134ED0BF2E0E46B0EDC36F&
data%5Bcustomer_name%5D=John%20Doe&data%5Bcustomer_email%[email protected]
Assinatura renovada
Quando uma assinatura é renovada na plataforma é disparado esse evento.
| Parâmetro | Dados |
|---|---|
| event | subscription.renewed |
| data[id] | ID da Assinatura Ex: F4115E5E28AE4CCA941FCCCCCABE9A0A |
| data[account_id] | ID da Conta Ex: 70CA234077134ED0BF2E0E46B0EDC36F |
| data[customer_name] | Nome do Cliente Ex: John Doe |
| data[customer_email] | E-mail do Cliente Ex: [email protected] |
event: subscription.renewed
data[id]: 1757E1D7FD5E410A9C563024250015BF
data[account_id]: 70CA234077134ED0BF2E0E46B0EDC36F
data[customer_name]: John Doe
data[customer_email]: [email protected]
RAW BODY
event=subscription.renewed&data%5Bid%5D=1757E1D7FD5E410A9C563024250015BF&
data%5Baccount_id%5D=70CA234077134ED0BF2E0E46B0EDC36F&
data%5Bcustomer_name%5D=John%20Doe&data%5Bcustomer_email%[email protected]
Assinatura alterada
Quando uma assinatura é alterada na plataforma é disparado esse gatilho indicando que ocorreu uma modificação.
| Parâmetro | Dados |
|---|---|
| event | subscription.changed |
| data[id] | ID da Assinatura Ex: F4115E5E28AE4CCA941FCCCCCABE9A0A |
| data[account_id] | ID da Conta Ex: 70CA234077134ED0BF2E0E46B0EDC36F |
| data[customer_name] | Nome do Cliente Ex: John Doe |
| data[customer_email] | E-mail do Cliente Ex: [email protected] |
| data[expires_at] | Data de Expiração Ex: 2017-06-15 |
| data[plan_identifier] | Identificador do Plano Ex: basic_plan |
event: subscription.changed
data[id]: 1757E1D7FD5E410A9C563024250015BF
data[account_id]: 70CA234077134ED0BF2E0E46B0EDC36F
data[customer_name]: John Doe
data[customer_email]: [email protected]
data[expires_at]: 2017-06-15
data[plan_identifier]: basic_plan
RAW BODY
event=subscription.changed&data%5Bid%5D=1757E1D7FD5E410A9C563024250015BF&
data%5Baccount_id%5D=70CA234077134ED0BF2E0E46B0EDC36F&
data%5Bcustomer_name%5D=John%20Doe&data%5Bcustomer_email%[email protected]&
data%5Bexpires_at%5D=2017-06-15&data%5Bplan_identifier%5D=basic_plan
Alerta
Os gatilhos abaixo, referentes as ações de subcontas, são enviados somente em modo produção (live mode).
Verificação de Subconta
Ao realizar a verificação de uma conta a plataforma disponibiliza esse gatilho, onde pode ser validado se ocorreu uma rejeição ou o aceite da subconta.
| Parâmetro | Dados |
|---|---|
| event | referrals.verification |
| data[id] | ID da Verificação Ex: 4857E1D7FD5E410A9C563024250015TC |
| data[account_id] | ID da Conta Ex: 70CA234077134ED0BF2E0E46B0EDC36F |
| data[status] | Status da Verificação (accepted ou rejected) Ex: accepted |
| data[feedback] | Mensagem de Rejeicão (Somente quando a verificação for rejeitada) |
| data[charge_limit_cents] | Limite da Conta em centavos (Caso seja verificada) |
event: referrals.verification
data[id]: 4857E1D7FD5E410A9C563024250015TC
data[account_id]: 70CA234077134ED0BF2E0E46B0EDC36F
data[status]: rejected
data[feedback]: dados invalidos
data[charge_limit_cents]: null
RAW BODY
event=referrals.verification&data%5Bid%5D=4857E1D7FD5E410A9C563024250015TC&
data%5Baccount_id%5D=70CA234077134ED0BF2E0E46B0EDC36F&
data%5Bstatus%5D=rejected&data%5Bfeedback%5D=dados%20invalidos&
data%5Bcharge_limit_cents%5D=null
Mudança de dados bancários de Subconta
| Parâmetro | Dados |
|---|---|
| event | referrals.bank_verification |
| data[id] | ID da Verificação Ex: 4857E1D7FD5E410A9C563024250015TC |
| data[account_id] | ID da Conta Ex: 70CA234077134ED0BF2E0E46B0EDC36F |
| data[status] | Status da Verificação (accepted ou rejected) Ex: accepted |
| data[feedback] | Mensagem de Rejeicão (Somente quando a verificação foi rejeitada) Ex: Dados incorretos |
event: referrals.bank_verification
data[id]: 4857E1D7FD5E410A9C563024250015TC
data[account_id]: 70CA234077134ED0BF2E0E46B0EDC36F
data[status]: accepted
data[feedback]: null
RAW BODY
event=referrals.bank_verification&data%5Bid%5D=4857E1D7FD5E410A9C563024250015TC&
data%5Baccount_id%5D=70CA234077134ED0BF2E0E46B0EDC36F&
data%5Bstatus%5D=accepted&data%5Bfeedback%5D=null
Requisição de transferência bancária criada
| Parâmetro | Dados |
|---|---|
| event | withdraw_request.created |
| data[withdraw_request_id] | ID da Requisição de transferência bancária Ex: 56CBD1D7FD5E410A9C563024252043CE |
| data[account_id] | ID da Conta Ex: 70CA234077134ED0BF2E0E46B0EDC36F |
| data[status] | Status da Requisição de transferência bancária Ex: pending |
| data[agreement_effect] | Booleano, se é um efeito de contrato Saque originado por recebíveis vendidos para outras empresas Ex: false |
event: withdraw_request.created
data[withdraw_request_id]: 56CBD1D7FD5E410A9C563024252043CE
data[account_id]: 70CA234077134ED0BF2E0E46B0EDC36F
data[status]: pending
data[agreement_effect]: false
RAW BODY
event=withdraw_request.created&
data%5Bwithdraw_request_id%5D=56CBD1D7FD5E410A9C563024252043CE&
data%5Baccount_id%5D=70CA234077134ED0BF2E0E46B0EDC36F&
data%5Bstatus%5D=pending
Mudança de estado de requisição de transferência bancária
| Parâmetro | Dados |
|---|---|
| event | withdraw_request.status_changed |
| data[withdraw_request_id] | ID da Requisição de transferência bancária Ex: 56CBD1D7FD5E410A9C563024252043CE |
| data[account_id] | ID da Conta Ex: 70CA234077134ED0BF2E0E46B0EDC36F |
| data[status] | Status da Requisição de transferência bancária (processing, accepted ou rejected) Ex: rejected |
| data[feedback] | Mensagem de Rejeicão (Somente quando a transferência for rejeitada) Ex: Conta não existente |
| data[agreement_effect] | Booleano, se é um efeito de contrato Saque originado por recebíveis vendidos para outras empresas Ex: true |
event: withdraw_request.status_changed
data[withdraw_request_id]: 56CBD1D7FD5E410A9C563024252043CE
data[account_id]: 70CA234077134ED0BF2E0E46B0EDC36F
data[status]: rejected
data[feedback]: agencia ou conta inexistente
data[agreement_effect]: true
RAW BODY
event=withdraw_request.status_changed&
data%5Bwithdraw_request_id%5D=56CBD1D7FD5E410A9C563024252043CE&
data%5Baccount_id%5D=70CA234077134ED0BF2E0E46B0EDC36F&
data%5Bstatus%5D=rejected&data%5Bfeedback%5D=agencia%20ou%20conta%20inexistente
Forma de Pagamento do Cliente Criada
| Parâmetro | Dados |
|---|---|
| event | "customer_payment_method.new" |
| data[customer_payment_method_id] | ID do Método de Pagamento Ex: 70CA234077134ED0BF2E0E46B0EDC36F |
| data[customer_id] | ID do Cliente Ex: D667CDDA99054178952E8AD74E31141D |
| data[default_payment_method_id] | ID do Método de Pagamento Padrão Ex: 70CA234077134ED0BF2E0E46B0EDC36F |
| data[credit_card][token] | Token de Pagamento ex: ad40638d-7060-4daa-b660-16a11387748a |
| data[credit_card][year] | Ano da data de expiração do cartão Ex: 2028 |
| data[credit_card][month] | Mês da data de expiração do cartão Ex: 12 |
| data[credit_card][brand] | Bandeira |
| data[credit_card][holder] | Nome no cartão |
| data[credit_card][masked_number] | Número do cartão, apresentando apenas os últimos 4 dígitos Ex: XXXX-XXXX-XXXX-1234 |
event: customer_payment_method.new
data[customer_payment_method_id]: 70CA234077134ED0BF2E0E46B0EDC36F
data[customer_id]: D667CDDA99054178952E8AD74E31141D
data[default_payment_method_id]: 70CA234077134ED0BF2E0E46B0EDC36F
data[credit_card][token]: ad40638d-7060-4daa-b660-16a11387748a
data[credit_card][year]: 2028
data[credit_card][month]: 12
data[credit_card][brand]: Master
data[credit_card][holder]: John Doe
data[credit_card][masked_number]: XXXX-XXXX-XXXX-1234
RAW BODY
event=customer_payment_method.new&
data%5customer_payment_method_id%5D=70CA234077134ED0BF2E0E46B0EDC36F&
data%5customer_id%5D=D667CDDA99054178952E8AD74E31141D&
data%5default_payment_method_id%5D=70CA234077134ED0BF2E0E46B0EDC36F&
data%5credit_card%5D%5token%5D=ad40638d-7060-4daa-b660-16a11387748a&
data%5credit_card%5D%5year%5D=2028&
data%5credit_card%5D%5month%5D=12&data%5credit_card%5D%5brand%5D=Master&
data%5credit_card%5D%5holder%5D=John%20Doe&
data%5credit_card%5D%5masked_number%5D=XXXX-XXXX-XXXX-1234
Depósito Recebido
event: deposit.accepted
data[deposit_id]: 56CBD1D7FD5E410A9C563024252043CE
data[account_id]: 70CA234077134ED0BF2E0E46B0EDC36F
data[status]: accepted
RAW BODY
event=deposit.accepted&
data%deposit_id%5D=56CBD1D7FD5E410A9C563024252043CE&
data%5Baccount_id%5D=70CA234077134ED0BF2E0E46B0EDC36F&
data%5Bstatus%5D=accepted
Depósito Rejeitado
event: deposit.rejected
data[deposit_id]: 56CBD1D7FD5E410A9C563024252043CE
data[account_id]: 70CA234077134ED0BF2E0E46B0EDC36F
data[status]: rejected
RAW BODY
event=deposit.rejected&
data%deposit_id%5D=56CBD1D7FD5E410A9C563024252043CE&
data%5Baccount_id%5D=70CA234077134ED0BF2E0E46B0EDC36F&
data%5Bstatus%5D=rejected
Mudança de status do Depósito Recebido
Esse gatilho é disparado sempre que houver mudança no status do depósito recebido.
| Parâmetro | Dados |
|---|---|
| event | deposit.pix_status_changed |
| data[deposit_id] | ID do depósito recebido EX: 2BF8A5636B2F47317864C9B3D4E629B6 |
| data[status] | Estado do depósito (pending, processing, rejected, error, accepted, inconsistent, refunded, processing_refund) EX: pending |
| data[account_id] | ID da conta que recebeu o depósito EX: E6495D15290D47D3950C2A723D07A24E |
| data[amount_cents] | Valor do depósito em centavos EX: 10000 (100.00) |
| data[deposit_type] | PIX, TED, QrCode EX: PIX Obs.: Caso seja QrCode estático, será aprensentado como QrCode |
| data[sender_ispb] | ISPB do Domicilio Bancário que realizou o depósito EX: 98723456 |
| data[sender_compe] | COMPE do Domicilio Bancário que realizou o depósito EX: 237 |
| data[sender_bank_name] | Nome do Domicilio Bancário que realizou o depósito EX: Bradesco/Next |
| data[sender_bank_branch] | Agência do Domicilio Bancário que realizou o depósito EX: 0101 |
| data[sender_bank_account] | Conta do Domicilio Bancário que realizou o depósito EX: 162534 |
| data[sender_name] | Nome de quem realizou o depósito EX: Fernando Souza |
| data[sender_cpf_cnpj] | CPF/CNPJ de quem realizou o depósito EX: 19569121009 |
| data[receiver_ispb] | ISPB do Domicilio Bancário que recebeu o depósito EX: 28734982 |
| data[receiver_compe] | COMPE do Domicilio Bancário que recebeu o depósito EX: 401 |
| data[receiver_bank_name] | Nome do Domicilio Bancário que recebeu o depósito EX: IUGU IP S.A. |
| data[receiver_bank_branch] | Agência do Domicilio Bancário que recebeu o depósito EX: 0202 |
| data[receiver_bank_account] | Conta do Domicilio Bancário que recebeu o depósito EX: 9281375 |
| data[receiver_bank_account_digit] | Dígito da Conta do Domicilio Bancário que recebeu o depósito EX: 0 |
| data[receiver_name] | Nome de quem recebeu o depósito EX: Rodrigo Nascimento |
| data[receiver_cpf_cnpj] | CPF/CNPJ de quem recebeu o depósito EX: 83206207088 |
| data[transfered_at] | Data de recebimento do depósito EX: 2024-02-22T20:19:37.152Z |
| data[description] | Descrição de depósito EX: Doação |
| data[statement_identifier] | ID End-to-End EX: B60746648202602662019B2036BO954d |
event: deposit.pix_status_changed
data[deposit_id]]: 2BF8A5636B2F47317864C9B3D4E629B6
data[status]: pending
data[account_id]: E6495D15290D47D3950C2A723D07A24E
data[amount_cents]: 10000
data[deposit_type]: PIX
data[sender_ispb]: 98723456
data[sender_compe]: 237
data[sender_bank_name]: Bradesco/Next
data[sender_bank_branch]: 0101
data[sender_bank_account]: 162534
data[sender_name]: Fernando Souza
data[sender_cpf_cnpj]: 19569121009
data[receiver_ispb]: 28734982
data[receiver_compe]: 401
data[receiver_bank_name]: IUGU IP S.A.
data[receiver_bank_branch]: 0202
data[receiver_bank_account]: 9281375
data[receiver_bank_account_digit]: 0
data[receiver_name]: Rodrigo Nascimento
data[receiver_cpf_cnpj]: 83206207088
data[transfered_at]: 2024-02-22T20]:19]:37.152Z
data[description]: Doação
data[statement_identifier]: B60746648202602662019B2036BO954d
Mudança de status da transferência para terceiros
| Parâmetro | Dados |
|---|---|
| event | transfer_request.status_changed |
| data[id] | ID da Transferência para terceiros Ex: A480797C10D84053A480D7C37C6F3521 |
| data[account_id] | ID da Conta Ex: E6495D15290D47D3950C2A723D07A24E |
| data[status] | Estado da Transferência (pending, processing, rejected, refunded, done, error) Ex: done |
| data[total_refunded_amount_cents] | Valor total de estornos efetuados daquele pix de saída até agora. Ex: 100.00 |
| data[refunded_amount_cents] | Valor de um estorno em especifico (parcial). Ex: 10.00 |
| data[external_reference] | Número único que identifica o pedido de compra. Opcional, ajuda a evitar o pagamento da mesma fatura. Ex: N77579_31912363 |
event: transfer_request.status_changed
data[id]: A480797C10D84053A480D7C37C6F3521
data[account_id]: E6495D15290D47D3950C2A723D07A24E
data[status]: done
data[total_refunded_amount_cents]: 100.00
data[refunded_amount_cents]: 10.00
data[external_reference]: N55548889
RAW BODY
event=transfer_request.status_changed&data%5Bid%5D=A480797C10D84053A480D7C37C6F3521&data%5Bstatus%5D=done&data%5Baccount_id%5D=E6495D15290D47D3950C2A723D07A24E
Status da Simulação
Esse gatilho será enviado toda vez que uma simulação de antecipação estiver finalizada. Atenção: Esse gatilho será enviado apenas para antecipações por valor via Alia (portal do cliente) e API (no endoint: /v1/advancement_request).
| Parâmetro | Dados |
|---|---|
| event | advancement_request.simulation_status |
| data[status] | Estado da simulação error ou done Ex: done |
| data[total_advance_fee_cents] | Valor total de tarifas de antecipação em centavos |
| data[reached_amount_cents] | Valor total alcançado na antecipação, esse será o valor final recebido em centavos |
| data[average_days] | Tempo médio de dias que as parcelas serão antecipadas. Ex: 3 |
| data[available_amount_cents] | Valor total disponível para antecipar em centavos |
| data[simulation_amount_cents] | Valor utilizado para antecipar em centavos |
| data[requested_amount_cents] | Valor solicitado para antecipar em centavos |
event: advancement_request.simulation_status
data[status]: done
data[total_advance_fee_cents]: 49
data[reached_amount_cents]: 14587
data[average_days]: 3
data[available_amount_cents]: 48378
data[simulation_amount_cents]: 20000
data[requested_amount_cents]: 20000
RAW BODY
event=advancement_request.simulation_status&data%5Bstatus%5D=done&data%5Btotal_advance_fee_cents%5D=49&data%5Breached_amount_cents%5D=14587&data%5Baverage_days%5D=3&data%5Bavailable_amount_cents%5D=48378&data%5Bsimulation_amount_cents%5D=20000&data%5Brequested_amount_cents%5D=20000
Status da Antecipação
Esse gatilho será enviado toda vez que uma Antecipação for concluída.
| Parâmetro | Dados |
|---|---|
| event | advancement_request.simulation_status |
| data[status] | Estado da antecipação done ou error. Ex: done |
| data[total_advance_amount_cents] | Valor total antecipado em centavos |
| data[total_advance_fee_cents] | Tarifa total de antecipação em centavos |
| data[advancement_request_date] | Data e hora da antecipação Ex: 2022-11-09T11:47:15-03:00 |
| data[transaction_ids] | Ids das antecipações e ids das transações em cada antecipação. Ex: "D53897DA2976420883ABC5FAC7E122E3" => ["8"] |
event: advancement_request.advancement_status
data[status]: done,
data[total_advance_amount_cents]: 14587,
data[total_advance_fee_cents]: 36,
data[advancement_request_date]: 2022-11-09T11:47:15-03:00,
data[transaction_ids]: D53897DA2976420883ABC5FAC7E122E3 => [8]
RAW BODY
event=advancement_request.advancement_status&data%5Bstatus%5D=done&data%5Btotal_advance_amount_cents%5D=14587&data%5Btotal_advance_fee_cents%5D=36&data%5Badvancement_request_date%5D=2022-11-09T11%3A47%3A15-03%3A00&data%5Btransaction_ids%5D=%7B%22D53897DA2976420883ABC5FAC7E122E3%22%3D%3E%5B%228%22%5D%7D
Mudança de Status do Split
| Parâmetro | Dados |
|---|---|
| event | invoice.split_status_changed |
| data[id] | ID da Fatura |
| data[status] | Estado da Fatura (pending, paid, canceled, partially_paid,externally_paid, refunded, expired, authorized, in_protest, chargeback) Ex: pending |
| data[account_id] | ID da Conta que gerou a Fatura |
| data[async_charged] | |
| data[payment_method] | Método utilizado para pagamento da fatura Ex: iugu_bank_slip, iugu_credit_card ou iugu_pix |
| data[paid_at] | Data de realização do pagamento Ex: 2022-03-21T11:07:36.667Z |
| data[payer_cpf_cnpj] | CPF ou CNPJ do pagador da fatura Ex: 66535209008 |
| data[payer_name] | Nome do pagador da fatura Ex: Maria Silva |
| data[paid_cents] | Valor pago da fatura em centavos |
| data[pix_end_to_end_id] | End To End ID Para transações Pix |
| data[recipient_account_id] | ID da Conta comissionada pelo Split |
| data[amount_cents] | Valor do comissionamento em centavos |
| data[order_id] | Número único que identifica o pedido de compra. Opcional, ajuda a evitar o pagamento da mesma fatura. Ex: N77579_31912363 |
event: invoice.split_status_changed,
data[id]: 713D49698EAC45BD8F1235675E88365F,
data[status]: paid,
data[account_id]: C95D9BC7C2F123456DDF16990E9E3D51,
data[async_charged]: null,
data[payment_method]: iugu_pix,
data[paid_at]: 2023-12-11T17:45:00.772Z,
data[payer_cpf_cnpj]: 12356678801,
data[payer_name]: Maria Silva
data[paid_cents]: 300,
data[pix_end_to_end_id]: E18236121345672111744s001bd2b1f6,
data[recipient_account_id]: AEA384CE1234567A8862D76F354022EF,
data[amount_cents]: 30,
retry_count: 0
data[order_id]: N77579_31912363
RAW BODY
event=invoice.split_status_changed&data%5Bid%5D=713D1234567C45BD8F6114305E88365F&data%5Bstatus%5D=paid&data%5Baccount_id%5D=C95D9BC7C34556B88DDF16990E9E3D51&data%5Basync_charged%5D&data%5Bpayment_method%5D=iugu_pix&data%5Bpaid_at%5D=2023-12-11T17%3A45%3A00.772Z&data%5Bpayer_cpf_cnpj%5D=12356670801&data%5Bpayer_name%5D=Maria+Silva&data%5Bpaid_cents%5D=300&data%5Bpix_end_to_end_id%5D=E11345620202312111744s001bd2b1f6&data%5Brecipient_account_id%5D=AEA384CEBFCC491A8862D76F354022EF&data%5Bamount_cents%5D=30&retry_count=0
Updated 5 days ago