Fatura (Invoice)

stable

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.;
  • A fatura do cartão é processada;
  • A fatura é fechada;
  • O pagamento total ou proporcional da fatura é realizado.

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á:

Informações sobre os eventos

Contexto e nome do evento

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

contextnameDescrição
InvoiceTRANSACTION_CREATEDTransação criada.
InvoiceTRANSACTION_UPDATEDItem de fatura atualizado.
InvoiceINVOICE_CLOSEDFatura do cartão fechada. 
InvoiceINVOICE_PAYMENT_OPTION_CREATEDOpção de pagamento de fatura criada.
InvoiceINVOICE_PAYMENT_PROCESSED Pagamento proporcional da fatura do cartão processado. 

Fluxo dos eventos

O fluxograma a seguir descreve a sequência em que os eventos ocorrem. Clique na imagem para ampliá-la:

📘

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).

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:

EventoIdentificador (entityId )Descrição
TRANSACTION_CREATEDstatementItemIdIdentificador único do item de fatura.
TRANSACTION_UPDATEDstatementIdIdentificador único da fatura.
INVOICE_CLOSEDstatementIdIdentificador único da fatura.
INVOICE_PAYMENT_OPTION_CREATEDstatementIdIdentificador único da fatura.
INVOICE_PAYMENT_PROCESSEDpaymentIdIdentificador único do pagamento.

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:

NomeTipoDescriçãoNúmero máximo de caracteres
statementobjectObjeto que contém informações sobre a fatura.
statement.idintegerIdentificador único da fatura.
statement.dueDatestringData de vencimento da fatura.25
statement.cycleCloseDatestringData de fechamento da fatura, no formato 8601 - UTC.25
statement.programIdintegerIdentificador único do programa.
programobjectObjeto que contém informações sobre o programa ao qual o cartão pertence.
program.idintegerIdentificador único do programa.
contractobjectObjeto que contém informações sobre o contrato de crédito.
contract.numberstringNúmero do contrato de crédito.10
contract.typestringTipo do contrato de crédito, o qual sempre será “Credit”.6
holderobjectObjeto que contém informações sobre o titular do cartão.
holder.documentobjectObjeto que contém informações sobre o documento do titular.
holder.document.typestringTipo de documento do titular, que pode ser “CPF” ou “CNPJ”.4
holder.document.valuestringNúmero do documento.50
isCreditbooleanIndica o tipo de operação, sendo TRUE para crédito e FALSE para débito.
statementPostbooleanIndica se é um item exibido na fatura, sendo TRUE para exibido e FALSE para oculto.
statementNumberintegerNúmero da parcela.
statementTotalintegerNúmero total de parcelas.
transactionDatestringData em que ocorreu a transação, no formato ISO 8601 - UTC.
authorizationIdstringIdentificador da transação gerado pela processadora.20
authorizationTrackingIdstringIdentificador de rastreamento da transação (crédito ou débito).75
transactionTypeIdintegerIdentificador do tipo da transação.
transactionTypestringTipo de transação. Consulte a tabela dos possíveis tipos de transação no final da página.100
transactionDescriptionstringDescritivo do item da fatura.150
exchangefeeobjectObjeto que contém informações sobre a taxa de conversão utilizada em transações internacionais.
exchangefee.valuenumberValor da taxa.decimal(18,4)
exchangefee.currencystringCódigo da moeda com base na ISO-4217.3
amounts[]array of objectsLista de objetos contendo informações sobre o total da transação.
amounts[].valuenumberValor do item da fatura.decimal(18,2)
amounts[].currencystringCódigo da moeda com base na ISO-4217.3
amounts[].amountTypestringIndicador do tipo do item de fatura, 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 objectsLista de objetos contendo informações sobre as taxas aplicadas na transação.
fees[].feeTypestringTipo da taxa, o qual pode ser: “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) e “Interest” (juros de transação cobrado pelo emissor).10
fees[].feeAmountobjectObjeto que contém informações sobre o valor das taxas aplicadas na transação.
fees[].feeAmount.valuenumberValor da taxa.decimal(18,2)
fees[].feeAmount.currencystringCódigo da moeda com base na ISO-4217.3
transactionobjectObjeto que contém informações referentes a uma transação bandeirada (compra ou saque).
transaction.cardobjectObjeto que contém informações sobre o cartão utilizado na transação.
transaction.card.proxystringCódigo identificador do cartão.30
transaction.card.lastFourDigitsstringQuatro últimos dígitos do cartão.4
transaction.card.cardNamestringNome gravado no cartão.20
transaction.card.cardTypestringTipo do cartão, o qual pode ser “Physical” ou “Virtual”.10
transaction.card.aliasstringApelido definido pelo proprietário do cartão.20
transaction.transactionAuthorizerIdstringIdentificador da transação gerado pela processadora.20
transaction.authorizationCodestringIdentificador da transação na rede de cartões.20
transaction.nsustringNúmero sequencial único que é gerado na venda.20
transaction.retrievalReferenceNumberstringIdentificador de transação da rede do cartão.20
transaction.mccstringCódigo MCC da transação.10
transaction.mcgstringDescrição do tipo mcc.20
transaction.merchantstringNome do estabelecimento que aceitou a transação.100
transaction.entryModestringCódigo que identifica o tipo da transação.10
documentNumberobjectObjeto que contém informações sobre o documento do titular do cartão.
documentNumber.valuestringNúmero do documento.50
documentNumber.typestringTipo 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,
      "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"
      },
      "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,
      "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",
      "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,
      "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:

