Transferência interna

Neste contexto, os eventos se referem a recebimento (cash-in) e pagamento (cash-out) via transferência interna.

Dados dos eventos

TRANSFER_CASH_IN_ACCOUNT

Este evento sinaliza a entrada de valores na conta destino (recipient), sempre que uma transferência interna ocorrer com o atributo statementEntryinformado como true.

Campos retornados

Nome	Tipo	Descrição
`index`	`string`	Índice do evento pra facilitar uma busca por um grupo de eventos. Exemplo: feed-2023-8, feed-2023-7.
`aggregateId`	`string`	Identificador único gerado pela instituição pagadora da transferência interna.
`name`	`string`	Nome do evento.
`category`	`string`	Neste contexto, esse campo informará o valor “InternalTransfers”.
`documentNumber`	`string`	Número de documento do cliente.
`companyKey`	`string`	Chave que identifica o parceiro dentro do Bankly.
`timestamp`	`string`	Data e a hora em que o evento ocorreu, no formato ISO 8601 - UTC.
`bankBranch`	`string`	Agência bancária do cliente.
`bankAccount`	`string`	Número da conta do cliente.
`amount`	`number`	Valor transacionado.
`createdAt`	`string`	Data e hora em que o evento foi criado no formato ISO 8601 - UTC.
`updatedAt`	`string`	Data e hora em que o evento foi atualizado no formato ISO 8601 - UTC.
`status`	`string`	O status “ACTIVATED” indicará que o cash-in está em processamento ou foi realizado com sucesso.
`type`	`string`	Tipo de evento, o qual pode ser "INFO", "TRANSACTION", "ACTION" ou "BACKOFFICE”.
`data`	`object`	Objeto que contém informações referentes à transação.
`data.Channel`	`object`	Identifica o canal/produto de origem da transferência. Exemplo: Pix interno, TED.
`data.Channel.Name`	`string`	Nome identificador do canal de transferência.
`data.Channel.Details`	`object`	Objeto que contém informações referentes ao canal/produto de origem da transferência.
`data.Channel.Details.CODIGO_AUTENTICACAO`	`string`	Identificador do canal/produto de origem da transferência. Exemplo: ID do Pix.

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

{
  "index": "feed-2024-11",
  "aggregateId": "TRANSFER_CASH_IN_ACCOUNT_d8a54b7a-c04f-44f9-8f17-8220b99c7aeb",
  "name": "TRANSFER_CASH_IN_ACCOUNT",
  "category": "InternalTransfers",
  "documentNumber": "37798821830",
  "companyKey": "ACESSO",
  "timestamp": "2024-11-12T19:41:10.643637Z",
  "bankBranch": "0001",
  "bankAccount": "60",
  "amount": 200.1,
  "createdAt": "2024-11-12T19:41:12.7879355Z",
  "updatedAt": "2024-11-12T19:41:12.7879355Z",
  "status": "ACTIVATED",
  "type": "TRANSACTION",
  "data": {
    "Channel": {
      "Name": "OP_INTERNO",
      "Details": {
        "CODIGO_AUTENTICACAO": "5c29a6df-89ec-4112-91c8-b41777af1f04"
      }
    }
  }
}

TRANSFER_CASH_OUT_ACCOUNT

Este evento sinaliza a saída de valores de uma conta de origem (sender), sempre que uma transferência interna ocorrer com o atributo statementEntryinformado como true.

Campos retornados

Nome	Tipo	Descrição
`index`	`string`	Índice do evento pra facilitar uma busca por um grupo de eventos. Exemplo: feed-2023-8, feed-2023-7.
`aggregateId`	`string`	Identificador único gerado pela instituição pagadora da transferência interna.
`name`	`string`	Nome do evento.
`category`	`string`	Neste contexto, esse campo informará o valor “InternalTransfers”.
`documentNumber`	`string`	Número de documento do cliente.
`companyKey`	`string`	Chave que identifica o parceiro dentro do Bankly.
`timestamp`	`string`	Data e a hora em que o evento ocorreu, no formato ISO 8601 - UTC.
`bankBranch`	`string`	Agência bancária do cliente.
`bankAccount`	`string`	Número da conta do cliente.
`amount`	`number`	Valor transacionado.
`createdAt`	`string`	Data e hora em que o evento foi criado no formato ISO 8601 - UTC.
`updatedAt`	`string`	Data e hora em que o evento foi atualizado no formato ISO 8601 - UTC.
`status`	`string`	O status ”ACTIVATED” indicará que o cash-out está em processamento ou foi realizado com sucesso.
`type`	`string`	Tipo de evento, o qual pode ser "INFO", "TRANSACTION", "ACTION" ou "BACKOFFICE”.
`data`	`object`	Objeto que contém informações referentes à transação.
`data.Channel`	`object`	Identifica o canal/produto de origem da transferência. Exemplo: Pix interno, TED.
`data.Channel.Name`	`string`	Nome identificador do canal de transferência.
`data.Channel.Details`	`object`	Objeto que contém informações referentes ao canal/produto de origem da transferência.
`data.Channel.Details.CODIGO_AUTENTICACAO`	`string`	Identificador do canal/produto de origem da transferência. Exemplo: ID do Pix.

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

{
  "index": "feed-2024-11",
  "aggregateId": "TRANSFER_CASH_OUT_ACCOUNT_d8a54b7a-c04f-44f9-8f17-8220b99c7aeb",
  "name": "TRANSFER_CASH_OUT_ACCOUNT",
  "category": "InternalTransfers",
  "documentNumber": "37798821830",
  "companyKey": "ACESSO",
  "timestamp": "2024-11-12T19:41:10.6436761Z",
  "bankBranch": "0001",
  "bankAccount": "60",
  "amount": -200.1,
  "createdAt": "2024-11-12T19:41:15.1966522Z",
  "updatedAt": "2024-11-12T19:41:15.1966522Z",
  "status": "ACTIVATED",
  "type": "TRANSACTION",
  "data": {
    "Channel": {
      "Name": "OP_INTERNO",
      "Details": {
        "CODIGO_AUTENTICACAO": "5c29a6df-89ec-4112-91c8-b41777af1f04"
      }
    }
  }
}