Fatura (Invoice)

Os eventos referentes à faturas disparam mensagens ao destinatário quando:

Uma transação é criada;
Um item de fatura é atualizado, por exemplo, em caso de alteração da fatura atrelada, alteração do valor etc.;
As ofertas referentes aos planos de parcelamento para a fatura são criadas;
A fatura é fechada;
As informações referentes à fatura fechada são criadas;
As informações resumidas referentes aos itens atrelados à fatura fechada são criadas;
As informações detalhadas referentes aos itens atrelados à fatura fechada são criadas;
As informações referentes aos planos de refinanciamento atrelados ao contrato de crédito são disponibilizados;
O processo de envio de eventos para composição da fatura é finalizado;
O pagamento total ou proporcional da fatura é realizado;
Uma oferta de crédito para parcelamento é confirmada com sucesso;
Há falha na confirmação da oferta de crédito para parcelamento;
As taxas de refinanciamento atreladas ao programa do cartão são atualizadas.

Para mais informações sobre quando essas mensagens são disparadas e sobre o seu conteúdo, consulte as páginas:

Pré-requisitos

Para receber esses eventos, o parceiro deverá:

Configurar previamente o recebedor de eventos do webhook.
Conhecer a estrutura básica dos eventos que acompanha o objeto data.

📘
Nota
O evento INVOICE_CLOSED já está na versão 2.0.

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`	`TRANSACTION_CREATED`	Transação criada.
`Invoice`	`TRANSACTION_UPDATED`	Item de fatura atualizado.
`Invoice`	`INSTALLMENTS_PLAN_WAS_CREATED`	As ofertas referentes aos planos de parcelamento para a fatura foram criadas.
`Invoice`	`INVOICE_CLOSED`	Fatura do cartão fechada. Importante: este evento possui uma nova versão (2.0).
`Invoice`	`INVOICE_SUMMARY_WAS_CREATED`	As informações referentes à fatura fechada foram criadas.
`Invoice`	`INVOICE_TRANSACTIONS_SUMMARY_WAS_CREATED`	As informações resumidas referentes aos itens atrelados à fatura fechada foram criadas.
`Invoice`	`INVOICE_CLOSED_TRANSACTION_DETAILS_WAS_CREATED`	As informações detalhadas referentes aos itens atrelados à fatura fechada foram criadas.
`Invoice`	`CONTRACTED_INSTALLMENT_PLANS`	As informações referentes aos planos de refinanciamento atrelados ao contrato de crédito foram disponibilizados.
`Invoice`	`INVOICE_CLOSED_WAS_FINISHED`	O processo de envio de eventos para composição da fatura foi finalizado.
`Invoice`	`INVOICE_PAYMENT_OPTION_CREATED`	A opção de pagamento de fatura foi criada.
`Invoice`	`INVOICE_PAYMENT_PROCESSED`	O pagamento proporcional da fatura do cartão foi processado.
`Invoice`	`INVOICE_INSTALLMENT_PLAN_WAS_ACTIVATED`	A oferta de crédito de parcelamento foi ativada com sucesso.
`Invoice`	`INVOICE_INSTALLMENT_PLAN_ACTIVATION_WAS_FAILED`	Houve uma falha na ativação da oferta de crédito de parcelamento devido ao pagamento anterior.
`Invoice`	`INVOICE_REFINANCING_RATES_WAS_UPDATED`	As taxas de refinanciamento atreladas ao programa do contrato de crédito foram atualizadas.

Fluxo dos eventos

Os fluxogramas a seguir descrevem a sequência em que os eventos ocorrem. Clique nas imagens para ampliá-las:

📘
Nota
O envio do evento TRANSACTION_UPDATED poderá ocorrer em qualquer momento do ciclo de vida de uma fatura, desde que seja após a criação de uma transação (evento TRANSACTION_CREATED).

📘
Nota
Para os parceiros que efetuam a baixa de faturas por meio de pagamentos externos, o evento INVOICE_PAYMENT_PROCESSED será disparado após o sucesso na requisição ao endpoint fornecido.

Identificador (`entityId`)

O campo entityId é o identificador da entidade emissora do evento e seu valor depende do contexto de sua emissão, conforme a tabela a seguir:

Evento	Identificador (entityId )	Descrição
`TRANSACTION_CREATED`	`statementItemId`	Identificador único do item de fatura.
`TRANSACTION_UPDATED`	`statementId`	Identificador único da fatura.
`INSTALLMENTS_PLAN_WAS_CREATED`	`paymentId`	Identificador único do pagamento.
`INVOICE_CLOSED`	`statementId`	Identificador único da fatura.
`INVOICE_SUMMARY_WAS_CREATED`	`statementId`	Identificador único da fatura.
`INVOICE_TRANSACTIONS_SUMMARY_WAS_CREATED`	`statementId`	Identificador único da fatura.
`INVOICE_CLOSED_TRANSACTION_DETAILS_WAS_CREATED`	`statementId`	Identificador único da fatura.
`CONTRACTED_INSTALLMENT_PLANS`	`paymentId`	Identificador único do pagamento.
`INVOICE_CLOSED_WAS_FINISHED`	`statementId`	Identificador único da fatura.
`INVOICE_PAYMENT_OPTION_CREATED`	`statementId`	Identificador único da fatura.
`INVOICE_PAYMENT_PROCESSED`	`paymentId`	Identificador único do pagamento.
`INVOICE_INSTALLMENT_PLAN_WAS_ACTIVATED`	`paymentOptionId`	Identificador único da opção de pagamento.
`INVOICE_INSTALLMENT_PLAN_ACTIVATION_WAS_FAILED`	`paymentId`	Identificador único do pagamento.
`INVOICE_REFINANCING_RATES_WAS_UPDATED`	`statementId`	Identificador único da fatura.

Dados dos eventos

TRANSACTION_CREATED

Este evento sinaliza que uma transação foi criada.

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
`statement`	`object`	Objeto que contém os dados da fatura.	—
`statement.id`	`integer`	Identificador único da fatura.	—
`statement.dueDate`	`string`	Data de vencimento da fatura, no formato ISO 8601 - UTC.	25
`statement.cycleCloseDate`	`string`	Data de encerramento do ciclo da fatura, no formato ISO 8601 - UTC.	25
`statement.programId`	`integer`	Identificador único do programa.	—
`program`	`object`	Objeto que contém informações sobre o programa ao qual o cartão pertence.	—
`program.id`	`integer`	Identificador único do programa.	—
`contract`	`object`	Objeto que contém informações sobre o contrato de crédito.	—
`contract.number`	`string`	Número do contrato de crédito.	10
`contract.type`	`string`	Tipo do contrato de crédito, o qual sempre será “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.	—
`holder.document.type`	`string`	Tipo de documento do titular, que pode ser “CPF” ou “CNPJ”.	4
`holder.document.value`	`string`	Número do documento.	—
`isCredit`	`boolean`	Indica se o tipo de operação é crédito (true) ou débito (false).	—
`statementPost`	`boolean`	Indica se o item na fatura deverá ser exibido (true) ou ocultado (false).	—
`statementNumber`	`integer`	Número da parcela.	—
`statementTotal`	`integer`	Número total de parcelas.	—
`transactionDate`	`string`	Data em que ocorreu a transação, no formato ISO 8601 - UTC.	25
`createdAt`	`string`	Data em que ocorreu a transação, no formato ISO 8601 - UTC.	25
`isAnticipation`	`boolean`	Indica se a transação é de antecipação (true) ou não (false).	—
`exchangefee`	`object`	Objeto que contém informações sobre a taxa de conversão utilizada em transações internacionais.	—
`exchangefee.value`	`number`	Valor da taxa.	decimal(18,4)
`exchangefee.currency`	`string`	Código da moeda com base na ISO-4217.	3
`authorizationId`	`string`	Identificador da transação gerado pela processadora.	20
`authorizationTrackingId`	`string`	Identificador de rastreamento da transação (crédito ou débito).	75
`transactionTypeId`	`string`	Identificador do tipo da transação.	—
`transactionType`	`string`	Tipo de transação.	100
`transactionDescription`	`string`	Descritivo do item da fatura.	150
`exchangeFee`	`object`	Objeto que contém a taxa de conversão utilizada em transações internacionais.	—
`exchangefee.value`	`number`	Valor da taxa.	decimal (18,4)
`exchangefee.currency`	`string`	Código da moeda com base na ISO-4217.	3
`amounts[]`	`array of objects`	Lista de objetos que contém informações sobre o total da transação.	—
`amounts[].value`	`number`	Valor do item da fatura.	decimal (18,2)
`amounts[].currency`	`string`	Código da moeda com base na ISO-4217.	3
`amounts[].amountType`	`string`	Indicador do tipo do item de valor, o qual pode ser: “Billet” (valor cobrado, em real, ao cliente), “Exchange” (valor em dólar da transação no caso de a compra ser internacional) e “Local” (valor da moeda local).	10
`fees[]`	`array of objects`	Lista de objetos que contém informações sobre as taxas aplicadas à transação.	—
`fees[].feeType`	`string`	Tipo de taxa.	10
`fees[].feeAmount`	`object`	Objeto que contém informações sobre o valor das taxas aplicadas na transação.	—
`fees[].feeAmount. value`	`number`	Valor da taxa.	decimal(18,2)
`fees[].feeAmount.currency`	`string`	Código da moeda com base na ISO-4217.	3
`transaction`	`object`	Objeto que contém dados relacionados a uma transação bandeirada (compra ou saque).	—
`transaction.card`	`object`	Objeto que contém os dados do cartão utilizado na transação.	—
`transaction.card.proxy`	`string`	Código identificador do cartão.	30
`transaction.card.lastFourDigits`	`string`	Últimos quatro dígitos do cartão.	4
`transaction.card.cardName`	`string`	Nome gravado no cartão.	20
`transaction.card.cardType`	`string`	Tipo do cartão, o qual pode ser “Physical” ou “Virtual”.	10
`transaction.card.alias`	`string`	Apelido dado ao cartão.	20
`transaction.transactionAuthorizerId`	`string`	Identificador da transação gerado pela processadora.	20
`transaction.authorizationCode`	`string`	Identificador da transação na rede de cartões.	20
`transaction.nsu`	`string`	Número sequencial único que é gerado na venda.	20
`transaction.retrievalReferenceNumber`	`string`	Identificador de transação da rede do cartão.	20
`transaction.mcc`	`string`	Código MCC da transação.	10
`transaction.mcg`	`string`	Descrição do tipo `mcc`.	20
`transaction.merchantCity`	`string`	Cidade onde foi realizada a transação.	50
`transaction.merchantStateOrCountry`	`string`	Estado ou país onde foi realizada a transação.	15
`transaction.merchantZipCode`	`string`	Código postal do local em que a transação foi realizada.	15
`transaction.merchant`	`string`	Nome do comerciante/estabelecimento que aceitou a transação.	100
`transaction.entryMode`	`string`	Código que identifica o tipo da transação.	10
`documentNumber`	`object`	Objeto que contém informações sobre o documento do titular do cartão.	—
`documentNumber.value`	`string`	Número do documento.	50
`documentNumber.type`	`string`	Tipo de documento do titular, que pode ser “CPF” ou “CNPJ”.	4

ℹ️
Nota
O objeto transaction pode ser nulo caso o item não represente uma transação.

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

{
   "name": "TRANSACTION_CREATED",
   "entityId": "12345",
   "idempotencyKey": "7581c878-5546-4eaa-8a93-340c1f3e820c",
   "companyKey": "COMPANY_KEY",
   "timestamp": "2022-04-25T11:39:27.7528839Z",
   "correlationId": "825b3f03-8376-4ooc-af2c-8dcc94e5e133",
   "version": 1,
   "metadata": {
      "Created": "2022-04-24T22:37:09Z"
   },
   "context": "Invoice",
   "data": {
      "statement": {
         "id": 56922,
         "dueDate": "2022-08-01T00:00:00",
         "programId": 1,
         "cycleCloseDate":"2022-08-01T00:00:00"
      },
      "isCredit": false,
      "isAntecipation": false,
	  	"createdAt": "2024-04-10T05:34:34.374209",
      "statementPost": true,
      "statementNumber": 3,
      "statementTotal": 3,
      "transactionDate": "2022-04-24T22:37:09Z",
      "authorizationId":"auth-id-123",
      "transactionTypeId": 0,
      "transactionType": "INSTALLMENT_WITHOUT_INTEREST",
      "transactionDescription": "DROGARIA",
      "authorizationTrackingId": "42091147-df02-4447-b805-c796d4f570ad",
      "exchangeFee": {
         "value": 0,
         "currency": "BRL"
      },
      "amounts": [
         {
            "value": 67.95,
            "currency": "BRL",
            "amountType": "Billed"
         },
         {
            "value": 203.86,
            "currency": "BRL",
            "amountType": "Local"
         },
         {
            "value": 67.96,
            "currency": "BRL",
            "amountType": "Exchange"
         }
      ],
      "fees": [],
      "transaction": {
         "card": {
            "proxy": "0000000000000000000",
            "lastFourDigits": "0000",
            "cardName": "Nísia Floresta",
            "cardType": "Virtual",
            "alias": "Card Virtual Pos"
         },
         "transactionAuthorizerId": "12345678",
         "auhtorizationCode": "LVSF1W",
         "retrievalReferenceNumber": "ref123",
         "nsu": "248882",
         "mcg": "Care",
         "merchant": "DROGARIA",
         "mcc": "5912",
         "entrymode": "810",
         "merchantCity": "Rio de Janeiro",
         "merchantStateOrCountry": "BR",
         "merchantZipCode": "22222222"
      },
      "documentNumber": {
         "value": "47742663023",
         "type": "CPF"
      },
      "program":{
         "id":1
      },
      "contract":{
          "number":"000091",
          "type":"Credit"
       },
      "holder":{
          "document":{
            "type":"CPF",
            "value":"47742663023"
          }
      },
      "designatedFunding": "Bankly"
   },
   "licenseUuid": "5936a546-1f8f-4416-878c-d4061e4f1d34"
}

{
   "name": "TRANSACTION_CREATED",
   "entityId": "12345",
   "idempotencyKey": "7581c878-5546-4eaa-8a93-340c1f3e820c",
   "companyKey": "COMPANY_KEY",
   "timestamp": "2022-04-25T11:39:27.7528839Z",
   "correlationId": "825b3f03-8376-4ooc-af2c-8dcc94e5e133",
   "version": "1",
   "metadata": {
      "Created": "2022-04-24T22:37:09Z"
   },
   "context": "Invoice",
   "data": {
      "statement": {
         "id": 56922,
         "dueDate": "2022-08-01T00:00:00",
         "programId": 250,
         "cycleCloseDate":"2022-08-01T00:00:00"
      },
      "isCredit": false,
      "statementPost": true,
      "statementNumber": 3,
      "statementTotal": 3,
      "isAntecipation": false,
	    "createdAt": "2024-04-10T05:34:34.374209",
      "transactionDate": "2022-04-24T22:37:09Z",
      "authorizationId":"auth-id-123",
      "transactionTypeId": 0,
      "transactionType": "INSTALLMENT_WITHOUT_INTEREST",
      "transactionDescription": "DROGARIA",
      "authorizationTrackingId": "42091147-df02-4447-b805-c796d4f570ad",
      "exchangeFee": {
         "value": 0,
         "currency": "BRL"
      },
      "amounts": [
         {
            "value": 67.95,
            "currency": "BRL",
            "amountType": "Billed"
         },
         {
            "value": 203.86,
            "currency": "BRL",
            "amountType": "Local"
         },
         {
            "value": 67.96,
            "currency": "BRL",
            "amountType": "Exchange"
         }
      ],
      "fees": [
         {
            "feeType": "Markup",
            "feeAmount":{
                "value":5.0,
                "currency":"USD"
            }
         },
         {
            "feeType": "Interest",
            "feeAmount":{
                "value":3.02,
                "currency":"BRL"
            }
         }
      ],
      "transaction": {
         "card": {
            "proxy": "0000000000000000000",
            "lastFourDigits": "0000",
            "cardName": "Nísia Floresta",
            "cardType": "Virtual",
            "alias": "Card Virtual Pos"
         },
         "transactionAuthorizerId": "12345678",
         "auhtorizationCode": "LVSF1W",
         "retrievalReferenceNumber": "ref123",
         "nsu": "248882",
         "mcg": "Care",
         "merchant": "DROGARIA",
         "mcc": "5912",
         "entrymode": "810"
      },
      "documentNumber": {
         "value": "47742663023",
         "type": "CPF"
      },
      "program":{
         "id":1
      },
      "contract":{
          "number":"000091",
          "type":"Credit"
       },
      "holder":{
          "document":{
            "type":"CPF",
            "value":"47742663023"
          }
      },
      "designatedFunding": "Bankly"
   },
   "licenseUuid": "5936a546-1f8f-4416-878c-d4061e4f1d34"
}

{
   "name": "TRANSACTION_CREATED",
   "entityId": "12345",
   "idempotencyKey": "7581c878-5546-4eaa-8a93-340c1f3e820c",
   "companyKey": "COMPANY_KEY",
   "timestamp": "2022-04-25T11:39:27.7528839Z",
   "correlationId": "825b3f03-8376-4ooc-af2c-8dcc94e5e133",
   "version": "1",
   "metadata": {
      "Created": "2022-04-24T22:37:09Z"
   },
   "context": "Invoice",
   "data": {
      "statement": {
         "id": 56922,
         "dueDate": "2022-08-01T00:00:00",
         "programId": 250,
         "cycleCloseDate":"2022-08-01T00:00:00"
      },
      "isCredit": false,
      "statementPost": true,
      "statementNumber": 5,
      "statementTotal": 6,
      "transactionDate": "2022-04-24T22:37:09Z",
      "authorizationId":"auth-id-123",
      "isAntecipation": false,
	  	"createdAt": "2024-04-10T05:34:34.374209",
      "transactionTypeId": 0,
      "transactionType": "REFINANCE_INSTALLMENT",
      "transactionDescription": "PARC FATURA (04/2022)",
      "authorizationTrackingId": "42091147-df02-4447-b805-c796d4f570ad",
      "exchangeFee": {
         "value": 0,
         "currency": "BRL"
      },
      "amounts": [
			{
				"value": 150.88,
				"currency": "BRL",
				"amountType": "Billed"
			}
      ],
      "fees": [
			{
				"feeType": "Iof",
				"feeAmount": {
					"value": 0.82,
					"currency": "BRL"
				}
			},
			{
				"feeType": "Interest",
				"feeAmount": {
					"value": 49.84,
					"currency": "BRL"
				}
			}
      ],
      "transaction": {},
      "documentNumber": {
         "value": "47742663023",
         "type": "CPF"
      },
      "program":{
         "id":1
      },
      "contract":{
          "number":"000091",
          "type":"Credit"
       },
      "holder":{
          "document":{
            "type":"CPF",
            "value":"47742663023"
          }
      },
      "designatedFunding": "BANKLY"
   },
   "licenseUuid": "5936a546-1f8f-4416-878c-d4061e4f1d34"
}

{
   "name": "TRANSACTION_CREATED",
   "entityId": "12345",
   "idempotencyKey": "7581c878-5546-4eaa-8a93-340c1f3e820c",
   "companyKey": "COMPANY_KEY",
   "timestamp": "2022-04-25T11:39:27.7528839Z",
   "correlationId": "825b3f03-8376-4ooc-af2c-8dcc94e5e133",
   "version": 1,
   "metadata": {
      "Created": "2022-04-24T22:37:09Z"
   },
   "context": "Invoice",
   "data": {
      "statement": {
         "id": 56922,
         "dueDate": "2022-08-01T00:00:00",
         "programId": 250,
         "cycleCloseDate":"2022-08-01T00:00:00"
      },
      "isCredit": false,
      "statementPost": true,
      "statementNumber": 3,
      "statementTotal": 3,
      "isAntecipation": false,	
	  	"createdAt": "2024-04-10T05:34:34.374209",
      "transactionDate": "2022-04-24T22:37:09Z",
      "authorizationId":"auth-id-123",
      "transactionTypeId": 0,
      "transactionType": "FINE_REVERSAL",
      "transactionDescription": "ESTORNO MULTA",
      "exchangeFee": {
         "value": 0,
         "currency": "BRL"
      },
      "amounts": [
         {
            "value": 67.95,
            "currency": "BRL",
            "amountType": "Billed"
         },
         {
            "value": 203.86,
            "currency": "BRL",
            "amountType": "Local"
         },
         {
            "value": 67.96,
            "currency": "BRL",
            "amountType": "Exchange"
         }
      ],
      "fees": [],
      "transaction": {},
      "documentNumber": {
         "value": "47742663023",
         "type": "CPF"
      },
      "program":{
         "id":1
      },
      "contract":{
          "number":"000091",
          "type":"Credit"
       },
      "holder":{
          "document":{
            "type":"CPF",
            "value":"47742663023"
          }
      },
      "designatedFunding": "BANKLY"
   },
   "licenseUuid": "5936a546-1f8f-4416-878c-d4061e4f1d34"
}

TRANSACTION_UPDATED

Este evento sinaliza que um item de fatura foi atualizado.

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
`statement`	`object`	Objeto que contém os dados da fatura.	—
`statement.id`	`integer`	Identificador único da fatura.	—
`statement.dueDate`	`string`	Data de vencimento da fatura, no formato ISO 8601 - UTC.	—
`program`	`object`	Objeto que contém informações sobre o programa ao qual o cartão pertence.	—
`program.id`	`integer`	Identificador único do programa.	—
`contract`	`object`	Objeto que contém informações sobre o contrato de crédito.	—
`contract.number`	`string`	Número do contrato de crédito.	10
`contract.type`	`string`	Tipo do contrato de crédito, o qual sempre será “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.	—
`holder.document.type`	`string`	Tipo de documento do titular, que pode ser “CPF” ou “CNPJ”.	4
`holder.document.value`	`string`	Número do documento.	—
`isCredit`	`boolean`	Indica se o tipo de operação é crédito (true) ou débito (false).	—
`statementPost`	`boolean`	Indica se o item na fatura deverá ser exibido (true) ou ocultado (false).	—
`statementNumber`	`integer`	Número da parcela.	—
`statementTotal`	`integer`	Número total de parcelas.	—
`transactionDate`	`string`	Data em que ocorreu a transação, no formato ISO 8601 - UTC.	—
`authorizationId`	`string`	Identificador da transação gerado pela processadora.	20
`transactionTypeId`	`integer`	Identificador do tipo da transação.	—
`transactionType`	`string`	Tipo de transação.	100
`transactionDescription`	`string`	Descritivo do item da fatura.	150
`createdAt`	`string`	Data em que ocorreu a transação, no formato ISO 8601 - UTC.	25
`isAnticipation`	`boolean`	Indica se a transação é de antecipação (true) ou não (false).	—
`exchangefee`	`object`	Objeto que contém informações sobre a taxa de conversão utilizada em transações internacionais.	—
`exchangefee.value`	`number`	Valor da taxa.	decimal(18,4)
`exchangefee.currency`	`string`	Código da moeda com base na ISO-4217.	3
`amounts[]`	`array of objects`	Lista de objetos que contém informações sobre o total da transação.	—
`amounts[].value`	`number`	Valor do item da fatura.	18,2
`amounts[].currency`	`string`	Código da moeda com base na ISO-4217.	3
`amounts[].amountType`	`string`	Indicador do tipo do item de valor, o qual pode ser: “Billet” (valor cobrado, em real, ao cliente), “Exchange” (valor em dólar da transação no caso de a compra ser internacional) e “Local” (valor da moeda local).	10
`fees[]`	`array of objects`	Lista de objetos que contém informações sobre as taxas aplicadas na transação.	—
`fees[].feeType`	`string`	Tipo da taxa, o qual pode ser: “NotMapper”, “IOF”, “Markup”, “DailyIOF” ou “Interest”.	10
`fees[].feeAmount`	`object`	Objeto que contém informações sobre o valor das taxas aplicadas na transação.	—
`fees[].feeAmount. value`	`number`	Valor da taxa.	18,2
`fees[].feeAmount.currency`	`string`	Código da moeda com base na ISO-4217.	3
`transaction`	`object`	Objeto que contém dados relacionados a uma transação bandeirada (compra ou saque).	—
`transaction.card`	`object`	Objeto que contém os dados do cartão utilizado na transação.	—
`transaction.card.proxy`	`string`	Código identificador do cartão.	30
`transaction.card.lastFourDigits`	`string`	Últimos quatro dígitos do cartão.	4
`transaction.card.cardName`	`string`	Nome gravado no cartão.	20
`transaction.card.cardType`	`string`	Tipo do cartão, o qual pode ser “Physical” ou “Virtual”.	10
`transaction.card.alias`	`string`	Apelido dado ao cartão.	20
`transaction.transactionAuthorizerId`	`string`	Identificador da transação gerado pela processadora.	20
`transaction.authorizationCode`	`string`	Identificador da transação na rede de cartões.	—
`transaction.nsu`	`string`	Número sequencial único que é gerado na venda.	20
`transaction.retrievalReferenceNumber`	`string`	Identificador de transação da rede do cartão.	20
`transaction.mcc`	`string`	Código MCC da transação.	10
`transaction.mcg`	`string`	Descrição do tipo `mcc`.	20
`transaction.merchantCity`	`string`	Cidade onde foi realizada a transação.	50
`transaction.merchantStateOrCountry`	`string`	Estado ou país onde foi realizada a transação.	15
`transaction.merchantZipCode`	`string`	Código postal do local em que a transação foi realizada.	15
`transaction.merchant`	`string`	Nome do comerciante/estabelecimento que aceitou a transação.	100
`transaction.entryMode`	`string`	Código que identifica o tipo da transação.	10
`transaction.documentNumber`	`object`	Objeto que contém informações sobre o documento do titular do cartão.	—
`transaction.documentNumber.value`	`string`	Número do documento.	50
`transaction.documentNumber.type`	`string`	Tipo de documento do titular, que pode ser “CPF” ou “CNPJ”.	4

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

{
	"name": "TRANSACTION_UPDATED",
	"entityId": "61214",
	"idempotencyKey": "65e522e0-8148-4555-80ec-c838bb81ad1c",
	"companyKey": "ACESSO",
	"timestamp": "2024-10-08T12:11:44.7047561Z",
	"correlationId": "65e522e0-8148-4555-80ec-c838bb81ad1c",
	"version": 1,
	"metadata": {
		"Updated": "2024-09-27T20:34:51"
	},
	"context": "Invoice",
	"data": {
		"statement": {
			"id": 222222,
			"dueDate": "2024-11-05T00:00:00",
			"programId": 0,
			"paymentStatus": 0
		},
		"isCredit": false,
		"statementPost": true,
		"statementNumber": 3,
		"statementTotal": 8,
		"transactionDate": "2024-09-27T20:34:51",
		"authorizationId": "12345678",
		"transactionTypeId": 0,
		"transactionType": "INSTALLMENT_WITHOUT_INTEREST",
		"transactionDescription": "Test",
		"exchangeFee": {
			"value": 100.0,
			"currency": "BRL"
		},
		"amounts": [
			{
				"value": 25.00,
				"currency": "BRL",
				"amountType": "Billed"
			}
		],
		"Fees": {
			"FeeType": "Interest",
			"AmountNotification": {
				"Value": "100.0",
				"Currency": "BRL"
			}
		},
		"transaction": {
			"card": {
				"proxy": "223123412312312",
				"lastFourDigits": "2020",
				"cardName": "test",
				"cardType": "Physical",
				"alias": "teste"
			},
			"transactionAuthorizerId": "123456",
			"authorizationCode": "VXJ123",
			"nsu": "123",
			"retrievelReferenceNumber": "12345",
			"mcg": "321",
			"merchant": "test",
			"mcc": "0742",
			"entrymode": "051",
      "merchantCity": "Rio de Janeiro",
      "merchantStateOrCountry": "BR",
      "merchantZipCode": "22222222"
		},
		"documentNumber": {
			"value": "12345678910",
			"type": "CPF"
		},
		"isAntecipation": true,
		"createdAt": "2024-09-27T20:34:51",
		"program": {
			"id": 764
		},
		"contract": {
			"number": "222222",
			"type": "Credit"
		},
		"holder": {
			"document": {
				"value": "12345678910",
				"type": "CPF"
			}
		},
		"designatedFunding": "BV",
		"isAnticipation": false
	},
	"licenseUuid": "f64197e4-80b3-4820-bfae-1419049b15b1"
}

INSTALLMENTS_PLAN_WAS_CREATED

Este evento sinaliza que as ofertas referentes aos planos de parcelamento para a fatura foram criadas.

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`	Indicador do ciclo da fatura.	—
`cycleCloseDate`	`string`	Data de fechamento da fatura, no formato ISO 8601 - UTC.	25
`dueDate`	`string`	Data de vencimento da fatura, no formato ISO 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
`paymentOptions[]`	`array of objects`	Lista de objetos contendo informações sobre as formas de pagamentos disponíveis.	—
`paymentOptions[].paymentOptionId`	`integer`	Identificador único da opção de pagamento.	—
`paymentOptions[].paymentType`	`string`	Opção de pagamento, que pode ser: “InstallmentWithEntry” (parcelado com entrada) ou “InstallmentWithoutEntry” (parcelado sem entrada).	25
`paymentOptions[].value`	`number`	Valor de pagamento.	decimal(18,4)
`creditOffer`	`object`	Objeto que contém informações sobre a proposta de parcelamento da fatura.	—
`creditOffer.creditOfferId`	`integer`	Identificador único da proposta.	10
`creditOffer.externalOperationId`	`string`	Identificador externo da operação.	40
`creditOffer.externalOfferId`	`string`	Identificador externo da proposta.	40
`creditOffer.externalOfferType`	`string`	Tipo da proposta externa retornada, que pode ser “Variable” (referente à proposta de parcelamento) ou “Fixed” (referente à proposta de crédito rotativo).	50
`paymentOptions[].creditOffer.amountCurrency`	`string`	Código da moeda com base na ISO-4217.	4
`paymentOptions[].creditOffer.amountDue`	`number`	Valor contratado da proposta mais o valor total de juros (pode ou não conter TAC).	decimal (18,4)
`paymentOptions[].creditOffer.annualCet`	`number`	CET (custo efetivo total) da contratação calculado ao ano.	decimal (18,4)
`paymentOptions[].creditOffer.annualInterestRate`	`number`	Taxa de juros anual da contratação.	decimal (18,4)
`paymentOptions[].creditOffer.cet`	`number`	CET (custo efetivo total) da contratação calculado na periodicidade definida das parcelas.	decimal (18,4)
`paymentOptions[].creditOffer.externalCreatedAt`	`string`	Data do cálculo da proposta, no formato 8601 - UTC.	29
`paymentOptions[].creditOffer.externalExpiresAt`	`string`	Data de expiração da proposta, no formato 8601 - UTC.	29
`paymentOptions[].creditOffer.firstPaymentDate`	`string`	Data do primeiro pagamento da proposta, no formato 8601 - UTC.	29
`paymentOptions[].creditOffer.graceDays`	`integer`	Quantidade de dias para a carência do primeiro pagamento.	—
`paymentOptions[].creditOffer.lastPaymentDate`	`integer`	Data do último pagamento da proposta.	—
`paymentOptions[].creditOffer.loanAmount`	`number`	Valor do crédito solicitado para contratação.	decimal(18,4)
`paymentOptions[].creditOffer.monthlyInterestRate`	`number`	Taxa de juros mensal da contratação.	decimal (18,4)
`paymentOptions[].creditOffer.operationCostAmount`	`number`	Custo de processamento da operação.	decimal (18,4)
`paymentOptions[].creditOffer.periodicity`	`string`	Periodicidade do pagamento. Ex.: “monthly”.	40
`paymentOptions[].creditOffer.retentionRate`	`number`	Indica o percentual de retenção da proposta.	decimal (18,4)
`paymentOptions[].creditOffer.term`	`integer`	Quantidade de parcelas da proposta.	—
`paymentOptions[].creditOffer.totalInterestAmount`	`number`	Valor total de juros a ser pago na contratação.	decimal(18,4)
`paymentOptions[].creditOffer.totalPaymentAmount`	`number`	Valor total a ser pago no final do contrato.	decimal(18,4)
`paymentOptions[].creditOffer.iofTotalAmount`	`number`	Valor final do cálculo do IOF.	decimal(18,4)
`paymentOptions[].creditOffer.iofTotalPercentage`	`number`	Valor percentual do IOF, se aplicável.	decimal(18,4)
`paymentOptions[].creditOffer.diaryIof`	`number`	Percentual do IOF diário.	decimal (18,4)
`paymentOptions[].creditOffer.fixedIof`	`number`	Percentual do IOF fixo.	decimal (18,4)
`paymentOptions[].creditOffer.installments[]`	`Array of objects`	Lista de objetos contendo as parcelas e suas informações.	—
`paymentOptions[].creditOffer.installments[].amortizationAmount`	`number`	Valor da amortização no contrato.	decimal(18,4)
`paymentOptions[].creditOffer.Installments[].dueDate`	`string`	Data de vencimento da parcela, no formato 8601 - UTC.	29
`paymentOptions[].creditOffer.Installments[].interestAmount`	`number`	Valor dos juros da parcela.	decimal(18,4)
`paymentOptions[].creditOffer.Installments[].iofAmount`	`number`	Valor do IOF da parcela.	decimal(18,4)
`paymentOptions[].creditOffer.Installments[].paymentAmount`	`number`	Valor da parcela.	decimal(18,4)
`paymentOptions[].creditOffer.Installments[].installmentNumber`	`integer`	Número da parcela.	—
`program`	`object`	Objeto que contém informações sobre o programa ao qual o cartão pertence.	—
`program.id`	`integer`	Identificador único do programa.	—
`contract`	`object`	Objeto que contém informações sobre o contrato de crédito.	—
`contract.number`	`string`	Número do contrato de crédito.	10
`contract.type`	`string`	Tipo do contrato de crédito, o qual sempre será “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.	—
`holder.document.value`	`string`	Número do documento.	50
`holder.document.type`	`string`	Tipo de documento, o qual 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