NomeTipoDescriçãoNúmero máximo de caracteres
statementobjectObjeto que contém informações sobre a fatura.
statement.idintegerIdentificador único da fatura.
statement.dueDatestringData de vencimento da fatura, no formato ISO 8601 - UTC.
programobjectObjeto que contém informações sobre o programa ao qual o cartão pertence.
program.idintegerIdentificador único do programa.
contractobjectObjeto que contém informações sobre o contrato de crédito.
contract.numberstringNúmero do contrato de crédito.10
contract.typestringTipo do contrato de crédito, o qual sempre será “Credit”.6
holderobjectObjeto que contém informações sobre o titular do cartão.
holder.documentobjectObjeto que contém informações sobre o documento do titular.
holder.document.typestringTipo de documento do titular, que pode ser “CPF” ou “CNPJ”.4
holder.document.valuestringNúmero do documento.50
isCreditbooleanIndica o tipo de operação, sendo TRUE para crédito e FALSE para débito.
statementPostbooleanIndica se é um item exibido na fatura, sendo TRUE para exibido e FALSE para oculto.
statementNumberintegerNúmero da parcela.
statementTotalintegerNúmero total de parcelas.
transactionDatestringData em que ocorreu a transação, no formato ISO 8601 - UTC.
authorizationIdstringIdentificador da transação gerado pela processadora.20
transactionTypeIdintegerIdentificador do tipo da transação.
transactionTypestringTipo de transação. Consulte a tabela dos possíveis tipos de transação no final da página.100
transactionDescriptionstringDescritivo do item da fatura.150
exchangeFeeobjectObjeto que contém informações sobre a taxa de conversão utilizada em transações internacionais.
exchangefee.valuenumberValor da taxa.decimal(18,4)
exchangefee.currencystringCódigo da moeda com base na ISO-4217.3
amount[]array of objectsLista de objetos contendo informações sobre o total da transação.
amount[].valuenumberValor do item da fatura.decimal(18,2)
amount[].currencystringCódigo da moeda com base na ISO-4217.3
amount[].amountTypestringIndicador 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 objectsLista de objetos contendo informações sobre as taxas aplicadas na transação.
fees[].feeTypestringTipo da taxa, o qual pode ser: “NotMapper”, “IOF”, “Markup”, “DailyIOF” ou “Interest”.10
fees[].feeAmountobjectObjeto que contém informações sobre o valor das taxas aplicadas à transação.
fees[].feeAmount. valuenumberValor da taxa.decimal(18,2)
fees[].feeAmount.currencystringCódigo da moeda com base na ISO-4217.3
transactionobjectObjeto que contém informações referentes a uma transação bandeirada (compra ou saque).
transaction.cardobjectObjeto que contém informações sobre o cartão utilizado na transação.
transaction.card.proxystringCódigo identificador do cartão.30
transaction.card.lastFourDigitsstringQuatro últimos dígitos do cartão.4
transaction.card.cardNamestringNome gravado no cartão.20
transaction.card.cardTypestringTipo do cartão, o qual pode ser “Physical” ou “Virtual”.10
transaction.card.aliasstringApelido definido pelo proprietário do cartão.20
transaction.transactionAuthorizerIdstringIdentificador da transação gerado pela processadora.20
transaction.authorizationCodestringIdentificador da transação na rede de cartões.
transaction.nsustringNúmero sequencial único que é gerado na venda.20
retrievalReferenceNumberstringIdentificador de transação da rede do cartão.20
transaction.mccstringCódigo MCC da transação.10
transaction.mcgstringDescrição do tipo mcc.20
transaction.merchantstringNome do estabelecimento que aceitou a transação.100
transaction.entryModestringCódigo que identifica o tipo da transação.10
transaction.documentNumberobjectObjeto que contém informações sobre o documento do titular do cartão.
transaction.documentNumber.valuestringNúmero do documento.50
transaction.documentNumber.typestringTipo de documento do titular, que pode ser “CPF” ou “CNPJ”.4

