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;
- Uma oferta de crédito para parcelamento é confirmada com sucesso;
- Há falha na confirmação da oferta de crédito para parcelamento.
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
.
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 | INVOICE_CLOSED | Fatura do cartão fechada. |
Invoice | INVOICE_PAYMENT_OPTION_CREATED | Opção de pagamento de fatura criada. |
Invoice | INVOICE_PAYMENT_PROCESSED | Pagamento proporcional da fatura do cartão processado. |
Invoice | INVOICE_INSTALLMENT_PLAN_WAS_ACTIVATED | Oferta de crédito de parcelamento ativada com sucesso. |
Invoice | INVOICE_INSTALLMENT_PLAN_ACTIVATION_WAS_FAILED | Falha na ativação da oferta de crédito de parcelamento devido ao pagamento anterior. |
Fluxo dos eventos
O fluxograma a seguir descreve a sequência em que os eventos ocorrem. Clique na imagem para ampliá-la:
![](https://files.readme.io/b0ef1e6e6604eea277d175287d4bd6c6b9757b42ee354730ac512daa302d9aef-Fluxo_eventos_-_Parceiro.jpg)
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 (eventoTRANSACTION_CREATED
).
Identificador (entityId
)
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. |
INVOICE_CLOSED | 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. |
Dados dos eventos
TRANSACTION_CREATED
Este evento sinaliza que uma transação foi criada.
Descrição do objeto data
do evento
data
do eventoO 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 informações sobre a fatura. | — |
statement.id | integer | Identificador único da fatura. | — |
statement.dueDate | string | Data de vencimento da fatura. | 25 |
statement.cycleCloseDate | string | Data de fechamento da fatura, no formato 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. | 50 |
isCredit | boolean | Indica o tipo de operação, sendo TRUE para crédito e FALSE para débito. | — |
statementPost | boolean | Indica se é um item exibido na fatura, sendo TRUE para exibido e FALSE para oculto. | — |
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 |
authorizationTrackingId | string | Identificador de rastreamento da transação (crédito ou débito). | 75 |
transactionTypeId | integer | Identificador do tipo da transação. | — |
transactionType | string | Tipo de transação. Consulte a tabela dos possíveis tipos de transação no final da página. | 100 |
transactionDescription | string | Descritivo do item da fatura. | 150 |
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 contendo 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 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 objects | Lista de objetos contendo informações sobre as taxas aplicadas na transação. | — |
fees[].feeType | string | Tipo 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[].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 informações referentes a uma transação bandeirada (compra ou saque). | — |
transaction.card | object | Objeto que contém informações sobre o cartão utilizado na transação. | — |
transaction.card.proxy | string | Código identificador do cartão. | 30 |
transaction.card.lastFourDigits | string | Quatro últimos 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 definido pelo proprietário do 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.merchant | string | Nome do 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,
"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
data
do eventoO 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 informações sobre a 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. | 50 |
isCredit | boolean | Indica o tipo de operação, sendo TRUE para crédito e FALSE para débito. | — |
statementPost | boolean | Indica se é um item exibido na fatura, sendo TRUE para exibido e FALSE para oculto. | — |
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. Consulte a tabela dos possíveis tipos de transação no final da página. | 100 |
transactionDescription | string | Descritivo do item da fatura. | 150 |
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 |
amount[] | array of objects | Lista de objetos contendo informações sobre o total da transação. | — |
amount[].value | number | Valor do item da fatura. | decimal(18,2) |
amount[].currency | string | Código da moeda com base na ISO-4217. | 3 |
amount[].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 contendo 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 à 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 informações referentes a uma transação bandeirada (compra ou saque). | — |
transaction.card | object | Objeto que contém informações sobre o cartão utilizado na transação. | — |
transaction.card.proxy | string | Código identificador do cartão. | 30 |
transaction.card.lastFourDigits | string | Quatro últimos 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 definido pelo proprietário do 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 |
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.merchant | string | Nome do 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": "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
data
do eventoO 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 | int | Identificador único da fatura. | — |
month | int | Representa o mês de vencimento da fatura. | — |
year | int | Representa o ano de vencimento da fatura. | — |
cycle | int | 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 dos itens de parcela com juros a vencer, com desconto dos encargos que compõem a parcela. | — |
summary.installmentSummary.interest.value | number | Valor total dos itens parcelados 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 dos itens de parcela com juros a vencer, sem o desconto dos encargos que compõem a parcela. | — |
summary.installmentSummary.interestWithoutDiscount.value | number | Valor total dos itens parcelados 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 valores de transações de encargos lançados na fatura. | — |
summary.amountMinimalComposition.fees.value | number | Valor total dos itens de encargos lançados em fatura. | Decimal (18,2) |
summary.amountMinimalComposition.refinance | object | Objeto que contém a soma dos valores de transações de refinanciamento de fatura lançados na fatura. | — |
summary.amountMinimalComposition.refinance.value | number | Valor total dos itens de refinanciamento de fatura lançados em 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 valores das transações de débito lançados em fatura. | — |
summary.amountMinimalComposition.transactions.value | number | Valor total das transações de débitos lançadas 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 os valores totais das transações na fatura, agrupados por categoria de transação. | — |
summary.transactionsSummary.nationalPurchasing | object | Objeto que contém a soma dos valores das transações nacionais na fatura. | — |
summary.transactionsSummary.nationalPurchasing.value | number | Soma dos valores 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 dos valores das transações internacionais na fatura. | — |
summary.transactionsSummary.internationalPurchasing[].value | number | Soma dos valores 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 valores dos encargos lançados na fatura. | — |
summary.transactionsSummary.fees.value | number | Soma dos valores das transações de 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 valores dos ajustes a débito na fatura. | — |
summary.transactionsSummary. debtAdjustments.value | number | Soma dos valores das transações de 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 valores das transações de ajustes a crédito na fatura. | — |
summary.transactionsSummary.creditAdjustments.value | number | Soma dos valores das transações de 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 valores de transações de pagamentos realizadas. | — |
summary.transactionsSummary.payments.value | number | Soma dos valores das transações de 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 valores de transações de seguro na fatura. | — |
summary.transactionsSummary.insurance.value | number | Soma dos valores das transações 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 valores de transações de anuidade na fatura. | — |
summary.transactionsSummary.annuity.value | number | Soma dos valores das transações da 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 valores de transações de saque na fatura. | — |
summary.transactionsSummary.withdraw.value | number | Soma dos valores de transações de saque 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 valores de transações de saques internacionais na fatura. | — |
summary.transactionsSummary.internationalWithdraw.value | number | Soma dos valores de transações de saque internacional 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 dos valores das transações parceladas na fatura atual. | — |
summary.transactionsSummary.installment.value | number | Soma dos valores 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 | Nome exibido no 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 valores de transações dos itens de débito na fatura atual. | — |
summary.transactionsCardsSummary[].totalDebits.value | number | Soma dos valores das transações 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 dos valores de transações nacionais na fatura. | — |
summary.transactionsCardsSummary[].nationalPurchasing.value | number | Soma dos valores 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 dos valores de transações internacionais na fatura. | — |
summary.transactionsCardsSummary[].internationalPurchasing[].value | number | Soma dos valores 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 valores de transações dos encargos na fatura. | — |
summary.transactionsCardsSummary[].fees.value | number | Soma dos valores das transações de encargos 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 valores de transações de ajustes a débito na fatura. | — |
summary.transactionsCardsSummary[].debtAdjustments.value | number | Valor total das transações de 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 valores de transações de ajustes a crédito na fatura. | — |
summary.transactionsCardsSummary[].creditAdjustments.value | number | Soma dos valores das transações de 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 valores de transações de pagamentos por cartão. | — |
summary.transactionsCardsSummary[].payments.value | number | Soma dos valores das transações de 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 valores de transações de seguro na fatura. | — |
summary.transactionsCardsSummary[].insurance.value | number | Soma dos valores das transações 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 valores de transações de anuidade na fatura. | — |
summary.transactionsCardsSummary[].annuity.value | number | Soma dos valores das transações da anuidade na fatura. | decimal(18,2) |
summary.transactionsCardsSummary[].annuity.currency | string | Código da moeda com base na ISO-4217. | 3 |
summary.transactionsCardsSummary[].withdraw.value | number | Soma dos valores das transações de saque 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 valores de transações de saques internacionais na fatura. | — |
summary.transactionsCardsSummary[].internationalWithdraw.value | number | Soma dos valores das transações de 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 dos valores de transações parceladas na fatura atual. | — |
summary.transactionsCardsSummary[].installment.value | number | Soma dos valores 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 | int | 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 | int | 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 |
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": "2021-12-06T11:10:20.282+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": "14952781747",
"type": "CPF"
}
},
"designatedFunding": "BV"
}
}
]
[
{
"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-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"
},
"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": "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
data
do eventoO 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 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 |
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": "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
data
do eventoO 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 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 |
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
data
do eventoO 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 | Informa o percentual do IOF diário. | decimal (18,4) |
creditOffer.fixedIof | number | Informa o 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 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 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
data
do eventoO 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 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 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": "78782504644",
"type": "CPF"
}
},
"designatedFunding": "BV"
},
"licenseUuid": "24ac71da-4309-4348-9cc0-a0c88f867993"
}
]
Tabela 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 |
Updated 17 days ago