TED

Neste contexto, os eventos se referem a transferência (cash-out), recebimento (cash-in) e devolução de valores (refund) via TED.

Dados dos eventos

CASH_OUT_ACCOUNT

Este evento sinaliza a saída de valores de uma conta.

Campos retornados

Nome	Tipo	Descrição
`aggregateId`	`string`	Valor correspondente ao `authenticationCode`, retornado na requisição de transferência via TED. O formato do valor será: TRANSACTION_ID_authenticationCode. Exemplo: “TRANSACTION_ID_95bc3705-11ce-4b80-86be-94e3b13c643c”.
`type`	`string`	Tipo de evento, o qual pode ser "INFO", "TRANSACTION", "ACTION" ou "BACKOFFICE".
`category`	`string`	Neste contexto, esse campo informará o valor “EletronicTransfers”.
`documentNumber`	`string`	Número de documento do cliente.
`bankBranch`	`string`	Agência bancária do cliente.
`bankAccount`	`string`	Número da conta de origem.
`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 sobre o objeto `TransactionReceipt`.
`data.TransactionReceipt`	`objetc`	Objeto que contém informações referentes à transação.
`data.TransactionReceipt.AuthenticationCode`	`string`	Número identificador da transação.
`data.TransactionReceipt.TransactionDate`	`string`	Data em que a transferência ocorreu, no formato ISO 8601 - UTC.
`data.TransactionReceipt.DestinationName`	`string`	Nome do destinatário da transação.
`data.TransactionReceipt.DestinationAgency`	`string`	Número da agência de destino da transação.
`data.TransactionReceipt.DestinationAccount`	`string`	Número da conta de destino.
`data.TransactionReceipt.DestinationDocument`	`string`	Número do documento do destinatário.
`data.TransactionReceipt.DestinationBankName`	`string`	Nome do banco destinatário.
`data.TransactionReceipt.DestinationCompe`	`string`	Número do banco.
`data.TransactionReceipt.Amount`	`number`	Valor transacionado.
`data.TransactionReceipt.Description`	`string`	Descrição da transação.
`data.TransactionReceipt.ControlNumber`	`string`	Identificador do SPB para a TED realizada.
`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": "TRANSACTION_ID_95bc3705-11ce-4b80-86be-94e3b13c643c",
    "type": "TRANSACTION",
    "category": "EletronicTransfers",
    "description": "DESCRIPTION",
    "documentNumber": "98572674756",
    "bankBranch": "0001",
    "bankAccount": "1100903566",
    "amount": -0.01,
    "index": "cash-out",
    "name": "CASH_OUT_ACCOUNT",
    "timestamp": "2023-08-24T19:29:51.7324083Z",
        "data": {
            "TransactionReceipt": {
                "AuthenticationCode": "95bc3705-11ce-4b80-86be-94e3b13c643c",
                "TransactionDate": "2023-08-24T19:29:51.7324083Z",
                "DestinationName": "Quitéria Maria de Jesus",
                "DestinationAgency": "0001",
                "DestinationAccount": "540108",
                "DestinationDocument": "09992220074",
                "DestinationBankName": "Acesso Soluções De Pagamento S.A.",
                "DestinationCompe": "332",
                "Amount": -0.01,
                "Description": "DESCRIPTION",
                "ControlNumber": "AB638285021893339302"
            }
        },
    "status": "ACTIVE"
}

CASH_IN_ACCOUNT

Este evento sinaliza a entrada de valores em uma conta.

Campos retornados