Payload do evento

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": "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": {
		"update": "2022-04-24T22:37:09Z"
	},
	"context": "Invoice",
	"data": {
		"statement": {
			"id": 1,
			"dueDate": "2023-01-01T00:00:00",
		},
    "program":{
      "id":1
    },
    "contract":{
      "number":"000091",
      "type":"Credit"
    },
    "holder":{
      "document":{
        "type":"CPF",
        "value":"86187018150"
      }
    },
		"isCredit": true,
		"statementPost": true,
		"statementNumber": 1,
		"statementTotal": 100.0,
		"transactionDate": "2023-01-01T00:00:00",
		"authorizationId": "auth-id-123",
		"transactionTypeId": 1,
		"transactionType": "Transaction Type",
		"transactionDescription": "Description of the transaction",
		"exchangeFee": {
			"value": 10.0,
			"currency": "USD"
		},
		"amounts": [
			{
				"value": 50.0,
				"currency": "USD",
				"amountType": "Debit"
			}
		],
		"fees": [
			{
				"feeType": "Service Fee",
				"feeAmount": {
					"value": 5.0,
					"currency": "USD"
				}
			}
		],
		"transaction": {
			"card": {
				"proxy": "proxy-123",
				"lastFourDigits": "1234",
				"cardName": "John Doe",
				"cardType": "Credit",
				"alias": "Card Alias"
			},
			"transactionAuthorizerId": "auth-123",
			"authorizationCode": "code123",
			"nsu": "nsu-123",
			"retrievalReferenceNumber": "ref123",
			"mcg": "mcg-123",
			"merchant": "Merchant Name",
			"mcc": "1234",
			"entrymode": "Mode123",
			"documentNumber": {
				"value": "doc-123",
				"type": "Document Type"
			}
		}
	}
 }

INVOICE_CLOSED

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

Descrição do objeto data do evento

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