[
	{ 
       "name":"INSTALLMENTS_PLAN_WAS_CREATED", 
       "entityId":"3350650", 
       "idempotencyKey":"1971a544-741e-47c2-8150-6e674bf037e6", 
       "companyKey":"BANCO_DIGITAL_BCO_BV", 
       "timestamp":"2024-07-27T03:45:03.4316265Z", 
       "correlationId":"1971a544-741e-47c2-8150-6e674bf037e6", 
       "version":"1", 
       "metadata":{ 
          "closed":"2022-04-24T22:37:09Z" 
       }, 
       "context":"Invoice", 
       "data":{ 
          "statementId":3350650, 
          "month":8, 
          "year":2024, 
          "cycle":1, 
          "cycleCloseDate":"2024-07-27T00:00:00", 
          "dueDate":"2024-08-01T00:00:00", 
          "balance":{ 
             "value":0, 
             "currency":"BRL" 
          }, 
          "amountMinimal":{ 
             "value":0, 
             "currency":"BRL" 
          }, 
          "paymentOptions":[ 
             { 
                "paymentOptionId":16155584,                
                "paymentType":"InstallmentWithEntry", 
                "value":119.14, 
                "creditOffer":{ 
                   "creditOfferId":13865332, 
                   "externalOperationId":"8feb8b18-9a38-4258-bf7d-4c128aef64c7", 
                   "externalOfferId":"69667809-8292-4839-8c4d-a7afe976a58e", 
                   "externalOfferType":"Parcelado", 
                   "amountCurrency":"BRL", 
                   "amountDue":613.79, 
                   "annualCet":224.83, 
                   "annualInterestRate":381.28, 
                   "cet":10.17,                   
                   "externalCreatedAt":"2024-08-18T09:02:51.0430000", 
                   "externalExpiresAt":"2024-08-26T00:00:00.0000000", 
                   "firstPaymentDate":"2024-09-26T00:00:00.0000000", 
                   "graceDays":7, 
                   "lastPaymentDate":"2024-10-28T00:00:00.0000000", 
                   "loanAmount":500.85, 
                   "monthlyInterestRate":0.1399, 
                   "operationCostAmount":0, 
                   "periodicity":"monthly", 
                   "retentionRate":0, 
                   "term":2, 
                   "totalInterestAmount":109.07, 
                   "totalPaymentAmount":613.79, 
                   "iofTotalAmount":3.87, 
                   "iofTotalPercentage":0,                    
                   "diaryIof":0.0082, 
                   "fixedIof":0.38, 
                   "installments":[ 
                      {                        
                         "dueDate":"2024-09-26T00:00:00.0000000", 
                         "interestAmount":69.58, 
                         "iofAmount":1.49, 
                         "paymentAmount":306.9, 
                         "installmentNumber":1 
                      }, 
                      {                          
                         "dueDate":"2024-10-28T00:00:00.0000000", 
                         "interestAmount":39.49, 
                         "iofAmount":2.38, 
                         "paymentAmount":306.89, 
                         "installmentNumber":2 
                      } 
                   ] 
                } 
             } 
          ], 
          "program":{ 
             "id":704 
          }, 
          "contract":{ 
             "number":"1949270", 
             "type":"Credit" 
          }, 
          "holder":{ 
             "document":{ 
                "value":"47742663023", 
                "type":"CPF" 
             } 
          }, 
          "designatedFunding":"BV" 
       } 
    }
]

