Boletos

Neste contexto, os eventos se referem à emissão e ao recebimento de valores por meio de boletos.

Dados dos eventos

BANKSLIP_ISSUANCE

Este evento sinaliza a emissão de um boleto.

Campos retornados

Nome	Tipo	Descrição
`aggregateId`	`string`	Valor correspondente ao `authenticationCode`, retornado na requisição de emissão do boleto.
`type`	`string`	Tipo de evento, que pode ser "INFO", "TRANSACTION", "ACTION" ou "BACKOFFICE".
`category`	`string`	Neste contexto, esse campo informará o valor “BankSlipIssuanse”.
`documentNumber`	`string`	Número de documento do cliente.
`bankBranch`	`string`	Agência bancária do cliente.
`bankAccount`	`string`	Número da conta.
`amount`	`number`	Valor transacionado.
`index`	`string`	Índice do evento pra facilitar uma busca por um grupo de eventos. Exemplo: feed-2023-8, feed-2023-7.
`name`	`string`	Nome do evento.
`timestamp`	`string`	Data e a hora em que o evento ocorreu.
`data`	`object`	Objeto que contém informações referentes ao boleto.
`data.bankSlipId`	`string`	Mesmo valor retornado no campo `aggregateId`.
`data.AmountInCents`	`number`	Valor em centavos que foi transacionado.
`data.IssueDate`	`string`	Data de emissão do boleto, no formato ISO 8601 - UTC.
`data.ExpirationDate`	`string`	Data de vencimento do boleto.
`data.BarCode`	`string`	Código de barras do boleto.
`data.DigitableLine`	`string`	Linha digitável do boleto.
`data.BankCode`	`string`	Código do banco.
`data.Paid`	`boolean`	Campo que informa true, caso o boleto já tenha sido pago, e false, se o pagamento ainda não ocorreu.
`data.Url`	`string`	URL para download do PDF.
`status`	`string`	O status "ACTIVE" indicará que o cash-out está em processamento ou foi realizado com sucesso. Caso contrário, o status estará como "CANCELED".

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

{
	"aggregateId": "facafbd7-03b1-477f-8d78-f6bb06016de2",
	"type": "INFO",
	"category": "BankSlipIssuanse",
	"documentNumber": "39020237080",
	"bankBranch": "0001",
	"bankAccount": "174467",
	"amount": 1.0,
	"index": "feed-bankslip-issuance-2021-4",
	"name": "BANKSLIP_ISSUANCE",
	"timestamp": "2022-02-14T18:14:17.5812133+00:00",
	"data": {
		"BankSlipId": "facafbd7-03b1-477f-8d78-f6bb06016de2",
		"AmountInCents": 100,
		"IssueDate": "2022-02-14T18:14:17.6234066Z",
		"ExpirationDate": "2022-02-11T00:01:00.007+00:00",
		"BarCode": "33291861600000001000001113684198860900174467",
		"DigitableLine": "33290001151368419886709001744672186160000000100",
		"BankCode": "332",
		"Paid": false,
		"Url": "https://api.sandbox.bankly.com.br/bankslip/facafbd7-03b1-477f-8d78-f6bb06016de2/pdf"
	},
	"status": "ACTIVE"
}

CASH_IN_ACCOUNT

Este evento sinaliza a entrada de valor na conta do cliente por pagamento do boleto emitido.

Campos retornados

Nome	Tipo	Descrição
`aggregateId`	`string`	Identificador único da transação recebida.
`type`	`string`	Tipo de evento, que pode ser "INFO", "TRANSACTION", "ACTION" ou "BACKOFFICE".
`category`	`string`	Neste contexto, esse campo informará o valor “BankSlipIssuanse”.
`documentNumber`	`string`	Número de documento do cliente.
`bankBranch`	`string`	Agência bancária do cliente.
`bankAccount`	`string`	Número da conta.
`amount`	`number`	Valor transacionado.
`index`	`string`	Índice do evento pra facilitar uma busca por um grupo de eventos. Exemplo: feed-2023-8, feed-2023-7.
`name`	`string`	Nome do evento.
`timestamp`	`string`	Data e a hora em que o evento ocorreu, no formato ISO 8601 - UTC.
`data`	`object`	Objeto que contém informações referentes ao boleto.
`data.channel`	`string`	Nome do tipo de canal de transferência bancária, o qual sempre será “Boleto”.
`data.ourNumber`	`string`	Identificador único contido no código de barras do boleto.
`status`	`string`	O status "ACTIVE" indicará que o cash-out está em processamento ou foi realizado com sucesso. Caso contrário, o status estará como "CANCELED".

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

{
    "aggregateId": "12540fa3-7e92-4323-9b4c-5751b48a82a1",
    "type": "TRANSACTION",
    "category": "BankSlipIssuanse",
    "documentNumber": "00000000000",
    "bankBranch": "0001",
    "bankAccount": "000000",
    "amount": 1.0,
    "index": "feed-cash-in-account-2021-4",
    "name": "CASH_IN_ACCOUNT",
    "timestamp": "2021-04-20T12:50:40.26937Z",
    "data": {
        "channel": "BANKSLIP",
        "ourNumber": "50867888447"
    },
		"status": "ACTIVE"
}