NomeTipoDescriçãoNúmero máximo de caracteres
statementIdintegerIdentificador único da fatura.—-
monthintegerRepresenta o mês de vencimento da fatura.—-
yearintegerRepresenta o ano de vencimento da fatura.—-
cycleintegerIndicador do ciclo da fatura.—-
cycleCloseDatestringData de fechamento da fatura, no formato ISO 8601 - UTC.25
dueDatestringData de vencimento da fatura, no formato ISO 8601 - UTC.25
balanceobjectObjeto que contém informações referentes ao valor total da fatura.—-
balance.valuenumberValor total da fatura.Decimal (18,2)
balance.currencystringCódigo da moeda com base na ISO-4217.3
amountMinimalobjectObjeto que contém informações sobre o valor de pagamento mínimo da fatura.—-
amountMinimal.valuenumberValor de pagamento mínimo da fatura.Decimal (18,2)
amountMinimal.currencystringCódigo da moeda com base na ISO-4217.3
summaryobjectObjeto que contém informações resumidas da fatura.—-
summary.outstandingBalanceobjectObjeto que contém o saldo residual devedor da fatura anterior.—-
summary.outstandingBalance.valuenumberValor total do saldo residual.Decimal (18,2)
summary.outstandingBalance.currencystringCódigo da moeda com base na ISO-4217.3
summary.estimatedChargesobjectObjeto que contém o valor estimado dos encargos, caso a fatura seja rotativada.—-
summary.estimatedCharges.iofobjectObjeto que contém o valor estimado do IOF, caso a fatura seja rotativada.—-
summary.estimatedCharges.iof.valuenumberValor total estimado do IOF.Decimal (18,2)
summary.estimatedCharges.iof.currencystringCódigo da moeda com base na ISO-4217.3
summary.estimatedCharges.refinanceobjectObjeto que contém o valor que será refinanciado, caso a fatura seja rotativada.—-
summary.estimatedCharges.refinance.valuenumberValor total a ser refinanciado.Decimal (18,2)
summary.estimatedCharges.refinance.currencystringCódigo da moeda com base na ISO-4217.3
summary.estimatedCharges.interestobjectObjeto que contém o valor estimado do encargo de refinanciamento caso a fatura seja rotativada.—-
summary.estimatedCharges.interest.valuenumberValor total estimado dos encargos de refinanciamento.Decimal (18,2)
summary.estimatedCharges.interest.currencystringCódigo da moeda com base na ISO-4217.3
summary.estimatedCharges.trafficobjectObjeto que contém o valor estimado da multa, caso a fatura seja rotativada.—-
summary.estimatedCharges.traffic.valuenumberValor total estimado da multa.Decimal (18,2)
summary.estimatedCharges.traffic.currencystringCódigo da moeda com base na ISO-4217.3
summary.estimatedCharges.annualCetnumberPercentual anual do custo efetivo total da operação de rotativo.Decimal (18,2)
summary.estimatedCharges. monthlyCetnumberPercentual mensal do custo efetivo total da operação de rotativo.Decimal (18,2)
summary.installmentSummaryobjectObjeto que contém o resumo dos itens parcelados a vencer.Decimal (18,2)
summary.installmentSummary.interestFreeobjectObjeto que contém a soma dos itens de parcela sem juros a vencer.
summary.installmentSummary.interestFree.valuenumberValor total dos itens parcelados sem juros a vencer.Decimal (18,2)
summary.installmentSummary.interestFree.currencystringCódigo da moeda com base na ISO-4217.3
summary.installmentSummary.interestobjectObjeto que contém a soma dos itens de parcela com juros a vencer, com desconto dos encargos futuros.—-
summary.installmentSummary.interest.valuenumberValor total dos itens parcelados com juros a vencer, com desconto dos encargos futuros.Decimal (18,2)
summary.installmentSummary.interest.currencystringCódigo da moeda com base na ISO-4217.3
summary.amountMinimalCompositionobjectObjeto que contém os valores que compõem o valor de pagamento mínimo da fatura.—-
summary.amountMinimalComposition.outstandingBalanceobjectObjeto que contém o saldo residual devedor da fatura anterior.—-
summary.amountMinimalComposition.outstandingBalance.valuenumberValor total do saldo residual.Decimal (18,2)
summary.amountMinimalComposition.outstandingBalance.currencystringCódigo da moeda com base na ISO-4217.3
summary.amountMinimalComposition.feesobjectObjeto que contém a soma dos valores de transações de encargos lançados na fatura.—-
summary.amountMinimalComposition.fees.valuenumberValor total dos itens de encargos lançados em fatura.Decimal (18,2)
summary.amountMinimalComposition.fees.currencystringCódigo da moeda com base na ISO-4217.3
summary.amountMinimalComposition.refinanceobjectObjeto que contém a soma dos valores de transações de refinanciamento de fatura lançados na fatura.—-
summary.amountMinimalComposition.refinance.valuenumberValor total dos itens de refinanciamento de fatura lançados em fatura.Decimal (18,2)
summary.amountMinimalComposition.refinance.currencystringCódigo da moeda com base na ISO-4217.3
summary.amountMinimalComposition.transactionsobjectObjeto que contém a soma dos valores das transações de débito lançados em fatura.—-
summary.amountMinimalComposition.transactions.valuenumberValor total das transações de débitos lançadas em fatura.Decimal (18,2)
summary.amountMinimalComposition.transactions.currencystringCódigo da moeda com base na ISO-4217.3
paymentOptions[]array of objectsLista de objetos que contém informações referentes aos tipos de pagamento disponíveis.—-
paymentOptions[].paymentOptionIdintegerIdentificador único da opção de pagamento.—-
paymentOptions[].paymentTypestringOpção de pagamento, que pode ser “Cash” (à vista), ou “Partial” (parcial).25
paymentOptions[].amountobjectObjeto que contém informações sobre o valor a ser pago.—-
paymentOptions[].amount.valuenumberValor de pagamento.Decimal (18,2)
paymentOptions[].amount.currencystringCódigo da moeda com base na ISO-4217.3
programobjectObjeto que contém informação sobre o ID do programa referente ao cartão do cliente.—-
program.idintegerIdentificador único do programa.—-
contractobjectObjeto que contém os dados do contrato de crédito.—-
contract.numberstringValor do contrato de crédito.10
contract.typestringTipo do contrato de crédito tendo como valor padrão: “Credit”.6
holderobjectObjeto que contém informações sobre o titular do cartão.—-
holder.documentobjectObjeto que contém informações sobre o documento do titular do cartão.
holder.document.valuestringNúmero do documento.50
holder.document.typestringTipo de documento, o qual pode ser “CPF ou “CNPJ”.4
designatedFundingstringFinanciadora do contrato.100

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", 
    "version": "1", 
    "metadata": { 
        "closed": "2021-12-06T00: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" 
        }, 
        "summary": { 
            "outstandingBalance": { 
                "value": 107.35, 
                "currency": "BRL" 
            }, 
            "estimatedCharges": { 
                "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" 
                } 
            }, 
            "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" 
                } 
            } 
        }, 
        "program": { 
            "id": 117 
        }, 
        "contract": { 
            "number": "002111", 
            "type": "Credit" 
        }, 
        "holder": { 
            "document": { 
                "value": "14952781747", 
                "type": "CPF" 
            } 
        }, 
        "designatedFunding": "BV" 
    } 
  } 
]
[
  { 
  "name": "INVOICE_CLOSED", 
  "entityId": "1982831", 
  "idempotencyKey": "47c32bda-4cde-49d6-b50b-c0c29fc7744e",  
  "timestamp": "2024-02-27T15:17:28.0863407Z", 
  "correlationId": "47c32bda-4cde-49d6-b50b-c0c29fc7744e", 
  "version": 1, 
  "metadata": { 
    "closed": "2024-02-13T00: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" 
        } 
      }, 
      "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" 
        } 
      } 
    }, 
    "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": "14952781747", 
        "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:

NomeTipoDescriçãoNúmero máximo de caracteres
statementIdnumberIdentificador único da fatura.
paymentTypestringOpção de pagamento, que pode ser: “Cash” (à vista), “Partial” (parcial), “InstallmentWithEntry” (parcelado com entrada), “InstallmentWithoutEntry” (parcelado sem entrada).25
programobjectObjeto que contém informação sobre o programa.
program.idintegerIdentificador único do programa.
contractobjectObjeto que contém informações sobre o contrato de crédito.
contract.numberstringNúmero do contrato de crédito.10
contract.typestringTipo do contrato de crédito, o qual sempre será “Credit”.6
holderobjectObjeto que contém informações do titular do cartão.
holder.documentobjectObjeto que contém informações sobre o documento do titular do cartão.
holder.document.valuestringNúmero do documento.50
holder.document.typestringTipo de documento, o qual pode ser “CPF ou “CNPJ”.4
paymentobjectObjeto que contém informações sobre o pagamento.
payment.authenticationCodestringIdentificador da forma de pagamento.40
payment.digitableLinestringLinha digitável do boleto de pagamento.50
payment.dueDatestringData de vencimento do pagamento.25
payment.paymentOptionTypestringForma de pagamento. No caso de faturas de cartão, este campo virá preenchido com o valor “Billet” (Boleto).6
payment.statusstringSituação da forma de pagamento, que pode ser: “Pending” (pendente), “Paid” (pago) ou “Expired” (expirado).7
payment.amountobjectObjeto que contém informações sobre o valor pago.
payment.amount.valuenumberValor de pagamento.decimal(18,2)
payment.amount.currencystringCódigo da moeda com base na ISO-4217.3
payment.ourNumberstringIdentificador do boleto de pagamento.40
designatedFundingstringFinanciadora do contrato.100