INVOICE_CLOSED

Este evento sinaliza que a fatura do cartão de crédito 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`	Indicador do ciclo da fatura.	—
`cycleCloseDate`	`string`	Data de fechamento da fatura, no formato ISO 8601 - UTC.	25
`dueDate`	`string`	Data de vencimento da fatura, no formato ISO 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
`summary`	`object`	Objeto que contém informações resumidas da fatura.	—
`summary.outstandingBalance`	`object`	Objeto que contém o saldo residual devedor da fatura anterior.	—
`summary.outstandingBalance.value`	`number`	Valor total do saldo residual.	decimal(18,2)
`summary.outstandingBalance.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.estimatedCharges`	`object`	Objeto que contém o valor estimado dos encargos, caso a fatura seja rotativada.	—
`summary.estimatedCharges.iof`	`object`	Objeto que contém o valor estimado do IOF, caso a fatura seja rotativada.	—
`summary.estimatedCharges.iof.value`	`number`	Valor total estimado do IOF.	decimal(18,2)
`summary.estimatedCharges.iof.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.estimatedCharges.refinance`	`object`	Objeto que contém o valor que será refinanciado, caso a fatura seja rotativada.	—
`summary.estimatedCharges.refinance.value`	`number`	Valor total a ser refinanciado.	decimal(18,2)
`summary.estimatedCharges.refinance.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.estimatedCharges.interest`	`object`	Objeto que contém o valor estimado do encargo de refinanciamento caso a fatura seja rotativada.	—
`summary.estimatedCharges.interest.value`	`number`	Valor total estimado dos encargos de refinanciamento.	decimal(18,2)
`summary.estimatedCharges.interest.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.estimatedCharges.traffic`	`object`	Objeto que contém o valor estimado da multa, caso a fatura seja rotativada.
`summary.estimatedCharges.traffic.value`	`number`	Valor total estimado da multa.	decimal(18,2)
`summary.estimatedCharges.traffic.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.estimatedCharges.annualCet`	`number`	Percentual anual do custo efetivo total da operação de rotativo.	decimal(18,2)
`summary.estimatedCharges. monthlyCet`	`number`	Percentual mensal do custo efetivo total da operação de rotativo.	decimal(18,2)
`summary.installmentSummary`	`object`	Objeto que contém o resumo dos itens parcelados a vencer.	decimal(18,2)
`summary.installmentSummary.interestFree`	`object`	Objeto que contém a soma dos itens de parcela sem juros a vencer.	—-
`summary.installmentSummary.interestFree.value`	`number`	Valor total dos itens parcelados sem juros a vencer.	decimal(18,2)
`summary.installmentSummary.interestFree.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.installmentSummary.interest`	`object`	Objeto que contém a soma das parcelas com juros a vencer, com desconto dos encargos que compõem a parcela.	—
`summary.installmentSummary.interest.value`	`number`	Soma das parcelas com juros a vencer, com desconto dos encargos futuros.	decimal(18,2)
`summary.installmentSummary.interest.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.installmentSummary.interestWithoutDiscount`	`object`	Objeto que contém a soma das parcelas com juros a vencer, sem o desconto dos encargos que compõem a parcela.	—-
`summary.installmentSummary.interestWithoutDiscount.value`	`number`	Soma das parcelas com juros a vencer, sem o desconto dos que compõem a parcela.	decimal(18,2)
`summary.installmentSummary.interestWithoutDiscount.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.amountMinimalComposition`	`object`	Objeto que contém os valores que compõem o valor de pagamento mínimo da fatura.	—
`summary.amountMinimalComposition.outstandingBalance`	`object`	Objeto que contém o saldo residual devedor da fatura anterior.	—
`summary.amountMinimalComposition.outstandingBalance.value`	`number`	Valor total do saldo residual.	decimal(18,2)
`summary.amountMinimalComposition.outstandingBalance.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.amountMinimalComposition.fees`	`object`	Objeto que contém a soma dos encargos lançados na fatura.
`summary.amountMinimalComposition.fees.value`	`number`	Soma dos encargos lançados na fatura.	decimal(18,2)
`summary.amountMinimalComposition.fees.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.amountMinimalComposition.refinance`	`object`	Objeto que contém a soma das transações de refinanciamento lançados na fatura.	—-
`summary.amountMinimalComposition.refinance.value`	`number`	Soma das transações de refinanciamento lançados na fatura.	decimal(18,2)
`summary.amountMinimalComposition.refinance.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.amountMinimalComposition.transactions`	`object`	Objeto que contém a soma dos itens de débito lançados em fatura.	—
`summary.amountMinimalComposition.transactions.value`	`number`	Soma dos itens de débito lançados em fatura.	decimal(18,2)
`summary.amountMinimalComposition.transactions.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsSummary`	`object`	Objeto que contém a soma das transações na fatura, agrupados por categoria de transação.	—
`summary.transactionsSummary.nationalPurchasing`	`object`	Objeto que contém a soma das transações nacionais na fatura.	—-
`summary.transactionsSummary.nationalPurchasing.value`	`number`	Soma das transações nacionais na fatura.	decimal(18,2)
`summary.transactionsSummary.nationalPurchasing.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsSummary.internationalPurchasing[]`	`array of objects`	Objeto que contém a soma das transações internacionais na fatura.	—
`summary.transactionsSummary.internationalPurchasing[].value`	`number`	Soma das transações internacionais na fatura.	decimal(18,2)
`summary.transactionsSummary.internationalPurchasing[].currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsSummary.fees`	`object`	Objeto que contém a soma dos encargos lançados na fatura.	—-
`summary.transactionsSummary.fees.value`	`number`	Soma dos encargos lançadas na fatura.	decimal(18,2)
`summary.transactionsSummary.fees.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsSummary. debtAdjustments`	`object`	Objeto que contém a soma dos ajustes a débito na fatura.	—
`summary.transactionsSummary. debtAdjustments.value`	`number`	Soma dos ajustes a débito na fatura.	decimal(18,2)
`summary.transactionsSummary.debtAdjustments.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsSummary. creditAdjustments`	`object`	Objeto que contém a soma dos ajustes a crédito na fatura.	—
`summary.transactionsSummary.creditAdjustments.value`	`number`	Soma dos ajustes a crédito na fatura.	decimal(18,2)
`summary.transactionsSummary.creditAdjustments.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsSummary.payments`	`object`	Objeto que contém a soma dos pagamentos realizados.	—
`summary.transactionsSummary.payments.value`	`number`	Soma dos pagamentos.	decimal(18,2)
`summary.transactionsSummary.payments.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsSummary.insurance`	`object`	Objeto que contém a soma dos itens de seguro na fatura.	—
`summary.transactionsSummary.insurance.value`	`number`	Soma dos itens de seguro na fatura.	decimal(18,2)
`summary.transactionsSummary.insurance.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsSummary.annuity`	`object`	Objeto que contém a soma dos itens de anuidade na fatura.	—
`summary.transactionsSummary.annuity.value`	`number`	Soma dos itens de anuidade na fatura.	decimal(18,2)
`summary.transactionsSummary.annuity.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsSummary.withdraw`	`object`	Objeto que contém a soma dos saques nacionais na fatura.	—
`summary.transactionsSummary.withdraw.value`	`number`	Soma dos saques nacionais na fatura.	decimal(18,2)
`summary.transactionsSummary.withdraw.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsSummary.internationalWithdraw`	`object`	Objeto que contém a soma dos saques internacionais na fatura.	—
`summary.transactionsSummary. internationalWithdraw.value`	`number`	Soma dos saques internacionais na fatura.	decimal(18,2)
`summary.transactionsSummary. internationalWithdraw.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsSummary.installment`	`object`	Objeto que contém a soma das transações parceladas na fatura atual.	—
`summary.transactionsSummary.installment.value`	`number`	Soma das transações parceladas na fatura atual.	decimal(18,2)
`summary.transactionsSummary.installment.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary. transactionsCardsSummary []`	`array of objects`	Lista de objetos que contém os valores totais das transações da fatura, agrupados por cartão e divididos por categoria de transação.	—
`summary.transactionsCardsSummary[].card`	`object`	Objeto que contém as informações do cartão atrelado à transação.	—
`summary.transactionsCardsSummary[].card.type`	`string`	Tipo do cartão, o qual pode ser “Virtual” ou “Physical”.	10
`summary.transactionsCardsSummary[]. card.lastFourDigitis`	`string`	Últimos quatro dígitos do cartão.	4
`summary.transactionsCardsSummary[]. card.name`	`string`	Apelido dado ao cartão.	20
`summary.transactionsCardsSummary[]. card.proxy`	`string`	Identificador único do cartão.	30
`summary.transactionsCardsSummary[].totalDebits`	`object`	Objeto que contém a soma dos itens de débito na fatura atual.	—
`summary.transactionsCardsSummary[].totalDebits.value`	`number`	Soma dos itens de débito na fatura atual.	decimal(18,2)
`summary.transactionsCardsSummary[]. totalDebits.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsCardsSummary[]. nationalPurchasing`	`object`	Objeto que contém a soma das transações nacionais na fatura.	—
`summary.transactionsCardsSummary[]. nationalPurchasing.value`	`number`	Soma das transações nacionais na fatura.	decimal(18,2)
`summary.transactionsCardsSummary[]. nationalPurchasing.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsCardsSummary[].internationalPurchasing[]`	`array of objects`	Lista de objetos que contém a soma das transações internacionais na fatura.	—
`summary.transactionsCardsSummary[].internationalPurchasing[].value`	`number`	Soma das transações internacionais na fatura.	decimal(18,2)
`summary.transactionsCardsSummary[].internationalPurchasing[].currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsCardsSummary[].fees`	`object`	Objeto que contém a soma dos encargos lançados na fatura.	—
`summary.transactionsCardsSummary[].fees.value`	`number`	Soma dos encargos lançados na fatura.	decimal(18,2)
`summary.transactionsCardsSummary[].fees.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsCardsSummary[].debtAdjustments`	`object`	Objeto que contém a soma dos ajustes a débito na fatura.	—
`summary.transactionsCardsSummary[].debtAdjustments.value`	`number`	Soma dos ajustes a débito na fatura.	decimal(18,2)
`summary.transactionsCardsSummary[].debtAdjustments.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsCardsSummary[].creditAdjustments`	`object`	Objeto que contém a soma dos ajustes a crédito na fatura.	—
`summary.transactionsCardsSummary[].creditAdjustments.value`	`number`	Soma dos ajustes a crédito na fatura.	decimal(18,2)
`summary.transactionsCardsSummary[].creditAdjustments.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsCardsSummary[].payments`	`object`	Objeto que contém a soma dos pagamentos por cartão.	—
`summary.transactionsCardsSummary[].payments.value`	`number`	Soma dos pagamentos por cartão.	decimal(18,2)
`summary.transactionsCardsSummary[].payments.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsCardsSummary[].insurance`	`object`	Objeto que contém a soma dos itens de seguro na fatura.	—
`summary.transactionsCardsSummary[].insurance.value`	`number`	Soma dos itens de seguro na fatura.	decimal(18,2)
`summary.transactionsCardsSummary[].insurance.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsCardsSummary[].annuity`	`object`	Objeto que contém a soma dos itens de anuidade na fatura.	—
`summary.transactionsCardsSummary[].annuity.value`	`number`	Soma dos itens de anuidade na fatura.	decimal(18,2)
`summary.transactionsCardsSummary[].annuity.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsCardsSummary[].withdraw`	`object`	Objeto que contém a soma dos saques nacionais na fatura.	—
`summary.transactionsCardsSummary[].withdraw.value`	`number`	Soma dos saques nacionais na fatura.	decimal(18,2)
`summary.transactionsCardsSummary[].withdraw.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsCardsSummary[].internationalWithdraw`	`object`	Objeto que contém a soma dos saques internacionais na fatura.	—
`summary.transactionsCardsSummary[]. internationalWithdraw.value`	`number`	Soma dos saques internacionais na fatura.	decimal(18,2)
`summary.transactionsCardsSummary[]. internationalWithdraw.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsCardsSummary[].installment`	`object`	Objeto que contém a soma das transações parceladas na fatura atual.	—
`summary.transactionsCardsSummary[].installment.value`	`number`	Soma das transações parceladas na fatura atual.	decimal(18,2)
`summary.transactionsCardsSummary[].installment.currency`	`string`	Código da moeda com base na ISO-4217.	3
`paymentOptions[]`	`array of objects`	Lista de objetos que contém informações referentes aos tipos de pagamento disponíveis.	—
`paymentOptions[].paymentOptionId`	`integer`	Identificador único da opção de pagamento.	—
`paymentOptions[].paymentType`	`string`	Opção de pagamento, que pode ser “Cash” (à vista), ou “Partial” (parcial).	25
`paymentOptions[].amount`	`object`	Objeto que contém informações sobre o valor a ser pago.	—
`paymentOptions[].amount.value`	`number`	Valor de pagamento.	decimal(18,2)
`paymentOptions[].amount.currency`	`string`	Código da moeda com base na ISO-4217.	3
`program`	`object`	Objeto que contém informação sobre o ID do programa referente ao cartão do cliente.	—
`program.id`	`integer`	Identificador único do programa.	—
`contract`	`object`	Objeto que contém os dados do contrato de crédito.	—
`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, o qual pode ser “CPF ou “CNPJ”.	4
`designatedFunding`	`string`	Financiadora do contrato.	100
`nextStatement`	`object`	Objeto que contém informações sobre a próxima fatura.	—
`nextStatement.statementId`	`number`	Identificador único da próxima fatura.	int(72754)
`nextStatement.balance`	`number`	Valor total da próxima fatura, o qual pode ser negativo ou positivo.	decimal(74.30)
`nextStatement.balance.cicleCloseDate`	`string`	Data de fechamento da próxima fatura, no formato ISO 8601 - UTC.	—

