Fatura (Invoice)

O evento referente à faturas dispara mensagens ao destinatário quando a fatura é fechada.

🚧
Importante
Recordamos que esta documentação apenas descreve os eventos na versão 2.0. Para saber os detalhes dos demais eventos do contexto "Invoice", acesse a documentação da versão 1.0.

Pré-requisitos

Para receber esses eventos, o parceiro deverá:

Configurar previamente o recebedor de eventos do webhook. Para mais informações, acesse a seção Webhooks na aba v1 deste manual.
Conhecer a estrutura básica dos eventos que acompanha o objeto data.

Informações sobre os eventos

Contexto e nome do evento

Os campos context e name poderão variar de acordo com a tabela a seguir:

`context`	`name`	Descrição
`Invoice`	`INVOICE_CLOSED`	Fatura do cartão fechada.

Identificador (`entityId`)

O campo entityId é o identificador da entidade emissora do evento e seu valor depende do contexto de sua emissão.

No contexto de fatura, o entityId é o identificador único da fatura (statementId).

Dados dos eventos

INVOICE_CLOSED

Este evento sinaliza que a fatura do cartão foi fechada.

Descrição do objeto `data` do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

Nome	Tipo	Descrição	Número máximo de caracteres
`statementId`	`integer`	Identificador único da fatura.	—
`month`	`integer`	Mês de vencimento da fatura.	—
`year`	`integer`	Ano de vencimento da fatura.	—
`cycle`	`integer`	Quantidade de dias do ciclo da fatura.	—
`cycleCloseDate`	`string`	Data de fechamento da fatura, no formato 8601 - UTC.	25
`dueDate`	`string`	Data de vencimento da fatura, no formato 8601 - UTC.	25
`balance[]`	`object`	Objeto que contém informações referentes ao valor total da fatura.	—
`balance.value`	`number`	Valor total da fatura.	decimal(18,2)
`balance.currency`	`string`	Código da moeda com base na ISO-4217.	3
`amountMinimal`	`object`	Objeto que contém informações sobre o valor de pagamento mínimo da fatura.	—
`amountMinimal.value`	`number`	Valor de pagamento mínimo da fatura.	decimal(18,2)
`amountMinimal.currency`	`string`	Código da moeda com base na ISO-4217.	3
`previousBalance`	`object`	Objeto que contém informações sobre o valor da fatura anterior.	—
`previousBalance.value`	`number`	Valor total da fatura.	decimal(18,2)
`previousBalance.currency`	`string`	Código da moeda com base na ISO-4217.	3
`residualBalance`	`object`	Objeto que contém informações sobre o saldo residual devedor ou credor da fatura anterior.	—
`residualBalance.value`	`number`	Valor total do saldo residual.	decimal(18,2)
`residualBalance.currency`	`string`	Código da moeda com base na ISO-4217.	3
`nextStatement`	`object`	Objeto que contém informações sobre a próxima fatura.	—
`nextStatement.statementId`	`integer`	Identificador único da próxima fatura.
`nextStatement.cycleCloseDate`	`string`	Data de fechamento da fatura, no formato 8601 - UTC.	25
`nextStatement.balance`	`number`	Valor total da próxima fatura, o qual pode ser negativo ou positivo.	decimal(18,2)
`nextStatement.installmentInterestFree`	`object`	Objeto que contém informações sobre a soma dos valores correspondentes às parcelas sem juros a vencer, que serão lançadas na próxima fatura.	—
`nextStatement.installmentInterestFree.value`	`number`	Soma das parcelas sem juros a vencer.	decimal(18,2)
`nextStatement.installmentInterestFree.currency`	`string`	Código da moeda com base na ISO-4217.	3
`nextStatement.installmentWithInterest`	`object`	Objeto que contém informações sobre a soma dos valores das parcelas com juros a vencer, que serão lançadas na próxima fatura.	—
`nextStatement.installmentWithInterest.value`	`number`	Soma dos valores das parcelas com juros a vencer.	decimal(18,2)
`nextStatement.installmentWithInterest.currency`	`string`	Código da moeda com base na ISO-4217.	3
`nextStatement.annuity`	`object`	Objeto que contém informações sobre a soma dos valores de anuidade, que será lançada na próxima fatura.	—
`nextStatement.annuity.value`	`number`	Soma dos valores de anuidade.	decimal(18,2)
`nextStatement.annuity.currency`	`string`	Código da moeda com base na ISO-4217.	3
`nextStatement.insurance`	`object`	Objeto que contém informações sobre a soma dos valores de seguro, que será lançada na próxima fatura.
`nextStatement.insurance.value`	`number`	Soma dos valores de seguro.	decimal(18,2)
`nextStatement.insurance.currency`	`string`	Código da moeda com base na ISO-4217.	3
`limits`	`object`	Objeto que retorna os limites atrelados à conta de crédito.
`limits.invoice`	`object`	Objeto que contém informações sobre o limite de crédito do cliente.
`limits.invoice.totalLimit`	`number`	Total do limite de crédito aprovado.	decimal(18,2)
`limits.invoice.availableLimit`	`number`	Limite de crédito disponível.	decimal(18,2)
`limits.invoice.limitActive`	`number`	Limite de crédito habilitado pelo cliente.	decimal(18,2)
`limits.withdrawal`	`object`	Objeto que contém informações sobre o limite de saque do cliente.
`limits.withdrawal.totalLimit`	`number`	Limite de saque concedido.	decimal(18,2)
`limits.withdrawal.availableLimit`	`number`	Limite de saque disponível.	decimal(18,2)
`limits.withdrawal.spentLimit`	`number`	Limite de saque utilizado.	decimal(18,2)
`program`	`object`	Objeto que contém informação sobre o ID do programa atrelado ao contrato de crédito.
`program.id`	`integer`	Identificador único do programa.
`contract`	`object`	Objeto que contém informações sobre o contrato.
`contract.number`	`string`	Valor do contrato de crédito.	10
`contract.type`	`string`	Tipo do contrato de crédito, tendo como valor padrão: “Credit”.	6
`holder`	`object`	Objeto que contém informações sobre o titular do cartão.
`holder.document`	`object`	Objeto que contém informações sobre o documento do titular do cartão.
`holder.document.value`	`string`	Número do documento.	50
`holder.document.type`	`string`	Tipo de documento, que pode ser “CPF ou “CNPJ”.	4
`designatedFunding`	`string`	Financiadora do contrato.	100