Payload do evento

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

Exemplo de payload
{
   "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": "2022-05-02T00: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:

NomeTipoDescriçãoNúmero máximo de caracteres
paymentDatestringData de pagamento da fatura.20
amountobjectObjeto que contém informações sobre o valor pago.
amount.valuenumberValor de pagamento.decimal(18,2)
amount.currencystringCódigo da moeda com base na ISO-4217.3
programobjectObjeto que contém informação sobre o programa.
program.idintegerIdentificador único do programa.
contractobjectObjeto que contém informações sobre o contrato de crédito.
contract.numberstringNúmero do contrato de crédito.10
contract.typestringTipo do contrato de crédito, o qual sempre será “Credit”.6
holderobjectObjeto que contém informações do titular do cartão.
holder.documentobjectObjeto que contém informações sobre o documento do titular do cartão.
holder.document.valuestringNúmero do documento.50
holder.document.typestringTipo de documento, o qual pode ser “CPF ou “CNPJ”.4
paymentTypestringOpção de pagamento, que pode ser: “Cash” (à vista), “Partial” (parcial), “InstallmentWithEntry” (parcelado com entrada), “InstallmentWithoutEntry” (parcelado sem entrada).25
ourNumberstringIdentificador do boleto de pagamento.40
paymentOptionTypestringForma de pagamento. No caso de faturas de cartão, este campo virá preenchido com o valor “Billet” (Boleto).6
statusstringSituação do pagamento, a qual pode ser: “Pending” (pendente), “Paid” (pago) ou “Expired” (expirado).
statementIdnumberIdentificador único da fatura.
statementPaymentStatusstringSituação do pagamento da fatura, a qual pode ser: “Pending” (pendente), “Paid” (pago), “PartialPaid” (parcialmente pago) e “LatePaid“ (atrasado).11
statementobjectObjeto que contém informações sobre a fatura do cartão.
statement.idintegerIdentificador único da fatura.
statement.dueDatestringData de vencimento da fatura.25
statement.paymentStatusstringSituação do pagamento da fatura, a qual pode ser: “Pending” (pendente), “Paid” (pago), “PartialPaid” (parcialmente pago) e “LatePaid“ (atrasado).11
statement.programIdintegerIdentificador ú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
         }
      }
   }

Tabela para consulta

Tipos de transações