Nome	Tipo	Descrição
`aggregateId`	`string`	Identificador único gerado pela instituição pagadora da TED.
`type`	`string`	Tipo de evento, o qual pode ser "INFO", "TRANSACTION", "ACTION" ou "BACKOFFICE".
`category`	`string`	Neste contexto, esse campo informará o valor “EletronicTransfers”.
`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 os dados referentes à transação.
`data.DepositTransactionId`	`string`	Identificador único gerado pela instituição pagadora da TED.
`data.ControlNumber`	`string`	Identificador do SPB para a transação realizada.
`data.TransactionAmount`	`number`	Valor transacionado.
`data.ClearingAmount`	`number`	Valor liberado na conta.
`data.OverLimitAmount`	`number`	Valor excedido no limite para cash-in.
`data.AddressKey`	`string`	Campo obsoleto que retornará nulo.
`data.Description`	`string`	Descrição da transação.
`data.Channel`	`string`	Canal pelo qual a transação ocorreu.
`data.ConciliationId`	`string`	Campo obsoleto que retornará nulo.
`data.SenderAccount`	`object`	Objeto que contém os dados referentes à conta do pagador.
`data.SenderAccount.Agency`	`string`	Número da agência da conta pagadora.
`data.SenderAccount.Account`	`string`	Número da conta.
`data.SenderAccount.Document`	`string`	Número do documento do titular da conta.
`data.SenderAccount.IspbNumber`	`string`	ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
`data.SenderAccount.Name`	`string`	Nome do titular da conta pagadora.
`data.RecipientAccount`	`object`	Objeto que contém os dados referentes à conta do recebedor.
`data.RecipientAccount.Agency`	`string`	Número da agência da conta recebedora.
`data.RecipientAccount.Account`	`string`	Número da conta recebedora.
`data.RecipientAccount.Document`	`string`	Número do documento do titular da conta conta recebedora.
`data.RecipientAccount.IspbNumber`	`string`	ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
`data.RecipientAccount.Name`	`string`	Nome do titular da conta recebedora.
`data.EndToEndId`	`string`	Campo obsoleto que retornará nulo.
`data.PixTransactionId`	`string`	Campo obsoleto que retornará zerado.
`data.AmountDetails`	`array`	Campo obsoleto que retornará vazio.
`data.WithdrawalProviderIspb`	`string`	Campo obsoleto que retornará nulo.
`data.WithdrawalAgentType`	`string`	Campo obsoleto que retornará nulo.
`data.IsPixDeposit`	`boolean`	Campo obsoleto que determina se a transação ocorreu via Pix. Sempre retornará false.
`data.AuthenticationCodeExternal`	`string`	Campo obsoleto que retornará nulo.
`data.IsTaxDeposit`	`boolean`	Campo obsoleto que retornará false.
`data.IsTaxRefundDeposit`	`boolean`	Campo obsoleto que retornará false.
`data.CorrelationId`	`string`	Identificador interno da transação.
`data.Document`	`string`	Número do documento do recebedor.
data.CompanyKey	`string`	Chave que identifica o parceiro dentro do Bankly.
`data.EventDateTime`	`string`	Data e a hora em que o evento ocorreu.
`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": "TRANSACTION_ID_7fdd6760-2128-4705-ad30-202ff1eba6c6",
    "type": "TRANSACTION",
    "category": "EletronicTransfers",
    "documentNumber": "47742663023",
    "bankBranch": "0001",
    "bankAccount": "15164",
    "amount": 2.0,
    "index": "cash-in",
    "name": "CASH_IN_ACCOUNT",
    "timestamp": "2021-03-25T19:36:35+00:00",
    "data": {
        "DepositTransactionId": "7fdd6760-2128-4705-ad30-202ff1eba6c6",
        "ControlNumber": null,
        "TransactionAmount": 2,
        "ClearingAmount": 2,
        "OverLimitAmount": 0,
        "AddressKey": null,
        "Description": "EXEMPLO_DESCRIÇÃO",
        "Channel": "INTERNAL",
				"ConciliationId": null,
        "SenderAccount": {
            "Agency": "0001",
            "Account": "540108",
            "Document": "09992220074",
            "IspbNumber": "13140088",
            "Name": "Quitéria Maria de Jesus"
        },
        "RecipientAccount": {
            "Agency": "0001",
            "Account": "15164",
            "Document": "47742663023",
            "IspbNumber": "13140088",
            "Name": "Nísia Floresta"
        },
        "EndToEndId": null,
        "PixTransactionId": "00000000-0000-0000-0000-000000000000",
				"AmountDetails": [],
        "WithdrawalProviderIspb": null,
        "WithdrawalAgentType": null,
				"IsPixDeposit": false,
				"AuthenticationCodeExternal": null,
				"IsTaxDeposit": false,
				"IsTaxRefundDeposit": false,
        "CorrelationId": "5c30f22d-9e48-4d96-b543-d53b81ebdc24",
        "Document": "00000000000",
        "CompanyKey": "BANKLY",
        "EventDateTime": "2021-03-25T19:36:35+00:00"
    },
		"status": "ACTIVE"
}

