Manual do Dev
InstitucionalBlogService DeskStatus Page

Fatura (Invoice)

Suggest Edits

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:

contextnameDescrição
InvoiceINVOICE_CLOSEDFatura 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:

NomeTipoDescriçãoNúmero máximo de caracteres
statementIdintegerIdentificador único da fatura.—
monthintegerMês de vencimento da fatura.—
yearintegerAno de vencimento da fatura.—
cycleintegerQuantidade de dias do ciclo da fatura.—
cycleCloseDatestringData de fechamento da fatura, no formato 8601 - UTC.25
dueDatestringData de vencimento da fatura, no formato 8601 - UTC.25
balance[]objectObjeto que contém informações referentes ao valor total da fatura.—
balance.valuenumberValor total da fatura.decimal(18,2)
balance.currencystringCódigo da moeda com base na ISO-4217.3
amountMinimalobjectObjeto que contém informações sobre o valor de pagamento mínimo da fatura.—
amountMinimal.valuenumberValor de pagamento mínimo da fatura.decimal(18,2)
amountMinimal.currencystringCódigo da moeda com base na ISO-4217.3
previousBalanceobjectObjeto que contém informações sobre o valor da fatura anterior.—
previousBalance.valuenumberValor total da fatura.decimal(18,2)
previousBalance.currencystringCódigo da moeda com base na ISO-4217.3
residualBalanceobjectObjeto que contém informações sobre o saldo residual devedor ou credor da fatura anterior.—
residualBalance.valuenumberValor total do saldo residual.decimal(18,2)
residualBalance.currencystringCódigo da moeda com base na ISO-4217.3
nextStatementobjectObjeto que contém informações sobre a próxima fatura.—
nextStatement.statementIdintegerIdentificador único da próxima fatura.
nextStatement.cycleCloseDatestringData de fechamento da fatura, no formato 8601 - UTC.25
nextStatement.balancenumberValor total da próxima fatura, o qual pode ser negativo ou positivo.decimal(18,2)
nextStatement.installmentInterestFreeobjectObjeto 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.valuenumberValor total das parcelas sem juros a vencer.decimal(18,2)
nextStatement.installmentInterestFree.currencystringCódigo da moeda com base na ISO-4217.3
nextStatement.installmentWithInterestobjectObjeto 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.valuenumberSoma dos valores das parcelas com juros a vencer.decimal(18,2)
nextStatement.installmentWithInterest.currencystringCódigo da moeda com base na ISO-4217.3
nextStatement.annuityobjectObjeto que contém informações sobre a soma dos valores de anuidade, que será lançada na próxima fatura.—
nextStatement.annuity.valuenumberSoma dos valores de anuidade.decimal(18,2)
nextStatement.annuity.currencystringCódigo da moeda com base na ISO-4217.3
nextStatement.insuranceobjectObjeto que contém informações sobre a soma dos valores do seguro, que será lançada na próxima fatura.
nextStatement.insurance.valuenumberValor total do seguro.decimal(18,2)
nextStatement.insurance.currencystringCódigo da moeda com base na ISO-4217.3
limitsobjectObjeto que retorna os limites atrelados à conta de crédito.
limits.invoiceobjectObjeto que contém informações sobre o limite de crédito do cliente.
limits.invoice.totalLimitnumberTotal do limite de crédito aprovado.decimal(18,2)
limits.invoice.availableLimitnumberLimite de crédito disponível.decimal(18,2)
limits.invoice.limitActivenumberLimite de crédito habilitado pelo cliente.decimal(18,2)
limits.withdrawalobjectObjeto que contém informações sobre o limite de saque do cliente.
limits.withdrawal.totalLimitnumberLimite de saque concedido.decimal(18,2)
limits.withdrawal.availableLimitnumberLimite de saque disponível.decimal(18,2)
limits.withdrawal.spentLimitnumberLimite de saque utilizado.decimal(18,2)
programobjectObjeto que contém informação sobre o ID do programa atrelado ao contrato de crédito.
program.idintegerIdentificador único do programa.
contractobjectObjeto que contém os dados do contrato.
contract.numberstringValor do contrato de crédito.10
contract.typestringTipo do contrato de crédito, tendo como valor padrão: “Credit”.6
holderobjectObjeto que contém informações sobre o titular do cartão.
holder.documentobjectObjeto que contém informações sobre o documento do titular do cartão.
holder.document.valuestringNúmero do documento.50
holder.document.typestringTipo de documento, o qual pode ser “CPF ou “CNPJ”.4
designatedFundingstringFinanciadora 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" 
        } 
    } 
]

Updated about 1 month ago