[BV] DISCHARGE_WAS_CREATED
beta
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 | DISCHARGE_WAS_CREATED | Itens liquidados por meio externo através de um crédito lançado em fatura. |
Identificador (entityId)
entityId)O campo entityId é o identificador da entidade emissora do evento e seu valor depende do contexto de sua emissão.
Neste evento, o entityId corresponde ao identificador único do discharge.
Definição
Este evento sinaliza quais são os itens de débito de uma fatura que estão sendo liquidados por meio de pagamento externo através de um crédito lançado em 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 |
|---|---|---|---|
dischargeId | number | Identificador único de discharge. | — |
satementId | number | Identificador único da fatura. | — |
creditsTotal | number | Valor total da transação de crédito. | decimal(18,2) |
eventDate | string | Data do evento do dicharge. | — |
holder | object | Objeto que contém informações sobre o proprietário do cartão. | — |
holder.document | object | Objeto que contém informações sobre o documento do proprietário do cartão. | — |
holder.document.value | string | Número do documento. | 50 |
holder.document.type | string | Tipo de documento (CPF ou CNPJ). | 4 |
dischargeItens[] | array of objects | Objeto que contém informações sobre o pagamento dos itens de fatura. | — |
dischargeItens[].dischargeItemId | number | Identificador do item no discharge. | — |
dischargeItens[].statementItemId | number | Identificador do item na fatura. | — |
dischargeItens[].amountpaid | number | Valor pago na transação. | decimal(18,2) |
dischargeItens[].totalAmount | number | Valor total do item de fatura. | decimal(18,2) |
dischargeItens[].previousBalance | number | Valor do saldo anterior ao evento. | decimal(18,2) |
dischargeItens[].balance | number | Valor em aberto do item de fatura. | decimal(18,2) |
dischargeItens[].transactionDate | string | Data da transação, no formato ISO 8601 - UTC. | — |
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":"DISCHARGE_WAS_CREATED",
"entityId":"1448",
"idempotencyKey":"7019cf79-b9b7-4fcc-8d58-577c3664a699",
"companyKey":"ACESSO",
"timestamp":"2023-11-24T17:47:47.2275453Z",
"correlationId":"7019cf79-b9b7-4fcc-8d58-577c3664a699",
"licenseUuid":"a2115ba9-1908-499f-93e2-c5239e595de5",
"version":1,
"metadata":{
"Created":"2023-07-16T19:28:52.267"
},
"context":"Invoice",
"data":{
"dischargeId":1448,
"statementId":20632,
"creditsTotal":400,
"programId":107,
"eventDate":"16/07/2023 19:28:52",
"holder":{
"document":{
"value":"47742663023",
"type":"CPF"
}
},
"dischargeItens":[
{
"dischargeItemId":11111,
"statementItemId":12111,
"amountPaid":200,
"totalAmount":100,
"previousBalance":400,
"balance":200,
"transactionDate":"2023-11-10T19:30:03.4879031Z"
}
]
}
}