CódigoDescrição
REFINANCE_CHARGESEncargos de refinanciamento
INTEREST_ON_ARRESTJuros de mora
TRAFFIC_TICKETMulta
PURCHASE_BY_SIGHTCompra à vista
INSTALLMENT_WITHOUT_INTERESTParcela sem juros
DEBIT_ADJUSTMENTAjuste a débito
INSTALLMENTS_WITHOUT_INTERESTParcelado sem juros
INSTALLED_WITH_INTERESTParcelado com juros
PAYMENTPagamento
CREDIT_ADJUSTMENTAjuste a crédito
PARTIAL_CANCELLATION_OF_PURCHASECancelamento parcial de compra
WITHDRAWSaque
INTERNATIONAL_PURCHASECompra internacional
INTERNATIONAL_IOFIOF internacional
IOFIOF
IOF_WITHDRAWALIOF de saque
WITHDRAWAL_CHARGESEncargos de saque
ANNUITYAnuidade
WITHDRAWAL_RATETarifa de saque
RATE_CARD_ISSUANCETarifa de emissão cartão
REFINANCE_INSTALLMENTParcela de refinanciamento
CANC_CREDIT_INSTALLMENTSCancelamento de crédito parcelado
PREPAID_CHARGECarga de pré-pago
MEMBERSHIP_PAYMENTPagamento de adesão
PURCHASE_CANCELLATIONCancelamento de compra
CANC_INSTALLMENT_WITHOUT_INTERESTCancelamento de parcela sem juros
ANNUAL_REVERSALEstorno anuidade
CREDIT_BY_INSTALLMENTCrédito por parcelamento
REFINANCE_CONTRACTContrato de refinanciamento
CANC_PARC_DE_REFCancelamento de parcela de refinanciamento
EXCHANGE_DIF_DEBITDébito de diferença cambial
DIF_EXCHANGE_CREDITCrédito de diferença cambial
REVERSAL_REFINING_CHARGESEstorno de encargos de refinanciamento
REVERSAL_INTERESTEstorno de juros de mora
FINE_REVERSALEstorno de multa
REVERSAL_IOFEstorno de IOF
CANCELLATION_AGREEMENT_REFINANCCancelamento de contrato de refinanciamento
CREDIT_BY_AGREEMENTCrédito por acordo
INSTALLMENT_OF_AGREEMENTParcela de acordo
AGREEMENT_CONTRACTContrato de acordo
CANCELLATION_OF_INSTALLMENT_AGREEMENTCancelamento da parcela de acordo
CANC_CREDIT_AGREEMENTCancelamento de crédito de acordo
CANCELLATION_CONTRACT_AGREEMENTCancelamento de contrato de acordo
CREDIT_BY_INSTALLMENT_CPCrédito por parcelamento compulsório
CP_REFINANCING_INSTALLMENTParcela de refinanciamento compulsório
CP_REFINANCE_CONTRACTContrato de refinanciamento compulsório
CANC_PARC_DE_REF_CPCancelamento de parcelamento de refinanciamento compulsório
CANC_CREDIT_INSTALLMENT_CPCancelamento de crédito de parcelamento compulsório
CANCELLATION_CONTRACT_REF_CPCancelamento de contrato de refinanciamento compulsório
DEBIT_PAYMENTPagamento com débito
CREDIT_VOUCHERVoucher de crédito
CANC_INSTALLMENTS_WITHOUT_INTERESTCancelamento de parcelado sem juros
CANC_IN_INSTALLMENTS_WITH_INTERESTCancelamento de parcelado com juros
CANC_INSTALLMENT_WITH_INTERESTCancelamento de parcela com juros
CANC_INTERNATIONAL_PURCHASECancelamento de compra internacional
CANC_IOF_INTERNATIONALCancelamento de IOF internacional
REVERSAL_INTERNATIONAL_WITHDRAWALEstorno de saque internacional
REVERSAL_DEBIT_PAYMENTEstorno de débito pagamento
REVERSED_WITHDRAWALEstorno de saque
REVERSAL_RATE_WITHOUT_WITHDRAWALEstorno de tarifa de saque internacional
INTERNATIONAL_WITHDRAWALSaque internacional
FLAG_PAYMENTPagamento da bandeira
TED_CASH_OUTTED cash-out
TEF_CASH_OUTTEF cash-out
TED_CASH_INTED cash-in
DEBIT_REVERSALReversão de débito
REVERSAL_PAYMENTEstorno de pagamento de adesão
REVERSED_WITHDRAWAL_CHARGESEstorno de encargos de saque
PRE_PAID_RECHARGE_RATETarifa de recarga de pré-pago
PREPAID_RECHARGE_PERCENTAGEPercentual de recarga de pré-pago
MDRMDR
REVERSAL_RATE_WITHDRAWALEstorno de tarifa de saque
REVERSAL_IOF_WITHDRAWALEstorno de IOF de saque