Fatura
Confira os eventos acionados por faturas e os dados enviados.
Fatura criada
Será acionado sempre que uma fatura for criada.
Parâmetro | Descrição | Exemplo |
---|---|---|
event | Nome do evento | invoice.created |
data[id] | ID da Fatura | 1757E1D7FD5E410A9C563024250015BF |
data[payment_booklet_id] | ID do Carnê | 98F604CD45B14777B6E7847F667A94AF |
data[source] | Por onde a invoice foi criada | api |
data[account_id] | ID da Conta | 70CA234077134ED0BF2E0E46B0EDC36F |
data[status] | Status da Fatura | pending , paid , canceled , partially_paid ,externally_paid , refunded , expired , authorized , in_protest , chargeback |
data[subscription_id] | ID da Assinatura a qual essa Fatura foi criada (Enviado apenas para faturas criadas por Assinaturas) | F4115E5E28AE4CCA941FCCCCCABE9A0A |
data[source] | Recurso utilizado para criação da fatura | api , alia , payment_booklet (carnê), subscription |
data[async_charged] | Boolean que indica se a cobrança foi automática (Régua de Cobrança) ou não | true ou false |
data[order_id] | Número único que identifica o pedido de compra. Opcional. Auxilia na prevenção de pagamento da mesma fatura. | N77579_31658163 |
data[external_reference] | Informação de referência externa, possibilitando pesquisar através do endpoint Listar/Buscar Faturas | N55548889 |
Mudança de Status da Fatura
Acionado sempre que o status de uma Fatura é alterado.
Parâmetro | Descrição | Exemplo |
---|---|---|
event | Nome do evento | invoice.status_changed |
data[id] | ID da Fatura | 1757E1D7FD5E410A9C563024250015BF |
data[payment_booklet_id] | ID do Carnê | 98F604CD45B14777B6E7847F667A94AF |
data[account_id] | ID da Conta | 70CA234077134ED0BF2E0E46B0EDC36F |
data[status] | Status da Fatura | paid , canceled , partially_paid , refunded , expired , authorized , externally_paid , in_protest , chargeback |
data[payment_method] | Método utilizado para pagamento da fatura | iugu_bank_slip , iugu_credit_card ou iugu_pix |
data[paid_at] | Data de realização do pagamento | 2022-03-21T11:07:36.667Z |
data[payer_cpf_cnpj] | CPF ou CNPJ do pagador da fatura | 66535209008 |
data[subscription_id] | ID da Assinatura a qual essa Fatura foi gerada (se gerada a partir de uma assinatura) | F4115E5E28AE4CCA941FCCCCCABE9A0A |
data[pix_end_to_end_id] | End To End ID Para transações Pix | c2403281-a401-496b-af0e-53b7e16ba207 |
data[paid_cents] | Valor Pago da Fatura | 100 |
data[order_id] | Número único que identifica o pedido de compra. Opcional. Auxilia na prevenção de pagamento da mesma fatura. | N77579_31658163 |
data[async_charged] | Boolean que indica se a cobrança foi automática (Régua de Cobrança) ou não. | true ou false |
data[external_reference] | Informação de referência externa, possibilitando pesquisar através do endpoint Listar/Buscar Faturas | N55548889 |
Status de Registro de Boleto Bancário
Acionado sempre que um Boleto Bancário (bank_slip
) é registrado. Permite, também, verificar o status atual.
Parâmetro | Descrição | Exemplo |
---|---|---|
event | Nome do Evento | invoice.bank_slip_status |
data[id] | ID da Fatura | 1757E1D7FD5E410A9C563024250015BF |
data[payment_booklet_id] | ID do Carnê | 98F604CD45B14777B6E7847F667A94AF |
data[account_id] | ID da Conta | 70CA234077134ED0BF2E0E46B0EDC36F |
data[status] | Estado do registro Ex: processing | processing , registered , canceled , none , error |
data[external_reference] | Informação de referência externa, possibilitando pesquisar através do endpoint Listar/Buscar Faturas | N55548889 |
Reembolso de Fatura
Acionado sempre que uma Fatura tem seu status alterado para refunded
(reembolsado).
Parâmetro | Descrição | Exemplo |
---|---|---|
event | Nome do Evento | invoice.refund |
data[id] | ID da Fatura | 1757E1D7FD5E410A9C563024250015BF |
data[payment_booklet_id] | ID do Carnê | 98F604CD45B14777B6E7847F667A94AF |
data[account_id] | ID da Conta | 70CA234077134ED0BF2E0E46B0EDC36F |
data[status] | Status da Fatura | refunded |
data[subscription_id] | ID da Assinatura a qual essa Fatura foi gerada (se gerada a partir de uma assinatura) | F4115E5E28AE4CCA941FCCCCCABE9A0A |
data[order_id] | Número único que identifica o pedido de compra. Opcional. Auxilia na prevenção de pagamento da mesma fatura. | N77579_31912363 |
data[external_reference] | Informação de referência externa, possibilitando pesquisar através do endpoint Listar/Buscar Faturas | N55548889 |
Falha no pagamento da Fatura
Acionado sempre que há falha no pagamento de qualquer fatura.
Parâmetro | Descrição | Exemplo |
---|---|---|
event | Nome do Evento | invoice.payment_failed |
data[id] | ID da Fatura | 1757E1D7FD5E410A9C563024250015BF |
data[payment_booklet_id] | ID do Carnê | 98F604CD45B14777B6E7847F667A94AF |
data[account_id] | ID da Conta | 70CA234077134ED0BF2E0E46B0EDC36F |
data[status] | Status da Fatura | pending |
data[subscription_id] | ID da Assinatura a qual essa Fatura foi gerada (se gerada a partir de uma assinatura) | F4115E5E28AE4CCA941FCCCCCABE9A0A |
data[lr] | Código de retorno da operadora do cartão | 51 Ver Tabela de LR |
data[external_reference] | Informação de referência externa, possibilitando pesquisar através do endpoint Listar/Buscar Faturas | N77579_31912363 |
Vencimento da Fatura
Acionado sempre que a data de vencimento de uma fatura é atingida.
Parâmetro | Descrição | Exemplo |
---|---|---|
event | Nome do Evento | invoice.due |
data[id] | ID da Fatura | 1757E1D7FD5E410A9C563024250015BF |
data[payment_booklet_id] | ID do Carnê | 98F604CD45B14777B6E7847F667A94AF |
data[account_id] | ID da Conta | 70CA234077134ED0BF2E0E46B0EDC36F |
data[status] | Status da Fatura | pending |
data[subscription_id] | ID da Assinatura a qual essa Fatura foi gerada (se gerada a partir de uma assinatura) | F4115E5E28AE4CCA941FCCCCCABE9A0A |
data[external_reference] | Informação de referência externa, possibilitando pesquisar através do endpoint Listar/Buscar Faturas | N55548889 |
Ação de Gestão de Cobrança
Acionado sempre que a cobrança realizada pela Régua de Cobrança não é bem sucedida.
Parâmetro | Descrição | Exemplo |
---|---|---|
event | Nome do Evento | invoice.dunning_action |
data[id] | ID da Fatura | 1757E1D7FD5E410A9C563024250015BF |
data[payment_booklet_id] | ID do Carnê | 98F604CD45B14777B6E7847F667A94AF |
data[account_id] | ID da Conta | 70CA234077134ED0BF2E0E46B0EDC36F |
data[status] | Status da Fatura | pending ou expired |
data[subscription_id] | ID da Assinatura a qual essa Fatura foi gerada (se gerada a partir de uma assinatura) | F4115E5E28AE4CCA941FCCCCCABE9A0A |
data[action] | Ação realizada pela gestão de cobrança | charge ou expire |
data[external_reference] | Informação de referência externa, possibilitando pesquisar através do endpoint Listar/Buscar Faturas | N55548889 |
Parcela da Fatura Liberada
Acionado sempre que uma parcela de uma fatura for paga, informando o valor e o número da parcela.
Parâmetro | Descrição | Exemplo |
---|---|---|
event | Nome do Evento | invoice.installment_released |
data[id] | ID da Fatura | 1757E1D7FD5E410A9C563024250015BF |
data[payment_booklet_id] | ID do Carnê | 98F604CD45B14777B6E7847F667A94AF |
data[account_id] | ID da Conta | 70CA234077134ED0BF2E0E46B0EDC36F |
data[status] | Status da Fatura | pending ou paid |
data[subscription_id] | ID da Assinatura a qual essa Fatura foi gerada (se gerada a partir de uma assinatura) | F4115E5E28AE4CCA941FCCCCCABE9A0A |
data[installment] | Número da parcela liberada | de 1 a 12 |
data[number_of_installments] | Total de parcelas da fatura | de 1 a 12 |
data[amount] | Valor da parcela liberada | 10.00 |
data[amount_cents] | Valor da parcela em centavos | 1000 |
data[order_id] | Número único que identifica o pedido de compra. Opcional. Auxilia na prevenção de pagamento da mesma fatura. | N77579_31912363 |
data[external_reference] | Informação de referência externa, possibilitando pesquisar através do endpoint Listar/Buscar Faturas | N55548889 |
Fatura liberada
Acionado sempre que uma Fatura é totalmente paga. Cada método de pagamento é acionado da seguinte forma:
Método | Quando... |
---|---|
Cartão de Crédito — credit_card | o pagamento é realizado à vista ou última parcela é quitada . |
Boleto Bancário — bank_slip | o valor da fatura é compensado. |
Pix — pix | o pagamento é realizado com sucesso . |
Parâmetro | Descrição | Exemplo |
---|---|---|
event | Nome do evento | invoice.released |
data[id] | ID da Fatura | 1757E1D7FD5E410A9C563024250015BF |
data[status] | Status da Fatura | paid |
data[account_id] | ID da Conta | 70CA234077134ED0BF2E0E46B0EDC36F |
data[async_charged] | Boolean que indica se a cobrança foi automática | true ou false |
data[number_of_installments] | Número de parcelas | 1 |
data[payment_method] | Método de pagamento utilizado | iugu_pix , iugu_credit_card ou iugu_bank_slip |
data[total] | Valor total da fatura | 16700 |
data[taxes] | Valor total de impostos | 10 |
data[fines] | Valor total de multas | 0 |
data[discount] | Valor de desconto aplicado | 0 |
data[client_share] | Valor destinado ao cliente | 16690 |
data[net_value] | Valor líquido da fatura | 16690 |
data[commission] | Comissão aplicada (split) | 0 |
data[total_cents] | Valor total da fatura em centavos | 16700 |
data[taxes_cents] | Valor total de impostos em centavos | 10 |
data[fines_cents] | Valor total de multas em centavos | 0 |
data[discount_cents] | Valor de desconto aplicado em centavos | (valor vazio) |
data[client_share_cents] | Valor destinado ao cliente em centavos | 16690 |
data[net_value_cents] | Valor líquido da fatura em centavos | 16690 |
data[commission_cents] | Comissão aplicada em centavos | 0 |
data[early_payment_discount] | Desconto por pagamento antecipado | 0 |
data[occurrence_date] | Data da ocorrência | 2024-11-11 |
data[total_paid_cents] | Valor total pago em centavos | 16700 |
data[total_paid] | Valor total pago | 167.0 |
data[paid_at] | Data e hora do pagamento | 2024-11-11T14:38:52.493Z |
data[amount] | Quantia recebida | 166.90 |
data[amount_cents] | Quantia recebida em centavos | 16690 |
data[account_number_last_digits] | Últimos dígitos do número da conta | 7709 |
data[order_id] | Número único que identifica o pedido de compra | 8-9fa19225-41ad-4edb-806d-f6a2472dd744 |
data[external_reference] | Informação de referência externa | 52522811 |
Parcela do Split liberado
Acionado sempre que uma parcela de um valor é liberado.
Parâmetro | Descrição | Exemplo |
---|---|---|
data[event] | Nome do Evento | invoice.split_installment_released |
data[id] | ID da fatura | INVOICE123456789 |
data[status] | Status da parcela | released |
data[account_id] | ID da conta associada à fatura | ACC987654321 |
data[async_charged] | Indicador de cobrança assíncrona | false |
data[installment] | Número da parcela atual | 3 |
data[number_of_installments] | Total de parcelas | 6 |
data[amount] | Valor total da parcela | 450.00 |
data[amount_cents] | Valor total da parcela em centavos | 45000 |
data[recipient_account_id] | ID da conta do recebedor da parcela | REC123456789 |
data[split_participant_amount_cents] | Valor da divisão do participante da parcela em centavos | 22500 |
Split Liberado
Acionado sempre que o valor do Split é liberado.
Parâmetro | Descrição | Exemplo |
---|---|---|
event | Nome do evento | invoice.split_released |
data[id] | ID da fatura | 8166A5675D8F42DCBDE72E7DF7EE16D5 |
data[status] | Status da fatura | paid |
data[account_id] | ID da conta associada à fatura | 27016E1AD888499A98994E781B6C3762 |
data[async_charged] | Cobrança assíncrona | true ou false |
data[number_of_installments] | Número de parcelas | 1 |
data[payment_method] | Método de pagamento utilizado | iugu_bank_slip , iugu_credit_card ou iugu_pix |
data[total] | Valor total da fatura | 400 |
data[taxes] | Valor dos impostos | 4 |
data[fines] | Valor das multas | 0 |
data[discount] | Valor do desconto aplicado | 10 |
data[client_share] | Valor da parte do cliente | 196 |
data[net_value] | Valor líquido da fatura | 396 |
data[commission] | Valor do split | 200 |
data[total_cents] | Valor total da fatura em centavos | 400 |
data[taxes_cents] | Valor dos impostos em centavos | 4 |
data[fines_cents] | Valor das multas em centavos | 0 |
data[discount_cents] | Valor do desconto em centavos | 10 |
data[client_share_cents] | Valor da parte do cliente em centavos | 196 |
data[net_value_cents] | Valor líquido da fatura em centavos | 396 |
data[commission_cents] | Valor do split em centavos | 200 |
data[early_payment_discount] | Desconto por pagamento antecipado | 0 |
data[occurrence_date] | Data da ocorrência | 2024-08-20 |
data[total_paid_cents] | Valor total pago em centavos | 400 |
data[total_paid] | Valor total pago | 4.0 |
data[paid_at] | Data e hora do pagamento | 2024-08-20T19:41:40.526Z |
data[amount] | Valor do pagamento | 3.96 |
data[amount_cents] | Valor do pagamento em centavos | 200 |
data[account_number_last_digits] | Últimos dígitos do número da conta do pagador | |
data[recipient_account_id] | ID da conta que recebeu o valor do Split | E638DCED176240E4A510510C065FB52D |
Mudança de Status do Split
Acionado sempre que um split tem o seu status alterado.
Parâmetro | Descrição | Exemplo |
---|---|---|
event | Nome do Evento | invoice.split_status_changed |
data[id] | ID da Fatura | 1757E1D7FD5E410A9C563024250015BF |
data[status] | Status da Fatura | paid , canceled , partially_paid , refunded , expired , authorized , externally_paid , in_protest , chargeback |
data[account_id] | ID da Conta que gerou a Fatura | E6495D15290D47D3950C2A723D07A24E |
data[async_charged] | Boolean que indica se a cobrança foi automática (Régua de Cobrança) ou não | true ou false |
data[payment_method] | Método utilizado para pagamento da fatura | iugu_bank_slip , iugu_credit_card ou iugu_pix |
Updated 6 days ago