Payloads do evento

Os payloads abaixo exemplificam 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": "1",
        "metadata": {
            "closed": "2024-02-20T00:00:00"
        },
        "data": {
            "statementId": 1982831,
            "month": 2,
            "year": 2024,
            "cycle": 21,
            "cycleCloseDate": "2024-02-13T00:00:00",
            "dueDate": "2024-02-20T00:00:00",
            "balance": {
                "value": 0,
                "currency": "BRL"
            },
            "amountMinimal": {
                "value": 0,
                "currency": "BRL"
            },
            "previousBalance": {
                "value": 0,
                "currency": "BRL"
            },
            "summary": {
                "outstandingBalance": {
                    "value": 107.35,
                    "currency": "BRL"
                },
                "estimateCharges": {
                    "iof": {
                        "value": 5.55,
                        "currency": "BRL"
                    },
                    "refinance": {
                        "value": 500.47,
                        "currency": "BRL"
                    },
                    "interest": {
                        "value": 120.52,
                        "currency": "BRL"
                    },
                    "traffic": {
                        "value": 12.22,
                        "currency": "BRL"
                    },
                    "annualCet": 4.98,
                    "monthlyCet": 0.114
                },
                "installmentSummary": {
                    "interestFree": {
                        "value": 114.58,
                        "currency": "BRL"
                    },
                    "interest": {
                        "value": 0,
                        "currency": "BRL"
                    },
                    "interestWithoutDiscount": {
                        "value": 0,
                        "currency": "BRL"
                    }
                },
                "amountMinimalComposition": {
                    "outstandingBalance": {
                        "value": 107.35,
                        "currency": "BRL"
                    },
                    "fees": {
                        "value": 27.74,
                        "currency": "BRL"
                    },
                    "refinance": {
                        "value": 26.86,
                        "currency": "BRL"
                    },
                    "transactions": {
                        "value": 152.544,
                        "currency": "BRL"
                    }
                },
                "transactionsSummary": {
                    "nationalPurchasing": {
                        "value": 152.544,
                        "currency": "BRL"
                    },
                    "internationalPurchasing": [
                        {
                            "value": 152.544,
                            "currency": "BRL"
                        },
                        {
                            "value": 152.544,
                            "currency": "USS"
                        }
                    ],
                    "fees": {
                        "value": 152.544,
                        "currency": "BRL"
                    },
                    "debtAdjustments": {
                        "value": 152.544,
                        "currency": "BRL"
                    },
                    "creditAdjustments": {
                        "value": 152.544,
                        "currency": "BRL"
                    },
                    "payments": {
                        "value": 152.544,
                        "currency": "BRL"
                    },
                    "insurance": {
                        "value": 152.544,
                        "currency": "BRL"
                    },
                    "annuity": {
                        "value": 152.544,
                        "currency": "BRL"
                    },
                    "withdraw": {
                        "value": 152.544,
                        "currency": "BRL"
                    },
                    "international_withdraw": {
                        "value": 152.544,
                        "currency": "BRL"
                    },
                    "installment": {
                        "value": 152.544,
                        "currency": "BRL"
                    }
                },
                "transactionsCardsSummary": [
                    {
                        "card": {
                            "type": "virtual",
                            "lastFourDigitis": "1234",
                            "name": "cartão virtual",
                            "proxy": "45567984651321354654"
                        },
                        "totalDebits": {
                            "value": 0,
                            "currency": "BRL"
                        },
                        "nationalPurchasing": {
                            "value": 152.544,
                            "currency": "BRL"
                        },
                        "internationalPurchasing": [
                            {
                                "value": 152.544,
                                "currency": "BRL"
                            },
                            {
                                "value": 152.544,
                                "currency": "USS"
                            }
                        ],
                        "fees": {
                            "value": 152.544,
                            "currency": "BRL"
                        },
                        "debtAdjustments": {
                            "value": 152.544,
                            "currency": "BRL"
                        },
                        "creditAdjustments": {
                            "value": 152.544,
                            "currency": "BRL"
                        },
                        "payments": {
                            "value": 152.544,
                            "currency": "BRL"
                        },
                        "insurance": {
                            "value": 152.544,
                            "currency": "BRL"
                        },
                        "annuity": {
                            "value": 152.544,
                            "currency": "BRL"
                        },
                        "withdraw": {
                            "value": 152.544,
                            "currency": "BRL"
                        },
                        "internationalWithdraw": {
                            "value": 152.544,
                            "currency": "BRL"
                        },
                        "installment": {
                            "value": 152.544,
                            "currency": "BRL"
                        }
                    }
                ]
            },
            "program": {
                "id": 117
            },
            "contract": {
                "number": "002111",
                "type": "Credit"
            },
            "holder": {
                "document": {
                    "value": "47742663023",
                    "type": "CPF"
                }
            },
            "designatedFunding": "BV",
            "nextStatement" : {  
              "statementId": 45263,  
              "balance": 20.63,  
              "cycleCloseDate": "2024-09-15T17:46:25:32.767Z"  
            }
        }
    }
]

[
    {
        "name": "INVOICE_CLOSED",
        "entityId": "1982831",
        "idempotencyKey": "47c32bda-4cde-49d6-b50b-c0c29fc7744e",
        "companyKey": "MELIUZ_DABACURI",
        "timestamp": "2024-02-27T15:17:28.0863407Z",
        "correlationId": "47c32bda-4cde-49d6-b50b-c0c29fc7744e",
        "version": "1",
        "metadata": {
            "closed": "2024-02-20T00:00:00"
        },
        "context": "Invoice",
        "data": {
            "statementId": 1982831,
            "month": 2,
            "year": 2024,
            "cycle": 21,
            "cycleCloseDate": "2024-02-13T00:00:00",
            "dueDate": "2024-02-20T00:00:00",
            "balance": {
                "value": 755.87,
                "currency": "BRL"
            },
            "amountMinimal": {
                "value": 259.89,
                "currency": "BRL"
            },
            "summary": {
                "outstandingBalance": {
                    "value": 107.35,
                    "currency": "BRL"
                },
                "estimatedCharges": {
                    "iof": {
                        "value": 500,
                        "currency": "BRL"
                    },
                    "refinance": {
                        "value": 500,
                        "currency": "BRL"
                    },
                    "interest": {
                        "value": 500,
                        "currency": "BRL"
                    },
                    "traffic": {
                        "value": 500,
                        "currency": "BRL"
                    },
                    "annualCet": 0.144,
                    "monthlyCet": 5.15
                },
                "installmentSummary": {
                    "interestFree": {
                        "value": 114.58,
                        "currency": "BRL"
                    },
                    "interest": {
                        "value": 0,
                        "currency": "BRL"
                    },
                    "interestWithoutDiscount": {
                        "value": 0,
                        "currency": "BRL"
                    }
                },
                "amountMinimalComposition": {
                    "outstandingBalance": {
                        "value": 107.35,
                        "currency": "BRL"
                    },
                    "fees": {
                        "value": 27.74,
                        "currency": "BRL"
                    },
                    "refinance": {
                        "value": 26.86,
                        "currency": "BRL"
                    },
                    "transactions": {
                        "value": 97.944,
                        "currency": "BRL"
                    }
                },
                "transactionsSummary": {
                    "nationalPurchasing": {
                        "value": 152.544,
                        "currency": "BRL"
                    },
                    "internationalPurchasing": [
                        {
                            "value": 152.544,
                            "currency": "BRL"
                        },
                        {
                            "value": 152.544,
                            "currency": "USS"
                        }
                    ],
                    "fees": {
                        "value": 152.544,
                        "currency": "BRL"
                    },
                    "debtAdjustments": {
                        "value": 152.544,
                        "currency": "BRL"
                    },
                    "creditAdjustments": {
                        "value": 152.544,
                        "currency": "BRL"
                    },
                    "payments": {
                        "value": 152.544,
                        "currency": "BRL"
                    },
                    "insurance": {
                        "value": 152.544,
                        "currency": "BRL"
                    },
                    "annuity": {
                        "value": 152.544,
                        "currency": "BRL"
                    },
                    "withdraw": {
                        "value": 152.544,
                        "currency": "BRL"
                    },
                    "international_withdraw": {
                        "value": 152.544,
                        "currency": "BRL"
                    },
                    "installment": {
                        "value": 152.544,
                        "currency": "BRL"
                    }
                },
                "transactionsCardsSummary": [
                    {
                        "card": {
                            "type": "virtual",
                            "lastFourDigitis": "1234",
                            "name": "cartão virtual",
                            "proxy": "45567984651321354654"
                        },
                        "totalDebits": {
                            "value": 0,
                            "currency": "BRL"
                        },
                        "nationalPurchasing": {
                            "value": 152.544,
                            "currency": "BRL"
                        },
                        "internationalPurchasing": [
                            {
                                "value": 152.544,
                                "currency": "BRL"
                            },
                            {
                                "value": 152.544,
                                "currency": "USS"
                            }
                        ],
                        "fees": {
                            "value": 152.544,
                            "currency": "BRL"
                        },
                        "debtAdjustments": {
                            "value": 152.544,
                            "currency": "BRL"
                        },
                        "creditAdjustments": {
                            "value": 152.544,
                            "currency": "BRL"
                        },
                        "payments": {
                            "value": 152.544,
                            "currency": "BRL"
                        },
                        "insurance": {
                            "value": 152.544,
                            "currency": "BRL"
                        },
                        "annuity": {
                            "value": 152.544,
                            "currency": "BRL"
                        },
                        "withdraw": {
                            "value": 152.544,
                            "currency": "BRL"
                        },
                        "internationalWithdraw": {
                            "value": 152.544,
                            "currency": "BRL"
                        },
                        "installment": {
                            "value": 152.544,
                            "currency": "BRL"
                        }
                    }
                ]
            },
            "paymentOptions": [
                {
                    "paymentOptionId": 1229813,
                    "paymentType": "Cash",
                    "amount": {
                        "value": 755.87,
                        "currency": "BRL"
                    }
                },
                {
                    "paymentOptionId": 1229814,
                    "paymentType": "Partial",
                    "amount": {
                        "value": 1,
                        "currency": "BRL"
                    }
                }
            ],
            "program": {
                "id": 117
            },
            "contract": {
                "number": "002111",
                "type": "Credit"
            },
            "holder": {
                "document": {
                    "value": "47742663023",
                    "type": "CPF"
                }
            },
            "designatedFunding": "BV"
        }
    }
]

INVOICE_SUMMARY_WAS_CREATED