REFUND_ACCOUNT

Este evento sinaliza a devolução de valores para uma conta.

Campos retornados

Nome	Tipo	Descrição
`aggregateId`	`string`	Identificador único gerado na devolução do valor da TED.
`type`	`string`	Tipo de evento, o qual pode ser "INFO", "TRANSACTION", "ACTION" ou "BACKOFFICE".
`category`	`string`	Neste contexto, esse campo informará o valor “EletronicTransfers”.
`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 os dados referentes à transação.
`data.DepositTransactionId`	`string`	Identificador da transação.
`data.TransactionAmount`	`number`	Valor transacionado.
`data.Description`	`string`	Descrição da transação.
`data.Reason`	`string`	Descrição do motivo da devolução do valor.
`data.Channel`	`string`	Canal pelo qual a transação ocorreu.
`data.ControlNumber`	`string`	Identificador do SPB para a transação realizada.
`data.SenderAccount`	`object`	Objeto que contém informações referentes à conta do pagador.
`data.SenderAccount.Agency`	`string`	Número da agência da conta pagadora.
`data.SenderAccount.Account`	`string`	Número da conta.
`data.SenderAccount.Document`	`string`	Número do documento do titular da conta.
`data.SenderAccount.IspbNumber`	`string`	ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
`data.SenderAccount.Name`	`string`	Nome do titular da conta.
`data.RecipientAccount`	`object`	Objeto que contém informações referentes à conta do recebedor.
`data.RecipientAccount.Agency`	`string`	Número da agência da conta recebedora.
`data.RecipientAccount.Account`	`string`	Número da conta.
`data.RecipientAccount.Document`	`string`	Número do documento do titular da conta conta recebedora.
`data.RecipientAccount.IspbNumber`	`string`	ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
`data.RecipientAccount.Name`	`string`	Nome do titular da conta.
`data.IsPixRefund`	`boolean`	Determina se a transação ocorreu via Pix.
`data.CorrelationId`	`string`	Identificador utilizado internamente pelo Bankly.
`data.Document`	`string`	Número do documento do titular da conta conta recebedora.
`data.CompanyKey`	`string`	Chave que identifica o parceiro dentro do Bankly.
`data.EventDateTime`	`string`	Data em que o evento ocorreu, 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

{
	"aggregateId": "TRANSACTION_ID_a44b9f8a-738d-4348-b223-8e5b9d1c0a5d",
	"type": "TRANSACTION",
	"category": "EletronicTransfers",
	"documentNumber": "00000000000",
	"bankBranch": "0001",
	"bankAccount": "000000",
	"amount": 1.25,
	"index": "feed-refund-account-2020-12",
	"name": "REFUND_ACCOUNT",
	"timestamp": "2020-12-09T19:38:23+00:00",
	"data": {
		"DepositTransactionId": "a44b9f8a-738d-4348-b223-8e5b9d1c0a5d",
		"TransactionAmount": 1.25,
		"Description": "EXEMPLO",
		"Reason": "BANK_RETURN",
		"Channel": "SPB",
		"ControlNumber": "STR20201209035697084",
		"SenderAccount": {
			"Agency": "000",
			"Account": "540108",
			"Document": "09992220074",
			"IspbNumber": "60746948",
			"Name": "Quitéria Maria de Jesus"
		},
		"RecipientAccount": {
			"Agency": "0001",
			"Account": "15164",
			"Document": "47742663023",
			"IspbNumber": "13140088",
			"Name": "Nísia Floresta"
		},
		"IsPixRefund": false,
		"CorrelationId": "e9a2ccad-932c-4781-a72f-790b8f204733",
		"Document": "00000000000",
		"CompanyKey": "BANKLY",
		"EventDateTime": "2020-12-09T19:38:23+00:00"
	}
}