Payload do evento

O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

Exemplo de payload

[ 
    { 
        "entityId": "10", 
        "idempotencyKey": "86447d19-687f-4fa8-80cf-a5ii406457b9", 
        "companyKey": "ACESSO", 
        "context": "Invoice", 
        "name": "INVOICE_CLOSED", 
        "timestamp": "2021-12-06T11:10:25.3853601Z", 
        "correlationId": "7a1bfc3f-50e6-458c-aa9b-d33a22ddb84d", 
        "licenseUuid": "24ac71da-4309-4348-9cc0-a0c88f867993", 
        "version": "2", 
        "metadata": { 
            "closed": "2021-12-06T11:10:20.282+00:00" 
        }, 
        "data": { 
            "statementId": 1982831, 
            "month": 2, 
            "year": 2024, 
            "cycle": 21, 
            "cycleCloseDate": "2024-08-06T00:00:00", 
            "realDueDate": "2024-08-12T00:00:00", 
            "dueDate": "2024-08-12T00:00:00", 
            "balance": { 
                "value": 0, 
                "currency": "BRL" 
            }, 
            "amountMinimal": { 
                "value": 0, 
                "currency": "BRL" 
            }, 
            "previousBalance": { 
                "value": 14338.6, 
                "currency": "BRL" 
            }, 
            "residualBalance": { 
                "value": 14338.6, 
                "currency": "BRL" 
            }, 
            "nextStatement": { 
                "statementId": 19016, 
                "cycleCloseDate": "2024-08-06T00:00:00", 
                "balance": 1234, 
                "installmentInterestFree": { 
                    "value": 60.87, 
                    "currency": "BRL" 
                }, 
                "installmentWithInterest": { 
                    "value": 16018.8, 
                    "currency": "BRL" 
                }, 
                "annuity": { 
                    "value": 0, 
                    "currency": "BRL" 
                }, 
                "insurance": { 
                    "value": 0, 
                    "currency": "BRL" 
                } 
            }, 
            "limits": { 
                "invoice": { 
                    "totalLimit": 0, 
                    "availableLimit": 0, 
                    "limitActive": 0 
                }, 
                "withdrawal": { 
                    "totalLimit": 0, 
                    "availableLimit": 0, 
                    "spentLimit": 0 
                } 
            }, 
            "program": { 
                "id": 117 
            }, 
            "contract": { 
                "number": "002111", 
                "type": "Credit" 
            }, 
            "holder": { 
                "document": { 
                    "value": "47742663023", 
                    "type": "CPF" 
                } 
            }, 
            "designatedFunding": "BV" 
        } 
    } 
]

🚧Importante

Pré-requisitos

Informações sobre os eventos

Contexto e nome do evento

Identificador (entityId)

Dados dos eventos

INVOICE_CLOSED

Descrição do objeto data do evento

Payload do evento

🚧
Importante

Identificador (`entityId`)

Descrição do objeto `data` do evento