Este evento sinaliza a criação de informações referentes à fatura 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`	Indicador do ciclo da fatura (por contrato de crédito).	—
`cycleCloseDate`	`string`	Data de fechamento da fatura, no formato ISO 8601 - UTC.	25
`dueDate`	`string`	Data de vencimento da fatura, no formato ISO 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
`summary`	`object`	Objeto que contém informações resumidas da fatura.	—
`summary.residualBalance`	`object`	Objeto que contém informações sobre o saldo residual devedor ou credor da fatura anterior.	—
`summary.residualBalance.value`	`number`	Valor do saldo residual.	decimal(18,2)
`summary.residualBalance.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.nextStatement`	`object`	Objeto que contém informações referentes à próxima fatura.	—
`summary.nextStatement.statementId`	`integer`	Identificador único da próxima fatura.	—
`summary.nextStatement.cycleCloseDate`	`string`	Data de fechamento da próxima fatura, no formato ISO 8601 - UTC.	25
`summary.nextStatement.balance`	`string`	Valor total da próxima fatura, o qual pode ser negativo ou positivo.	decimal(18,2)
`summary.nextStatement.installmentInterestFree`	`object`	Objeto que contém a soma das parcelas sem juros a serem cobradas na próxima fatura.	—
`summary.nextStatement.installmentInterestFree.value`	`number`	Soma das parcelas sem juros a vencer.	decimal(18,2)
`summary.nextStatement.installmentInterestFree.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.nextStatement.installmentWithInterest`	`object`	Objeto que contém a soma das parcelas com juros a serem cobradas na próxima fatura.	—
`summary.nextStatement.installmentWithInterest.value`	`number`	Soma das parcelas com juros a vencer.	decimal(18,2)
`summary.nextStatement.installmentWithInterest.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.nextStatement.annuity`	`object`	Objeto que contém a soma dos itens de anuidade a serem cobrados na próxima fatura.	—
`summary.nextStatement.annuity.value`	`number`	Soma dos itens de anuidade.	decimal(18,2)
`summary.nextStatement.annuity.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.nextStatement.insurance`	`object`	Objeto que contém a soma dos itens de seguro a serem cobrados na próxima fatura.	—
`summary.nextStatement.insurance.value`	`number`	Soma dos itens de seguro.	decimal(18,2)
`summary.nextStatement.insurance.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.estimatedCharges`	`object`	Objeto que contém o valor estimado de encargos caso a fatura seja rotativada.	—
`summary.estimatedCharges.iof`	`object`	Objeto que contém o valor estimado do IOF caso a fatura seja rotativada	—
`summary.estimatedCharges.iof.value`	`number`	Valor total estimado do IOF.	decimal(18,2)
`summary.estimatedCharges.iof.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.estimatedCharges.refinance`	`object`	Objeto que contém o valor que será refinanciado caso a fatura seja rotativada. Observação: o valor a ser refinanciado é a diferença entre o mínimo da fatura e o valor total.	—
`summary.estimatedCharges.refinance.value`	`number`	Valor total a ser refinanciado.	decimal(18,2)
`summary.estimatedCharges.refinance.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.estimatedCharges.interest`	`object`	Objeto que contém o valor estimado do encargo de refinanciamento caso a fatura seja rotativada.	—
`summary.estimatedCharges.interest.value`	`number`	Valor total estimado dos encargos de refinanciamento.	decimal(18,2)
`summary.estimatedCharges.interest.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.estimatedCharges.traffic`	`object`	Objeto que contém o valor estimado da multa caso a fatura seja rotativada.	—
`summary.estimatedCharges.traffic.value`	`number`	Valor total estimado da multa.	decimal(18,2)
`summary.estimatedCharges.traffic.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.estimatedCharges.annualCet`	`number`	Percentual anual do custo efetivo total da operação de rotativo.	decimal(18,2)
`summary.estimatedCharges. monthlyCet`	`number`	Percentual mensal do custo efetivo total da operação de rotativo.	decimal(18,2)
`summary.totalFutureBalance`	`object`	Objeto que contém o valor do saldo futuro total da conta de crédito.	—
`summary.totalFutureBalance.installmentInterestFree`	`object`	Objeto que contém a soma das parcelas sem juros a serem cobradas na próxima fatura.	—
`summary.totalFutureBalance.installmentInterestFree.value`	`number`	Soma das parcelas sem juros a vencer.	decimal(18,2)
`summary.totalFutureBalance.installmentInterestFree.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.totalFutureBalance.installmentWithInterest`	`object`	Objeto que contém a soma das parcelas com juros a serem cobradas na próxima fatura.	—
`summary.totalFutureBalance.installmentWithInterest.value`	`number`	Soma das parcelas com juros a vencer.	decimal(18,2)
`summary.totalFutureBalance.installmentWithInterest.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.totalFutureBalance. installmentWithInterestWithDiscount`	`object`	Objeto que contém a soma das parcelas com juros a vencer, lançadas na próxima fatura com desconto.	—
`summary.totalFutureBalance. InstallmentWithInterestWithDiscount.value`	`number`	Soma das parcelas com juros a vencer, com desconto.	decimal(18,2)
`summary.totalFutureBalance.installmentWithInterest.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.totalFutureBalance.annuity`	`object`	Objeto que contém a soma dos itens de anuidade a serem cobrados na próxima fatura.	—
`summary.totalFutureBalance.annuity.value`	`number`	Soma dos itens de anuidade.	decimal(18,2)
`summary.totalFutureBalance.annuity.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.totalFutureBalance.insurance`	`object`	Objeto que contém a soma dos itens de seguro a serem cobrados na próxima fatura.	—
`summary.totalFutureBalance.insurance.value`	`number`	Soma dos itens de seguro.	decimal(18,2)
`summary.totalFutureBalance.insurance.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.amountMinimalComposition`	`object`	Objeto que contém os valores que compõem o valor de pagamento mínimo da fatura.	—
`summary.amountMinimalComposition.outstandingBalance`	`object`	Objeto que contém o saldo residual devedor da fatura anterior.	—
`summary.amountMinimalComposition.outstandingBalance.value`	`number`	Valor total do saldo residual.	decimal(18,2)
`summary.amountMinimalComposition.outstandingBalance.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.amountMinimalComposition.fees`	`object`	Objeto que contém a soma dos encargos lançadas na fatura.	—
`summary.amountMinimalComposition.fees.value`	`number`	Soma dos encargos lançadas na fatura.	decimal(18,2)
`summary.amountMinimalComposition.fees.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.amountMinimalComposition.refinance`	`object`	Objeto que contém a soma dos itens de refinanciamento lançadas na fatura.	—
`summary.amountMinimalComposition.refinance.value`	`number`	Soma dos itens de refinanciamento.	decimal(18,2)
`summary.amountMinimalComposition.refinance.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.amountMinimalComposition.transactions`	`object`	Objeto que contém a soma dos itens de débito lançados na fatura.	—
`summary.amountMinimalComposition.transactions.value`	`number`	Soma dos itens de débito lançados na fatura.	decimal(18,2)
`summary.amountMinimalComposition.transactions.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsSummary`	`object`	Objeto que contém os valores totalizadores das transações da fatura.	—
`summary.transactionsSummary.nationalPurchasing`	`object`	Objeto que contém a soma das transações nacionais na fatura.	—
`summary.transactionsSummary. nationalPurchasing.value`	`number`	Somas das transações nacionais da fatura.	decimal(18,2)
`summary.transactionsSummary. nationalPurchasing.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsSummary.internationalPurchasing[]`	`array of objects`	Objeto que contém a soma das transações internacionais na fatura.	—
`summary.transactionsSummary.internationalPurchasing[].value`	`number`	Somas das transações internacionais da fatura.	decimal(18,2)
`summary.transactionsSummary.internationalPurchasing[].currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsSummary.fees`	`object`	Objeto que contém a soma dos encargos lançados na fatura.	—
`summary.transactionsSummary.fees.value`	`number`	Soma dos encargos lançados na fatura.	decimal(18,2)
`summary.transactionsSummary.fees.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsSummary.debtAdjustments`	`object`	Objeto que contém a soma dos ajustes a débito na fatura.	—
`summary.transactionsSummary. debtAdjustments.value`	`number`	Soma dos ajustes a débito na fatura.	decimal(18,2)
`summary.transactionsSummary.debtAdjustments.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsSummary. creditAdjustments`	`object`	Objeto que contém a soma dos ajustes a crédito na fatura.	—
`summary.transactionsSummary.creditAdjustments.value`	`number`	Soma dos ajustes a crédito na fatura.	decimal(18,2)
`summary.transactionsSummary.creditAdjustments.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsSummary.payments`	`object`	Objeto que contém a soma dos pagamentos realizados.	—
`summary.transactionsSummary.payments.value`	`number`	Soma dos pagamentos.	decimal(18,2)
`summary.transactionsSummary.payments.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsSummary.insurance`	`object`	Objeto que contém a soma dos itens de seguro na fatura.	—
`summary.transactionsSummary.insurance.value`	`number`	Soma dos itens de seguro na fatura.	decimal(18,2)
`summary.transactionsSummary.insurance.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsSummary.annuity`	`object`	Objeto que contém a soma dos itens de anuidade na fatura.	—
`summary.transactionsSummary.annuity.value`	`number`	Soma dos itens de anuidade na fatura.	decimal(18,2)
`summary.transactionsSummary.annuity.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsSummary.withdraw`	`object`	Objeto que contém a soma dos saques nacionais na fatura.	—
`summary.transactionsSummary.withdraw.value`	`number`	Soma dos saques nacionais na fatura.	decimal(18,2)
`summary.transactionsSummary.withdraw.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsSummary.internationalWithdraw`	`object`	Objeto que contém a soma dos saques internacionais na fatura.	—
`summary.transactionsSummary. internationalWithdraw.value`	`number`	Soma dos saques internacionais na fatura.	decimal(18,2)
`summary.transactionsSummary. internationalWithdraw.currency`	`string`	Código da moeda com base na ISO-4217.	3
`summary.transactionsSummary.installment`	`object`	Objeto que contém a soma das transações parceladas na fatura atual.	—
`summary.transactionsSummary.installment.value`	`number`	Soma das transações parceladas na fatura atual.	decimal(18,2)
`summary.transactionsSummary.installment.currency`	`string`	Código da moeda com base na ISO-4217.	3
`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 os dados do 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, o qual 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

[
    { 
        "name": "INVOICE_SUMMARY_WAS_CREATED", 
        "entityId": "3304186", 
        "idempotencyKey": "c652d683-0165-4a1e-9d3f-19f083d80a86", 
        "companyKey": "BANCO_DIGITAL_BCO_BV", 
        "timestamp": "2024-07-27T03:50:33.6247417Z", 
        "correlationId": "c652d683-0165-4a1e-9d3f-19f083d80a86", 
        "version": "1", 
        "metadata": { 
            "closed": "2021-12-06T11:10:20.282 " 
        }, 
        "context": "Invoice", 
        "data": { 
            "statementId": 3304186 , 
            "month": 8, 
            "year": 2024, 
            "cycle": 1, 
            "cycleCloseDate": "2024-07-27T00:00:00", 
            "dueDate": "2024-08-01T00:00:00", 
            "balance": { 
                "value": 543.15, 
                "currency": "BRL" 
            }, 
            "amountMinimal": { 
                "value": 81.47, 
                "currency": "BRL" 
            }, 
            "summary": { 
                "residualBalance": { 
                    "value": 0, 
                    "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" 
                    } 
                }, 
                "estimatedCharges": { 
                    "iof": { 
                        "value": 1.75, 
                        "currency": "BRL" 
                    }, 
                    "refinance": { 
                        "value": 461.68, 
                        "currency": "BRL" 
                    }, 
                    "interest": { 
                        "value": 0, 
                        "currency": "BRL" 
                    }, 
                    "traffic": { 
                        "value": 0, 
                        "currency": "BRL" 
                    }, 
                    "annualCet": 297.86, 
                    "monthlyCet": 12.02 
                }, 
                "totalFutureBalance": { 
                    "installmentInterestFree": { 
                        "value": 60.87, 
                        "currency": "BRL" 
                    }, 
                    "installmentWithInterest": { 
                        "value": 16018.8, 
                        "currency": "BRL" 
                    }, 
                    "installmentWithInterestWithDiscount": { 
                        "value": 0, 
                        "currency": "BRL" 
                    }, 
                    "annuity": { 
                        "value": 0, 
                        "currency": "BRL" 
                    }, 
                    "insurance": { 
                        "value": 0, 
                        "currency": "BRL" 
                    } 
                }, 
                "amountMinimalComposition": { 
                    "outstandingBalance": { 
                        "value": 0, 
                        "currency": "BRL" 
                    }, 
                    "fees": { 
                        "value": 0, 
                        "currency": "BRL" 
                    }, 
                    "refinance": { 
                        "value": 0, 
                        "currency": "BRL" 
                    }, 
                    "transactions": { 
                        "value": 81.4725, 
                        "currency": "BRL" 
                    } 
                }, 
                "transactionsSummary": { 
                    "nationalPurchasing": { 
                        "value": 152.544, 
                        "currency": "BRL" 
                    }, 
                    "internationalPurchasing": [ 
                        { 
                            "value": 152.544, 
                            "currency": "BRL" 
                        }, 
                        { 
                            "value": 152.544, 
                            "currency": "USS" 
                        } 
                    ], 
                    "fees": { 
                        "value": 152.544, 
                        "currency": "BRL" 
                    }, 
                    "debtAdjustments": { 
                        "value": 152.544, 
                        "currency": "BRL" 
                    }, 
                    "creditAdjustments": { 
                        "value": 152.544, 
                        "currency": "BRL" 
                    }, 
                    "payments": { 
                        "value": 152.544, 
                        "currency": "BRL" 
                    }, 
                    "insurance": { 
                        "value": 152.544, 
                        "currency": "BRL" 
                    }, 
                    "annuity": { 
                        "value": 152.544, 
                        "currency": "BRL" 
                    }, 
                    "withdraw": { 
                        "value": 152.544, 
                        "currency": "BRL" 
                    }, 
                    "internationalWithdraw": { 
                        "value": 152.544, 
                        "currency": "BRL" 
                    }, 
                    "installment": { 
                        "value": 152.544, 
                        "currency": "BRL" 
                    } 
                } 
            }, 
            "program": { 
                "id": 704 
            }, 
            "contract": { 
                "number": "1949270", 
                "type": "Credit" 
            }, 
            "holder": { 
                "document": { 
                    "value": "15516427860", 
                    "type": "CPF" 
                } 
            }, 
            "designatedFunding": "BV" 
        } 
    }
]

INVOICE_TRANSACTIONS_SUMMARY_WAS_CREATED

Este evento sinaliza a criação de informações resumidas referentes aos itens atrelados à fatura 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`	Indicador do ciclo da fatura.	—
`cycleCloseDate`	`string`	Data de fechamento da fatura, no formato ISO 8601 - UTC.	25
`dueDate`	`string`	Data de vencimento da fatura, no formato ISO 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
`transactionsCardsSummary[]`	`array of objects`	Lista de objetos que contém a soma das transações da fatura, agrupados por cartão.	—
`summary.transactionsCardsSummary[].card`	`object`	Objeto que contém as informações do cartão atrelado à transação.	—
`transactionsCardsSummary[].card.cardType`	`string`	Tipo do cartão, o qual pode ser “Virtual” ou “Physical”.	10
`transactionsCardsSummary[].card.lastFourDigits`	`string`	Últimos quatro dígitos do cartão.	4
`transactionsCardsSummary[].card.cardName`	`string`	Apelido dado ao cartão.	20
`transactionsCardsSummary[].card.proxy`	`string`	Identificador único do cartão.	30
`transactionsCardsSummary[].totalDebits`	`object`	Objeto que contém a soma dos itens de débito na fatura atual.	—
`transactionsCardsSummary[].totalDebits.value`	`number`	Soma dos itens de débito na fatura atual.	decimal(18,2)
`transactionsCardsSummary[].totalDebits.currency`	`string`	Código da moeda com base na ISO-4217.	3
`transactionsCardsSummary[].nationalPurchasing`	`object`	Objeto que contém a soma das transações nacionais na fatura.	—
`transactionsCardsSummary[].nationalPurchasing.value`	`number`	Soma das transações nacionais na fatura.	decimal(18,2)
`transactionsCardsSummary[].nationalPurchasing.currency`	`string`	Código da moeda com base na ISO-4217.	3
`transactionsCardsSummary[].internationalPurchasing[]`	`array of objects`	Lista de objetos que contém a soma das transações internacionais na fatura.	—
`transactionsCardsSummary[].internationalPurchasing[].value`	`number`	Soma das transações internacionais na fatura.	decimal(18,2)
`transactionsCardsSummary[].internationalPurchasing[].currency`	`string`	Código da moeda com base na ISO-4217.	3
`transactionsCardsSummary[]. fees`	`object`	Objeto que contém a soma dos encargos lançados na fatura.	—
`transactionsCardsSummary[].fees.value`	`number`	Soma dos encargos lançados na fatura.	decimal(18,2)
`transactionsCardsSummary[].fees.currency`	`string`	Código da moeda com base na ISO-4217.	3
`transactionsCardsSummary[]. debtAdjustments`	`object`	Objeto que contém a soma dos ajustes a débito na fatura.	—
`transactionsCardsSummary[]. debtAdjustments.value`	`number`	Soma dos ajustes a débito na fatura.	decimal(18,2)
`transactionsCardsSummary[].debtAdjustments.currency`	`string`	Código da moeda com base na ISO-4217.	3
`transactionsCardsSummary[]. creditAdjustments`	`object`	Objeto que contém a soma dos ajustes a crédito na fatura.	—
`transactionsCardsSummary[].creditAdjustments.value`	`number`	Soma dos ajustes a crédito na fatura.	decimal(18,2)
`transactionsCardsSummary[].creditAdjustments.currency`	`string`	Código da moeda com base na ISO-4217.	3
`transactionsCardsSummary[].insurance`	`object`	Objeto que contém a soma dos itens de seguro na fatura.	—
`transactionsCardsSummary[].insurance.value`	`number`	Soma dos itens de seguro na fatura.	decimal(18,2)
`transactionsCardsSummary[].insurance.currency`	`string`	Código da moeda com base na ISO-4217.	3
`transactionsCardsSummary[].annuity`	`object`	Objeto que contém a soma dos itens de anuidade na fatura.	—
`transactionsCardsSummary[].annuity.value`	`number`	Soma dos itens de anuidade na fatura.	decimal(18,2)
`transactionsCardsSummary[].annuity.currency`	`string`	Código da moeda com base na ISO-4217.	3
`transactionsCardsSummary[].withdraw`	`object`	Objeto que contém a soma dos saques nacionais na fatura.	—
`transactionsCardsSummary[].withdraw.value`	`number`	Soma dos saques nacionais na fatura.	decimal(18,2)
`transactionsCardsSummary[].withdraw.currency`	`string`	Código da moeda com base na ISO-4217.	3
`transactionsCardsSummary[].internationalWithdraw`	`object`	Objeto que contém a soma dos saques internacionais na fatura.	—
`transactionsCardsSummary[]. internationalWithdraw.value`	`number`	Soma dos saques internacionais na fatura.	decimal(18,2)
`transactionsCardsSummary[]. internationalWithdraw.currency`	`string`	Código da moeda com base na ISO-4217.	3
`transactionsCardsSummary[].installment`	`object`	Objeto que contém a soma das transações parceladas na fatura atual.	—
`transactionsCardsSummary[].installment.value`	`number`	Soma das transações parceladas na fatura atual.	decimal(18,2)
`transactionsCardsSummary[].installment.currency`	`string`	Código da moeda com base na ISO-4217.	3
`transactionsCardsSummary[]payments`	`object`	Objeto que contém a soma dos pagamentos realizados, por cartão.	—
`transactionsCardsSummary.[] payments.value`	`number`	Soma dos pagamentos por cartão.	decimal(18,2)
`transactionsCardsSummary[].payments.currency`	`string`	Código da moeda com base na ISO-4217.	3
`program.id`	`int`	Identificador único do programa.	—
`contract`	`object`	Objeto que contém os dados do 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, o qual 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

[
    { 
        "name": "INVOICE_TRANSACTIONS_SUMMARY_WAS_CREATED", 
        "entityId": "3260618", 
        "idempotencyKey": "28bc8121-7eaa-4f8a-90c2-6edaefdcc868", 
        "companyKey": "BANCO_DIGITAL_BCO_BV", 
        "timestamp": "2024-08-15T03:36:57.7223827Z", 
        "correlationId": "28bc8121-7eaa-4f8a-90c2-6edaefdcc868", 
        "version": "1", 
        "metadata": { 
            "closed": "2021-12-06T11:10:20.282 " 
        }, 
        "context": "Invoice", 
        "data": { 
            "statementId": 78963, 
            "month": 8, 
            "year": 2024, 
            "cycle": 2, 
            "cycleCloseDate": "2024-08-15T00:00:00", 
            "dueDate": "2024-08-20T00:00:00", 
            "balance": { 
                "value": 1826.73, 
                "currency": "BRL" 
            }, 
            "amountMinimal": { 
                "value": 274.01, 
                "currency": "BRL" 
            }, 
            "transactionsCardsSummary": [ 
                { 
                    "card": { 
                        "proxy": "223462677031625", 
                        "lastFourDigits": "7161", 
                        "cardName": "CARD1", 
                        "cardType": "Physical" 
                    }, 
                    "totalDebits": { 
                        "value": 7107.83, 
                        "currency": "BRL" 
                    }, 
                    "nationalPurchasing": { 
                        "value": 7107.83, 
                        "currency": "BRL" 
                    }, 
                    "internationalPurchasing": { 
                        "value": 100, 
                        "currency": "BRL" 
                    }, 
                    "fees": { 
                        "value": 2.82, 
                        "currency": "BRL" 
                    }, 
                    "debtAdjustments": { 
                        "value": 456.97, 
                        "currency": "BRL" 
                    }, 
                    "creditAdjustments": { 
                        "value": 456.97, 
                        "currency": "BRL" 
                    }, 
                    "insurance": { 
                        "value": 456.97, 
                        "currency": "BRL" 
                    }, 
                    "annuity": { 
                        "value": 456.97, 
                        "currency": "BRL" 
                    }, 
                    "withdraw": { 
                        "value": 456.97, 
                        "currency": "BRL" 
                    }, 
                    "internationalWithdraw": { 
                        "value": 456.97, 
                        "currency": "BRL" 
                    }, 
                    "installment": { 
                        "value": 621.22, 
                        "currency": "BRL" 
                    }, 
                    "payments": { 
                        "value": 621.22, 
                        "currency": "BRL" 
                    } 
                }, 
                { 
                    "card": {}, 
                    "payments": { 
                        "value": 621.22, 
                        "currency": "BRL" 
                    }, 
                    "fees": { 
                        "value": 2.82, 
                        "currency": "BRL" 
                    }, 
                    "totalDebits": { 
                        "value": 2.82, 
                        "currency": "BRL" 
                    } 
                } 
            ], 
            "program": { 
                "id": 704 
            }, 
            "contract": { 
                "number": "1915078", 
                "type": "Credit" 
            }, 
            "holder": { 
                "document": { 
                    "value": "31408477777", 
                    "type": "CPF" 
                } 
            }, 
            "designatedFunding": "BV" 
        } 
    }
]

INVOICE_CLOSED_TRANSACTION_DETAILS_WAS_CREATED

Este evento sinaliza que as informações detalhadas referentes aos itens atrelados à fatura fechada foram criadas.

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
`statementItens[]`	`array of objects`	Lista de objetos contendo informações sobre os itens da fatura.	—
`statementItens[].statementNumber`	`integer`	Número da parcela.	—
`statementItens[].statementTotal`	`integer`	Total de parcelas do item.	—
`statementItens[].isCredit`	`boolean`	Indica se é uma operação de crédito (true) ou débito (false).	5
`statementItens[].transactionDate`	`string`	Data em que ocorreu a transação, no formato 8601 - UTC.	24
`statementItens[].createdAt`	`string`	Data de criação da transação na fatura, no formato 8601 - UTC.	24
`statementItens[].transactionType`	`string`	Tipo da transação.	100
`statementItens[].transaction`	`object`	Objeto que contém informações sobre a transação do item de fatura. Os subcampos deste objeto somente serão retornados caso o item seja de uma transação bandeirada (compra, estorno ou outra ação realizada com o cartão). Caso se trate de encargos, pagamentos, anuidade etc., ele não será preenchido.	—
`statementItens[].transaction.merchant`	`string`	Nome do estabelecimento/comerciante que aceitou a transação.	100
`statementItens[].transaction.mcc`	`string`	Código MCC da transação.	10
`statementItens[].transaction.entrymode`	`string`	Código que identifica o tipo da transação.	10
`statementItens[].transaction.mcg`	`string`	Descrição do tipo do MCC.	20
`statementItens[].transaction.merchantCity`	`string`	Cidade onde foi realizada a transação.	50
`statementItens[].transaction.merchantStateOrCountry`	`string`	Estado ou país onde foi realizada a transação.	15
`statementItens[].transaction.merchantZipCode`	`string`	Código postal do local em que a transação foi realizada.	15
`statementItens[].transaction.card`	`object`	Objeto que contém informações sobre o cartão utilizado na transação.	—
`statementItens[].transaction.card.proxy`	`string`	Identificador do cartão utilizado na transação.	30
`statementItens[].transaction.card.lastFourDigits`	`string`	Quatro últimos dígitos do cartão.	4
`statementItens[].transaction.card.alias`	`string`	Apelido dado ao cartão.	20
`statementItens[].transaction.card.cardType`	`string`	Tipo do cartão, o qual pode ser “Physical” (físico) ou “Virtual” (virtual).	10
`statementItens[].amounts[]`	`array of objects`	Lista de objetos contendo os valores de cada item de fatura.	—
`statementItens[].amounts[].amountType`	`string`	Indicador do item de fatura, o qual pode ser “NotMapper” (não informado), “Local” (valor da moeda local), “Exchange” (valor em dólar da transação, no caso de compra internacional) ou “Billet” (valor cobrado, em real, ao cliente).	10
`statementItens[].amounts[].value`	`number`	Valor do item de fatura.	decimal(18,2)
`statementItens[].amounts[].currency`	`string`	Código da moeda com base na ISO-4217.	3
`statementItens[].fees[]`	`array of objects`	Lista de objetos contendo informações sobre as taxas cobradas em saques e transações internacionais.	—
`statementItens[].fees[].feeType`	`string`	Tipo de taxa.	10
`statementItens[].fees[].value`	`number`	Valor da taxa.	decimal(18,2)
`statementItemId`	`integer`	Identificador do item de fatura.	—
`statementItens[].transactionDescription`	`string`	Descritivo do item da fatura.	150
`statementItens[].isAnticipation`	`boolean`	Indica se o item da fatura foi antecipado (true) ou não (false).	—
`statementItens[].exchangefee`	`object`	Objeto que contém informações sobre a taxa de conversão utilizada em transações internacionais.	—
`statementItens[].exchangefee.value`	`number`	Valor da taxa.	decimal(18,4)
`statementItens[].exchangefee.currency`	`string`	Código da moeda com base na ISO-4217.	3
`program`	`object`	Objeto que contém os dados do programa.	—
`program.id`	`integer`	Identificador único do programa.	—
`contract`	`object`	Objeto que contém os dados do 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.	—
`holder.document.value`	`string`	Número do documento.	50
`holder.document.type`	`string`	Tipo de documento, o qual 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": "1982831",
        "idempotencyKey": "86447d19-687f-4fa8-80cf-a5ii406457b9",
        "companyKey": "ACESSO",
        "context": "Invoice",
        "name": "INVOICE_CLOSED_TRANSACTION_DETAILS_WAS_CREATED",
        "timestamp": "2021-12-06T11:10:25.3853601Z",
        "correlationId": "7a1bfc3f-50e6-458c-aa9b-d33a22ddb84d",
        "licenseUuid": "24ac71da-4309-4348-9cc0-a0c88f867993",
        "version": "1",
        "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"
            },
            "statementItens": [
                {
                    "statementNumber": 0,
                    "statementTotal": 0,
                    "isCredit": true,
                    "transactionDate": "2022-10-25T17:21:35.407Z",
                    "createdAt": "2022-10-25T17:21:35.407Z",
                    "transactionType": "REFINANCE_CHARGES",
                    "transaction": {
                        "merchant": "string",
                        "mcc": "string",
                        "entrymode": "string",
                        "mcg": "string",         
                        "merchantCity": "São Paulo",
                        "merchantZipCode": "12345789",
                        "merchantStateOrCountry": "BRA",
                        "card": {
                            "proxy": "string",
                            "lastFourDigits": "4815",
                            "alias": "string",
                            "cardType": "string"
                        }
                    },
                    "amounts": [
                        {
                            "amountType": "NotMapper",
                            "value": 0,
                            "currency": "string"
                        }
                    ],
                    "fees": [
                        {
                            "feeType": "NotMapper",
                            "value": 0
                        }
                    ],
                    "statementItemId": 0,
                    "transactionDescription": "string",
                    "isAnticipation": false,
                    "exchangeFee": {
                      "value": 10.0,
                      "currency": "BRL"
                      }           
                }
            ],
            "program": {
                "id": 117
            },
            "contract": {
                "number": "002111",
                "type": "Credit"
            },
            "holder": {
                "document": {
                    "value": "14952781747",
                    "type": "CPF"
                }
            },
            "designatedFunding": "BV"
        }
    }
]

CONTRACTED_INSTALLMENT_PLANS

Este evento sinaliza que as informações referentes aos planos de refinanciamento atrelados ao contrato de crédito foram disponibilizados.

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.	—
`cycleCloseDate`	`string`	Data de fechamento da fatura, no formato ISO 8601 - UTC.	25
`dueDate`	`string`	Data de vencimento da fatura, no formato ISO 8601 - UTC.	25
`creditOperations[]`	`array of objects`	Lista de objetos que contém todas as operações de crédito contradas que possuem item na fatura.	—
`creditOperations[].creditOfferId`	`integer`	Identificador único da proposta.	10
`creditOperations[].ExternalOperationId`	`string`	Identificador externo da operação.	40
`creditOperations[].ExternalOfferId`	`string`	Identificador externo da proposta.	40
`creditOperations[].creditOfferType`	`string`	Tipo da operação de crédito.	50
`creditOperations[].creditContractDate`	`string`	Data da confirmação da proposta, no formato ISO 8601 - UTC.	25
`creditOperations[].totalCreditAmount`	`number`	Valor total financiado na operação de crédito.	decimal(18,4)
`creditOperations[].totalInterestAmount`	`number`	Valor total de juros na operação de crédito.	decimal(18,4)
`creditOperations[].iofTotalAmount`	`number`	Valor total de IOF na operação de crédito.	decimal(18,4)
`creditOperations[].remainingBalance`	`number`	Valor em aberto da operação de crédito.	decimal(18,4)
`creditOperations[].totalInstallmentsPaid`	`integer`	Número total de parcelas pagas da operação de crédito.	—
`creditOperations[].totalInstallments`	`integer`	Número total de parcelas da operação de crédito.	—
`creditOperations[].installments[]`	`Array of Objects`	Lista de objetos que descreve as parcelas e suas informações.	—
`creditOperations[].installments[].installmentNumber`	`integer`	Número da parcela.	—
`creditOperations[].installments[].dueDate`	`string`	Data de vencimento da parcela, no formato ISO 8601 - UTC.	25
`creditOperations[].installments[].status`	`string`	Situação da parcela, a qual pode ser “Em aberto” ou “Paga”.	20
`creditOperations[].installments[].paidAmount`	`number`	Valor pago da parcela.	decimal(18,4)
`creditOperations[].installments[].interestCharged`	`number`	Valor total de juros na parcela.	decimal(18,4)
`creditOperations[].installments[].iofTotalAmount`	`number`	Valor total de IOF na parcela.	decimal(18,4)
`creditOperations[].installments[].principalBalance`	`number`	Valor do principal da dívida na parcela.	decimal(18,4)
`program`	`object`	Objeto que contém os dados do programa	—
`program.id`	`integer`	Identificador único do programa.	—
`contract`	`object`	Objeto que contém os dados do contrato.	—
`contract.number`	`string`	Número do contrato de crédito.	10
`contract.type`	`string`	Tipo do contrato de crédito, o qual sempre será “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.	—
`holder.document.value`	`string`	Número do documento.	50
`holder.document.type`	`string`	Tipo de documento, o qual 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

[
	{ 
        "name": "CONTRACTED_INSTALLMENT_PLANS", 
        "entityId": "3350650", 
        "idempotencyKey": "1971a544-741e-47c2-8150-6e674bf037e6", 
        "companyKey": "BANCO_DIGITAL_BCO_BV", 
        "timestamp": "2024-07-27T03:45:03.4316265Z", 
        "correlationId": "1971a544-741e-47c2-8150-6e674bf037e6", 
        "version": "1", 
        "metadata": { 
            "closed": "2024-02-20T00:00:00" 
        }, 
        "context": "Invoice", 
        "data": { 
            "statementId": 3350650, 
            "cycleCloseDate": "2024-07-27T00:00:00", 
            "dueDate": "2024-08-01T00:00:00", 
            "creditOperations": [ 
                { 
                    "creditOfferId": "8907255", 
                    "ExternalOfferId": "4434f525-ea95-42c1-92c5-27ac8136aada", 
                    "creditOfferType": "Parcelado", 
                    "creditContractDate": "2023-01-15T00:00:00", 
                    "totalCreditAmount": 1800, 
                    "totalInterestAmount": 100, 
                    "IOFTotalAmount": 10, 
                    "remainingBalance": 850, 
                    "totalInstallmentsPaid": 1, 
                    "totalInstallments": 12, 
                    "installments": [ 
                        { 
                            "installmentNumber": 1, 
                            "installmentAmount": 150, 
                            "dueDate": "2024-09-15T00:00:00", 
                            "status": "Em Aberto", 
                            "paidAmount": 150, 
                            "interestCharged": 10, 
                            "IofTotalAmount": 5, 
                            "principalBalance": 1000 
                        }, 
                        { 
                            "installmentNumber": 2, 
                            "installmentAmount": 150, 
                            "dueDate": "2024-10-15T00:00:00", 
                            "status": "Em Aberto", 
                            "paidAmount": 0, 
                            "interestCharged": 15, 
                            "remainingInterest": 40, 
                            "IofTotalAmount": 5, 
                            "principalBalance": 850 
                        } 
                    ] 
                } 
            ], 
            "program": { 
                "id": 704 
            }, 
            "contract": { 
                "number": "1915078", 
                "type": "Credit" 
            }, 
            "holder": { 
                "document": { 
                    "value": "47742663023", 
                    "type": "CPF" 
                } 
            }, 
            "designatedFunding": "BV" 
        } 
    }
]

INVOICE_CLOSED_WAS_FINISHED

Este evento sinaliza que o processo de envio de eventos para composição da fatura foi finalizado.

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`	Indicador do ciclo da fatura.	—
`cycleCloseDate`	`string`	Data de fechamento da fatura, no formato ISO 8601 - UTC.	25
`dueDate`	`string`	Data de vencimento da fatura, no formato ISO 8601 - UTC.	25
`realDueDate`	`string`	Data de vencimento real da fatura, no formato ISO 8601 - UTC.	25
`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 os dados do contrato.	—
`contract.number`	`string`	Valor do contrato de crédito.	10
`contract.type`	`string`	Tipo do contrato de crédito, o qual sempre será “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.	—
`holder.document.value`	`string`	Número do documento.	50
`holder.document.type`	`string`	Tipo de documento, o qual 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

[
	{
        "name": "INVOICE_CLOSED_WAS_FINISHED",
        "entityId": "3350650",
        "idempotencyKey": "1971a544-741e-47c2-8150-6e674bf037e6",
        "companyKey": "BANCO_DIGITAL_BCO_BV",
        "timestamp": "2024-07-27T03:45:03.4316265Z",
        "correlationId": "1971a544-741e-47c2-8150-6e674bf037e6",
        "version": "1",
        "metadata": {
            "closed": "2024-02-20T00:00:00"
        },
        "context": "Invoice",
        "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",
            "program": {
                "id": 704
            },
            "contract": {
                "number": "1915078",
                "type": "Credit"
            },
            "holder": {
                "document": {
                    "value": "47742663023",
                    "type": "CPF"
                }
            },
            "designatedFunding": "BV"
        }
    }
]

INVOICE_PAYMENT_OPTION_CREATED

Este evento sinaliza que a opção de pagamento de fatura foi criada.

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`	`number`	Identificador único da fatura.	—
`paymentType`	`string`	Opção de pagamento, que pode ser: “Cash” (à vista), “Partial” (parcial), “InstallmentWithEntry” (parcelado com entrada), “InstallmentWithoutEntry” (parcelado sem entrada).	25
`program`	`object`	Objeto que contém informação sobre o programa.	—
`program.id`	`integer`	Identificador único do programa.	—
`contract`	`object`	Objeto que contém informações sobre o contrato de crédito.	—
`contract.number`	`string`	Número do contrato de crédito.	10
`contract.type`	`string`	Tipo do contrato de crédito, o qual sempre será “Credit”.	6
`holder`	`object`	Objeto que contém informações do titular do cartão.	—
`holder.document`	`object`	Objeto que contém informações sobre o documento do titular.	—
`holder.document.value`	`string`	Número do documento.	50
`holder.document.type`	`string`	Tipo de documento, o qual pode ser “CPF ou “CNPJ”.	4
`payment`	`object`	Objeto que contém informações sobre o pagamento.	—
`payment.authenticationCode`	`string`	Identificador da forma de pagamento.	40
`payment.digitableLine`	`string`	Linha digitável do boleto de pagamento.	50
`payment.dueDate`	`string`	Data de vencimento do pagamento.	25
`payment.paymentOptionType`	`string`	Forma de pagamento. No caso de faturas de cartão, este campo virá preenchido com o valor “Billet” (Boleto).	6
`payment.status`	`string`	Situação da forma de pagamento, que pode ser: “Pending” (pendente), “Paid” (pago) ou “Expired” (expirado).	7
`payment.amount`	`object`	Objeto que contém informações sobre o valor pago.	—
`payment.amount.value`	`number`	Valor de pagamento.	decimal(18,2)
`payment.amount.currency`	`string`	Código da moeda com base na ISO-4217.	3
`payment.ourNumber`	`string`	Identificador do boleto de pagamento.	40
`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

{
   "name": "INVOICE_PAYMENT_OPTION_CREATED",
   "entityId": "12345",
   "idempotencyKey": "1f40aeec-310c-4c71-b393-461bcbbd6348",
   "companyKey": "COMPANY_KEY",
   "timestamp": "2022-04-25T11:54:10.923222Z",
   "correlationId": "3811ed19-ac34-4e77-b300-64479666a503",
   "version": "1",
   "metadata": {
      "closed": "2024-02-20T00:00:00"
   },
   "context": "Invoice",
   "data": {
      "statementId": 12345,
      "paymentType": "Cash",
      "program":{
          "id":1
      },
      "contract":{
        "number":"000091",
        "type":"Credit"
      },
      "holder": {
         "document": {
            "value": "47742663023",
            "type": "CPF"
         }
      },
      "payment": {
         "authenticationCode": "581828c6-d1da-42ea-ba55-77d59083239b",
         "digitableLine": "332900011514736489619164458789901239720000111115",
         "dueDate": "2022-05-01T00:00:00",
         "paymentOptionType": "Billet",
         "status": "Pending",
         "amount": {
            "value": 1111.15,
            "currency": "BRL",
          },
         "ourNumber": "18453385045"
      },
      "designatedFunding": "BV" 
   }
}

INVOICE_PAYMENT_PROCESSED

Este evento sinaliza que o pagamento da fatura do cartão foi processado.

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
`paymentDate`	`string`	Data de pagamento da fatura.	20
`amount`	`object`	Objeto que contém informações sobre o valor pago.	—
`amount.value`	`number`	Valor de pagamento.	decimal(18,2)
`amount.currency`	`string`	Código da moeda com base na ISO-4217.	3
`program`	`object`	Objeto que contém informação sobre o programa.	—
`program.id`	`integer`	Identificador único do programa.	—
`contract`	`object`	Objeto que contém informações sobre o contrato de crédito.	—
`contract.number`	`string`	Número do contrato de crédito.	10
`contract.type`	`string`	Tipo do contrato de crédito, o qual sempre será “Credit”.	6
`holder`	`object`	Objeto que contém informações do titular do cartão.	—
`holder.document`	`object`	Objeto que contém informações sobre o documento do titular.	—
`holder.document.value`	`string`	Número do documento.	50
`holder.document.type`	`string`	Tipo de documento, o qual pode ser “CPF ou “CNPJ”.	4
`paymentType`	`string`	Opção de pagamento, que pode ser: “Cash” (à vista), “Partial” (parcial), “InstallmentWithEntry” (parcelado com entrada), “InstallmentWithoutEntry” (parcelado sem entrada).	25
`ourNumber`	`string`	Identificador do boleto de pagamento.	40
`paymentOptionType`	`string`	Forma de pagamento. No caso de faturas de cartão, este campo virá preenchido com o valor “Billet” (Boleto).	6
`status`	`string`	Situação do pagamento, a qual pode ser: “Pending” (pendente), “Paid” (pago) ou “Expired” (expirado).	—
`statementId`	`number`	Identificador único da fatura.	—
`statementPaymentStatus`	`string`	Situação do pagamento da fatura, a qual pode ser: “Pending” (pendente), “Paid” (pago), “PartialPaid” (parcialmente pago) e “LatePaid“ (atrasado).	11
`statement`	`object`	Objeto que contém informações sobre a fatura do cartão.	—
`statement.id`	`integer`	Identificador único da fatura.	—
`statement.dueDate`	`string`	Data de vencimento da fatura.	25
`statement.paymentStatus`	`string`	Situação do pagamento da fatura, a qual pode ser: “Pending” (pendente), “Paid” (pago), “PartialPaid” (parcialmente pago) e “LatePaid“ (atrasado).	11
`statement.programId`	`integer`	Identificador único do programa.	—

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

{
      "name": "INVOICE_PAYMENT_PROCESSED",
      "entityId": "315",
      "idempotencyKey": "763cd6ed-f0c2-437e-896a-6b57lf3c690e",
      "companyKey": "COMPANY_KEY",
      "timestamp": "2022-04-19T11:23:02.2257857Z",
      "correlationId": "5873d178-797f-4176-902d-db6d6253d5p8",
      "version": "1",
      "metadata": {
         "StatementId": 12345
      },
      "context": "Invoice",
      "data": {
         "paymentDate": "2022-04-18T00:00:00+00:00",
         "amount": {
            "value": 61.52,
            "currency": "BRL"
         },
         "program":{
          	"id":1
         },
         "contract":{
           "number":"000091",
           "type":"Credit"
         },
         "holder": {
            "document": {
               "value": "47742663023",
               "type": "CPF"
            }
         },
         "paymentType": "Cash",
         "paymentOptionType": "Billet",
         "status": "Paid",
         "statementId": 48645,
         "statementPaymentStatus": "Paid",
         "statement":{
          	"dueDate": "2022-10-03T00:00:00",
            "id": 48645,
          	"paymentStatus": "Paid",
          	"programId": 556
         }
      }
   }

INVOICE_INSTALLMENT_PLAN_WAS_ACTIVATED

Este evento sinaliza a confirmação bem-sucedida de uma oferta de crédito para parcelamento na fatura.

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
`paymentDate`	`string`	Data de pagamento, no formato ISO 8601 - UTC.	25
`statement`	`object`	Objeto que contém informações sobre a fatura do cartão.	—
`statement.id`	`integer`	Identificador único da fatura parcelada.	10
`statement.dueDate`	`string`	Data de vencimento da fatura, no formato ISO 8601 - UTC.	25
`statement.paymentStatus`	`string`	Situação do pagamento da fatura, a qual pode ser “Pending” (pendente), “Paid” (paga) e “PartialPaid” (parcialmente paga).	40
`statement.cycleCloseDate`	`string`	Data de fechamento da fatura, no formato ISO 8601 - UTC.	25
`creditOffer`	`object`	Objeto que contém informações sobre a proposta de parcelamento da fatura.	—
`creditOffer.creditOfferId`	`integer`	Identificador único da proposta.	10
`creditOffer.amountCurrency`	`string`	Código da moeda de acordo com a ISO - 4217.	4
`creditOffer.amountDue`	`number`	Valor contratado da proposta mais o valor total de juros (pode ou não conter TAC).	decimal(18,4)
`creditOffer.annualCet`	`number`	CET (custo efetivo total) da contratação calculado ao ano.	decimal(18,4)
`creditOffer.annualInterestRate`	`number`	Taxa de juros anual da contratação.	decimal(18,4)
`creditOffer.cet`	`number`	CET (custo efetivo total) da contratação calculado na periodicidade definida das parcelas.	decimal(18,4)
`creditOffer.loanAmount`	`number`	Valor do crédito solicitado para contratação.	decimal(18,4)
`creditOffer.monthlyInterestRate`	`number`	Taxa de juros mensal da contratação.	decimal(18,4)
`creditOffer.periodicity`	`string`	Periodicidade do pagamento. Ex (monthly).	40
`creditOffer.term`	`integer`	Quantidade de parcelas da proposta.	2
`creditOffer.totalInterestAmount`	`number`	Valor total de juros a ser pago na contratação.	decimal(18,4)
`creditOffer.totalPaymentAmount`	`number`	Valor total a ser pago no final do contrato.	decimal(18,4)
`creditOffer.iofTotalAmount`	`number`	Valor final do cálculo do IOF.	decimal(18,4)
`creditOffer.downPayment`	`number`	Valor de entrada do pagamento.	decimal(18,4)
`creditOffer.diaryIof`	`number`	Percentual do IOF diário.	decimal(18,4)
`creditOffer.fixedIof`	`number`	Percentual do IOF fixo.	decimal(18,4)
`program`	`object`	Objeto que contém informações sobre o programa ao qual o cartão pertence.	—
`program.id`	`integer`	Identificador único do programa.	10
`contract`	`object`	Objeto que contém os dados do contrato de crédito.	—
`contract.number`	`string`	Valor do contrato de crédito.	10
`contract.type`	`string`	Tipo do contrato de crédito, o qual sempre será “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.	—
`holder.document.value`	`string`	Número do documento.	50
`holder.document.type`	`string`	Tipo de documento, o qual pode ser “CPF ou “CNPJ”.	4
`designatedFunding`	`string`	Financiadora do contrato de crédito.	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

[
{ 
  "name": "INVOICE_INSTALLMENT_PLAN_WAS_ACTIVATED", 
  "entityId": "30027", 
  "companyKey": "AUTOMATED_TESTS", 
  "timestamp": "2024-08-06T15:14:54.4263459Z", 
  "correlationId": "00000000-0000-0000-0000-000000000000", 
  "version": "1", 
  "metadata": { 
    "StatementId": 41914 
  }, 
  "context": "Invoice", 
  "data": {    
    "paymentDate": "2024-08-06T00:00:00Z", 
    "statement": { 
      "id": 41914, 
      "dueDate": "2024-08-01T00:00:00",      
      "paymentStatus": "Pending", 
      "cycleCloseDate": "2024-07-22T00:00:00" 
    }, 
    "creditOffer": { 
      "creditOfferId": 30027, 
      "amountCurrency": "BRL", 
      "amountDue": 605.26, 
      "annualCet": 72.6300, 
      "annualInterestRate": 213.8400, 
      "cet": 4.5900, 
      "loanAmount": 413.86, 
      "monthlyInterestRate": 0.1000, 
      "periodicity": "monthly", 
      "term": 7, 
      "totalInterestAmount": 185.18, 
      "totalPaymentAmount": 605.26, 
      "iofTotalAmount": 6.22, 
      "downPayment": 86.14, 
      "diaryIof": 0.0082, 
      "fixedIof": 0.3800 
    }, 
    "program": { 
      "id": 163 
    }, 
    "contract": { 
      "number": "851454", 
      "type": "Credit" 
    }, 
    "holder": { 
      "document": { 
        "value": "47742663023", 
        "type": "CPF" 
      } 
    }, 
    "designatedFunding": "BV" 
  }, 
  "licenseUuid": "24ac71da-4309-4348-9cc0-a0c88f867993" 
}
]

INVOICE_INSTALLMENT_PLAN_ACTIVATION_WAS_FAILED

Este evento sinaliza uma falha na confirmação da oferta de crédito para parcelamento da fatura.

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
`paymentDate`	`string`	Data de pagamento da fatura, no formato ISO 8601 - UTC.	25
`statement`	`object`	Objeto que contém informações sobre a fatura do cartão.	—
`statement.id`	`integer`	Identificador único da fatura.	10
`statement.dueDate`	`string`	Data de vencimento da fatura, no formato ISO 8601 - UTC.	25
`statement.paymentStatus`	`string`	Situação do pagamento da fatura, a qual pode ser “Pending” (pendente), “Paid” (paga) e “PartialPaid” (parcialmente paga).	40
`statement.cycleCloseDate`	`string`	Data de fechamento da fatura, no formato ISO 8601 - UTC.	25
`previousPaymentAmount`	`object`	Objeto que contém informações referente ao pagamento anterior.	—
`previousPaymentAmount.value`	`number`	Valor do pagamento anterior.	decimal(18,4)
`previousPaymentAmount.currency`	`string`	Código da moeda de acordo com a ISO - 4217.	4
`program`	`object`	Objeto que contém informações sobre o programa ao qual o cartão pertence.	—
`program.id`	`integer`	Identificador único do programa.	10
`contract`	`object`	Objeto que contém os dados do contrato de crédito.	—
`contract.number`	`string`	Valor do contrato de crédito.	10
`contract.type`	`string`	Tipo do contrato de crédito, o qual sempre será “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.	—
`holder.document.value`	`string`	Número do documento.	50
`holder.document.type`	`string`	Tipo de documento, o qual pode ser “CPF ou “CNPJ”.	4
`designatedFunding`	`string`	Financiadora do contrato de crédito.	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

[
{ 
	"name": "INVOICE_INSTALLMENT_PLAN_ACTIVATION_WAS_FAILED", 
	"entityId": "41914", 
	"companyKey": "AUTOMATED_TESTS", 
	"timestamp": "2024-08-06T15:29:28.4482717Z", 
	"correlationId": "00000000-0000-0000-0000-000000000000", 
	"version": "1", 
	"metadata": { 
		"StatementId": 41914 
	}, 
	"context": "Invoice", 
	"data": { 
		"paymentDate": "2024-08-06T00:00:00Z", 
		"statement": { 
			"id": 41914, 
			"dueDate": "2024-08-01T00:00:00", 
			"programId": 163, 
			"paymentStatus": "PartialPaid", 
			"cycleCloseDate": "2024-07-22T00:00:00" 
		}, 
		"previousPaymentAmount": { 
			"value": 86.14, 
			"currency": "BRL" 
		}, 
		"program": { 
			"id": 163 
		}, 
		"contract": { 
			"number": "851454", 
			"type": "Credit" 
		}, 
		"holder": { 
			"document": { 
				"value": "47742663023", 
				"type": "CPF" 
			} 
		}, 
		"designatedFunding": "BV" 
	}, 
	"licenseUuid": "24ac71da-4309-4348-9cc0-a0c88f867993" 
}
]

INVOICE_REFINANCING_RATES_WAS_UPDATED

Este evento sinaliza que as taxas de refinanciamento atreladas ao programa do contrato de crédito foram atualizadas.

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
`programId`	`integer`	Identificador único do programa.	—
`rotatingRate`	`object`	Objeto que contém informações referentes às taxas de rotativo.	—
`rotatingRate.monthlyInterestRate`	`number`	Taxa de juros mensal ao rotacionar a fatura.	decimal(18,2)
`rotatingRate.annualInterestRate`	`number`	Taxa de juros anual ao rotacionar a fatura.	decimal(18,2)
`rotatingRate.monthlyCet`	`number`	Taxa de custo efetivo total mensal ao rotacionar a fatura.	decimal(18,2)
`rotatingRate. annualCet`	`number`	Taxa de custo efetivo total anual ao rotacionar a fatura.	decimal(18,2)
`refinancingRate`	`object`	Objeto que contém informações referentes às taxas de refinanciamento.	—
`refinancingRate.monthlyInterestRate`	`number`	Taxa de juros mensal ao refinanciar a fatura.	decimal(18,2)
`refinancingRate.annualInterestRate`	`number`	Taxa de juros anual ao refinanciar a fatura.	decimal(18,2)
`refinancingRate.monthlyCet`	`number`	Taxa de custo efetivo total mensal ao refinanciar a fatura.	decimal(18,2)
`refinancingRate. annualCet`	`number`	Taxa de custo efetivo total anual ao refinanciar a fatura.	decimal(18,2)
`diaryIof`	`number`	Taxa de IOF diário.	decimal(18,2)
`fixedIof`	`number`	Taxa de IOF fixo.	decimal(18,2)
`internationalIof`	`number`	Taxa de IOF internacional.	decimal(18,2)

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

[
  {
    "name": "INVOICE_REFINANCING_RATES_WAS_UPDATED",
    "entityId": "117",
    "idempotencyKey": "a1b2c3d4-5678-9101-1121-314151617181",
    "companyKey": "BANCO_DIGITAL_BCO_BV",
    "timestamp": "2024-09-03T12:00:00Z",
    "correlationId": "a1b2c3d4-5678-9101-1121-314151617181",
    "version": "1",
    "metadata": {
      "updated": "2024-09-03T00:00:00"
    },
    "context": "Invoice",
    "data": {
      "programId": 117,
      "rotatingRate": {
        "monthlyInterestRate": 2.0,
        "annualInterestRate": 12.0,
        "monthlyCet": 0,
        "annualCet": 2.5
      },
      "refinancingRate": {
        "monthlyInterestRate": 2.0,
        "annualInterestRate": 12.0,
        "monthlyCet": 0,
        "annualCet": 2.5
      },
      "diaryIof": 0.0082,
      "fixedIof": 0.38,
      "internationalIof": 4.38
    }
  }
]

Tabelas para consulta

Tipos de transações

Código	Descrição
REFINANCE_CHARGES	Encargos de refinanciamento
INTEREST_ON_ARREST	Juros de mora
TRAFFIC_TICKET	Multa
PURCHASE_BY_SIGHT	Compra à vista
INSTALLMENT_WITHOUT_INTEREST	Parcela sem juros
DEBIT_ADJUSTMENT	Ajuste a débito
INSTALLMENTS_WITHOUT_INTEREST	Parcelado sem juros
INSTALLED_WITH_INTEREST	Parcelado com juros
PAYMENT	Pagamento
CREDIT_ADJUSTMENT	Ajuste a crédito
PARTIAL_CANCELLATION_OF_PURCHASE	Cancelamento parcial de compra
WITHDRAW	Saque
INTERNATIONAL_PURCHASE	Compra internacional
INTERNATIONAL_IOF	IOF internacional
IOF	IOF
IOF_WITHDRAWAL	IOF de saque
WITHDRAWAL_CHARGES	Encargos de saque
ANNUITY	Anuidade
WITHDRAWAL_RATE	Tarifa de saque
RATE_CARD_ISSUANCE	Tarifa de emissão cartão
REFINANCE_INSTALLMENT	Parcela de refinanciamento
CANC_CREDIT_INSTALLMENTS	Cancelamento de crédito parcelado
PREPAID_CHARGE	Carga de pré-pago
MEMBERSHIP_PAYMENT	Pagamento de adesão
PURCHASE_CANCELLATION	Cancelamento de compra
CANC_INSTALLMENT_WITHOUT_INTEREST	Cancelamento de parcela sem juros
ANNUAL_REVERSAL	Estorno anuidade
CREDIT_BY_INSTALLMENT	Crédito por parcelamento
REFINANCE_CONTRACT	Contrato de refinanciamento
CANC_PARC_DE_REF	Cancelamento de parcela de refinanciamento
EXCHANGE_DIF_DEBIT	Débito de diferença cambial
DIF_EXCHANGE_CREDIT	Crédito de diferença cambial
REVERSAL_REFINING_CHARGES	Estorno de encargos de refinanciamento
REVERSAL_INTEREST	Estorno de juros de mora
FINE_REVERSAL	Estorno de multa
REVERSAL_IOF	Estorno de IOF
CANCELLATION_AGREEMENT_REFINANC	Cancelamento de contrato de refinanciamento
CREDIT_BY_AGREEMENT	Crédito por acordo
INSTALLMENT_OF_AGREEMENT	Parcela de acordo
AGREEMENT_CONTRACT	Contrato de acordo
CANCELLATION_OF_INSTALLMENT_AGREEMENT	Cancelamento da parcela de acordo
CANC_CREDIT_AGREEMENT	Cancelamento de crédito de acordo
CANCELLATION_CONTRACT_AGREEMENT	Cancelamento de contrato de acordo
CREDIT_BY_INSTALLMENT_CP	Crédito por parcelamento compulsório
CP_REFINANCING_INSTALLMENT	Parcela de refinanciamento compulsório
CP_REFINANCE_CONTRACT	Contrato de refinanciamento compulsório
CANC_PARC_DE_REF_CP	Cancelamento de parcelamento de refinanciamento compulsório
CANC_CREDIT_INSTALLMENT_CP	Cancelamento de crédito de parcelamento compulsório
CANCELLATION_CONTRACT_REF_CP	Cancelamento de contrato de refinanciamento compulsório
DEBIT_PAYMENT	Pagamento com débito
CREDIT_VOUCHER	Voucher de crédito
CANC_INSTALLMENTS_WITHOUT_INTEREST	Cancelamento de parcelado sem juros
CANC_IN_INSTALLMENTS_WITH_INTEREST	Cancelamento de parcelado com juros
CANC_INSTALLMENT_WITH_INTEREST	Cancelamento de parcela com juros
CANC_INTERNATIONAL_PURCHASE	Cancelamento de compra internacional
CANC_IOF_INTERNATIONAL	Cancelamento de IOF internacional
REVERSAL_INTERNATIONAL_WITHDRAWAL	Estorno de saque internacional
REVERSAL_DEBIT_PAYMENT	Estorno de débito pagamento
REVERSED_WITHDRAWAL	Estorno de saque
REVERSAL_RATE_WITHOUT_WITHDRAWAL	Estorno de tarifa de saque internacional
INTERNATIONAL_WITHDRAWAL	Saque internacional
FLAG_PAYMENT	Pagamento da bandeira
TED_CASH_OUT	TED cash-out
TEF_CASH_OUT	TEF cash-out
TED_CASH_IN	TED cash-in
DEBIT_REVERSAL	Reversão de débito
REVERSAL_PAYMENT	Estorno de pagamento de adesão
REVERSED_WITHDRAWAL_CHARGES	Estorno de encargos de saque
PRE_PAID_RECHARGE_RATE	Tarifa de recarga de pré-pago
PREPAID_RECHARGE_PERCENTAGE	Percentual de recarga de pré-pago
MDR	MDR
REVERSAL_RATE_WITHDRAWAL	Estorno de tarifa de saque
REVERSAL_IOF_WITHDRAWAL	Estorno de IOF de saque

Código do modo de entrada (`entryMode`)

Código	Descrição
00	Modo de entrada do PAN desconhecido.
01	Entrada do PAN manual.
02	Entrada automática do PAN via leitura da tarja magnética. Para transações Plus, este código também significa que o conteúdo exato da faixa 2 está incluído e a verificação de CVV é possível.
03	Entrada automática via leitor de código de barras.
04	Entrada automática de PAN via leitor óptico de caracteres (OCR).
05	Entrada automática de PAN via chip.
06	Contactless obsoleto.
07	Entrada automática de PAN via M/Chip sem contato.
08	Contactless MChip obsoleto.
09	Entrada de PAN/Token via comércio eletrônico contendo criptograma DSRP em DE 55 (Integrated Circuit Card [ICC] System-Related Data).
10	Credencial em arquivo.
79	Um terminal híbrido com conexão online com o adquirente falhou no envio de uma transação de chip fallback (em que DE 22, subcampo 1 = 80) ao emissor.
80	O cartão com chip não foi capaz de processar/leitura da tarja magnética padrão.
81	Entrada de PAN/Token via comércio eletrônico com opcional Identity Check-AAV ou criptograma DSRP em UCAF.
82	Entrada automática de PAN via servidor (sistema emissor, adquirente ou fornecedor terceirizado).
90	A tarja magnética lê e extrai o conteúdo da Faixa 1 ou Faixa 2 incluída (a verificação CVV é possível).
91	Entrada automática do número da conta via tarja magnética sem contato.
95	Apenas Visa – Chip com CVV não confiável.

Tipos de taxa

Tipo	Descrição
NotMapper	Não informado.
IOF	Imposto de Operações Financeiras fixo da transação.
Markup	Taxa de conversão para proteção de mudanças de câmbio.
DailyIOF	IOF diário em cima da fatura.
Interest	Juros de transação cobrado pelo emissor.

Pré-requisitos

📘Nota

Informações sobre os eventos

Contexto e nome do evento

Fluxo dos eventos

📘Nota

📘Nota

Identificador (entityId)

Dados dos eventos

TRANSACTION_CREATED

Descrição do objeto data do evento

ℹ️Nota

Payload do evento

TRANSACTION_UPDATED

Descrição do objeto data do evento

Payload do evento

INSTALLMENTS_PLAN_WAS_CREATED

Descrição do objeto data do evento

Payload do evento

INVOICE_CLOSED

Descrição do objeto data do evento

Payloads do evento

INVOICE_SUMMARY_WAS_CREATED

Descrição do objeto data do evento

Payload do evento

INVOICE_TRANSACTIONS_SUMMARY_WAS_CREATED

Descrição do objeto data do evento

Payload do evento

INVOICE_CLOSED_TRANSACTION_DETAILS_WAS_CREATED

Descrição do objeto data do evento

Payload do evento

CONTRACTED_INSTALLMENT_PLANS

Descrição do objeto data do evento

Payload do evento

INVOICE_CLOSED_WAS_FINISHED

Descrição do objeto data do evento

Payload do evento

INVOICE_PAYMENT_OPTION_CREATED

Descrição do objeto data do evento

Payload do evento

INVOICE_PAYMENT_PROCESSED

Descrição do objeto data do evento

Payload do evento

INVOICE_INSTALLMENT_PLAN_WAS_ACTIVATED

Descrição do objeto data do evento

Payload do evento

INVOICE_INSTALLMENT_PLAN_ACTIVATION_WAS_FAILED

Descrição do objeto data do evento

Payload do evento

INVOICE_REFINANCING_RATES_WAS_UPDATED

Descrição do objeto data do evento

Payload do evento

Tabelas para consulta

Tipos de transações

Código do modo de entrada (entryMode)

Tipos de taxa

📘
Nota

📘
Nota

📘
Nota

Identificador (`entityId`)

Descrição do objeto `data` do evento

ℹ️
Nota

Descrição do objeto `data` do evento

Descrição do objeto `data` do evento

Descrição do objeto `data` do evento

Descrição do objeto `data` do evento

Descrição do objeto `data` do evento

Descrição do objeto `data` do evento

Descrição do objeto `data` do evento

Descrição do objeto `data` do evento

Descrição do objeto `data` do evento

Descrição do objeto `data` do evento

Descrição do objeto `data` do evento

Descrição do objeto `data` do evento

Descrição do objeto `data` do evento

Código do modo de entrada (`entryMode`)