Batches Report (CSV)

Página dedicada para CSVs envolvendo registros em Lote (Batches Report)

Batches Report - Arquivo CSV

💡

Os dados do arquivo devem ser separados por ponto e vírgula ";"

Campo Tipo Descrição Obrigatoriedade Regra Condicional Tamanho

referenceId 

alfanumérico 

ID de referência interno da Instituição Financeira 

R (Recomendável) Este campo é obrigatório em caso da instituição tem a intenção de "Editar" ou "Excluir" em lote. 

N/A

operationType 

numérico 

Tipo de operação do registro: 

0 - Inclusão
1 - Alteração
2 - Exclusão 

S (Sim) 

N/A

evidenceType 

numérico 

Distinção se houve indício de ocorrência ou de tentativa de fraude:

1 - Ocorrência
2 - Tentativa 

S (Sim) 

N/A

fraudModality 

numérico 

Modalidade da fraude. Consultar a tabela de modalidade de fraudes.

R (Recomendável) 

N/A

relatedActivity 

numérico 

Atividade relacionada a transação que ocorreu o indício de fraude. Consultar a tabela de referência.

S (Sim) 

N/A

eventDateTime 

datetime
(ISO com Timezone)

Data e hora que ocorreu o indício de fraude 

S (Sim) 

N/A

Exemplo: 2023-11-08T13:37:00Z

transactionValue 

numérico 

Valor referente a transação ou ao valor de contratação de crédito que originou o indício de fraude 

Condicional

Caso a atividade relacionada tenha ID = 3 ou ID = 4 ou ID = 5 ou ID = 6 ou ID = 7 ou ID = 8 ou = 9 ou = 10

Este campo é obrigatório

13.2

description 

alfanumérico 

Campo livre para adicionar quaisquer observações sobre a fraude. 

N (Não) 

N/A

200

reporterTaxPayer 

numérico 

Indica se o documento é de:

1 – Pessoa Física
2 – Pessoa Jurídica 

Condicional

Caso as informações de "Executor" não estejam preenchidas, este campo é obrigatório

reporterDocumentNumber 

numérico 

CPF, quando taxPayer for 1
CNPJ, quando taxPayer for 2 

Condicional

Caso as informações de "Executor" não estejam preenchidas, este campo é obrigatório

reporterFullName 

alfanumérico 

Nome completo do documento ou Razão Social da empresa 

Condicional

Caso as informações de "Executor" não estejam preenchidas, este campo é obrigatório

100

reporterTradeName 

alfanumérico 

Em caso de CNPJ, Nome Fantasia da empresa 

N (Não)

N/A

100

reporterCpfLegalRepresentatives 

alfanumérico 

Em caso de CNPJ, CPF dos representantes legais da empresa (separado por vírgula) 

N (Não)

N/A

reporterEmail 

alfanumérico 

E-mail do reclamante 

N (Não) 

N/A

100

reporterPhoneCountryCode 

numérico

DDI do reclamante

N (Não)

N/A

reporterPhoneAreaCode 

numérico 

DDD do reclamante 

N (Não)

N/A

reporterPhoneNumber 

numérico 

Telefone do reclamante 

N (Não)

N/A

reporterInvolvement 

numérico 

Indicação sobre o envolvimento do reclamante no indício de fraude:

1 - Sim
2 - Não

S (Sim) 

N/A

executorTaxPayer 

numérico 

I Indica se o documento é de:

1 – Pessoa Física
2 – Pessoa Jurídica 

Condicional

Caso as informações de "Reclamante" não estejam preenchidas, este campo é obrigatório

executorDocumentNumber 

numérico 

CPF, quando taxPayer for 1
CNPJ, quando taxPayer for 2 

Condicional

Caso as informações de "Reclamante" não estejam preenchidas, este campo é obrigatório

executorFullName 

alfanumérico 

Nome completo do documento ou Razão Social da empresa.

Condicional

Caso as informações de "Reclamante" não estejam preenchidas, este campo é obrigatório

100

executorTradeName 

alfanumérico 

Em caso de CNPJ, Nome Fantasia da empresa 

N (Não) 

N/A

100

executorCpfLegalRepresentatives 

alfanumérico 

Em caso de CNPJ, CPF dos representantes legais da empresa (separado por vírgula) 

N (Não) 

N/A

executorEmail 

alfanumérico 

E-mail do executor 

N (Não)

N/A

100

executorPhoneCountryCode

numérico

DDI do executor

N (Não)

N/A

executorPhoneAreaCode 

numérico 

DDD do executor 

N (Não) 

N/A

executorPhoneNumber 

numérico 

Telefone do executor 

N (Não)

N/A

toAccountTaxPayer 

numérico 

I Indica se o documento é de:

1 – Pessoa Física
2 – Pessoa Jurídica 

Condicional

Caso a atividade relacionada tenha ID = 4 ou ID = 5 ou ID = 6 ou ID = 7 ou ID = 8

Este campo é obrigatório

toAccountDocumentNumber 

numérico 

CPF, quando taxPayer for 1
CNPJ, quando taxPayer for 2 

Condicional

Caso a atividade relacionada tenha ID = 4 ou ID = 5 ou ID = 6 ou ID = 7 ou ID = 8

Este campo é obrigatório

toAccountFullName 

alfanumérico 

Nome completo do documento ou Razão Social da empresa 

Condicional

Caso a atividade relacionada tenha ID = 4 ou ID = 5 ou ID = 6 ou ID = 7 ou ID = 8

Este campo é obrigatório

100

toAccountTradeName 

alfanumérico 

Em caso de CNPJ, Nome Fantasia da empresa 

N (Não)

N/A

100

toAccountCpfLegalRepresentatives 

alfanumérico 

Em caso de CNPJ, CPF dos representantes legais da empresa (separado por vírgula) 

N (Não) 

N/A

toAccountEmail 

alfanumérico 

E-mail da conta destino 

N (Não) 

N/A

100

toAccountPhoneCountryCode

numérico

DDI da conta destino

N (Não)

N/A

toAccountPhoneAreaCode 

numérico 

DDD da conta destino 

N (Não)

N/A

toAccountPhoneNumber 

numérico 

Telefone da conta destino 

N (Não) 

N/A

toAccountInstitutionCode 

numérico 

Código da Instituição Financeira da conta (ISPB)

Condicional

Caso a atividade relacionada tenha ID = 4 ou ID = 5 ou ID = 6 ou ID = 7 ou ID = 8

Este campo é obrigatório

toAccountAccountType 

alfanumérico 

Tipo da Conta: 

CV - Conta depósito à vista
CP - Conta de depósito poupança
PP - Conta de pagamento pré-paga

Condicional

Caso a atividade relacionada seja alguma referente à prestação de serviço de pagamento

Este campo é obrigatório

toAccountAgencyCode 

alfanumérico 

Código da agência bancária 

Condicional

Caso se tenha a informação de Agência da Conta Destinatária, é necessário preencher

10

toAccountAccountNumber 

alfanumérico 

Número da conta 

Condicional

Caso a atividade relacionada seja alguma referente à prestação de serviço de pagamento

Este campo é obrigatório

20

toAccountPixType

Disponível em produção desde o dia 10/03/2025

alfanumérico

Identificação do tipo da chave PIX da conta destinatária.

Conferir Tabela de Domínios

Condicional

Campo se torna obrigatório se Atividade Relacionada = "7" (Transações de pagamento instantâneo - Pix)

2

toAccountPixKey

Disponível em produção desde o dia 10/03/2025

alfanumérico

Valor da chave PIX da conta destinatária do indício de fraude

Validação a depender do Tipo Chave PIX.

Condicional

Campo se torna obrigatório se Atividade Relacionada = "7" (Transações de pagamento instantâneo - Pix).

Se Tipo Chave PIX = 6, o campo Valor Chave PIX não deve ser preenchido e os campos Agência e Conta se tornam obrigatórios

50

toAccountLinhaBoleto

Disponível em produção desde o dia 10/03/2025

alfanumérico

Linha digitável do boleto que houve o indício de fraude relacionado a conta destinatária.

Exemplo: 00190500950448160698
093503143373700000001000 (Sem espaçamentos ou pontos)

Condicional

Campo se torna obrigatório se Atividade Relacionada = "9" (Boletos de Pagamento)

60

channel 

numérico 

Canal utilizado para execução: 

1 – Internet
2 – Celular
3 – Autoatendimento
4 – Rede Parceiros
5 - Mídias Sociais
6 - Interbancário
7 - Outros 

R (Recomendável) 

N/A

local 

alfanumérico 

Local onde ocorreu o indício de fraude.
Sugestão de Preenchimento: Logradouro e CEP

R (Recomendável) 

N/A

100

ipAddress 

numérico 

Endereço de IP utilizado 

R (Recomendável) 

N/A

100

device 

alfanumérico 

Dispositivo eletrônico utilizado 

R (Recomendável)

N/A

30

📘

Lembrando que um registro deve conter pelo menos dados de Executor e/ou de Reclamante sendo populados. Faremos essa validação condicional.

👍

Batches Report - Retorno 200

CampoTipoTamanhoDescrição
id alfanumérico 24 Id gerado para o arquivo enviado 
fileNamealfanumérico Nome do arquivo enviado 
status alfanumérico 20 Status do arquivo após ser enviado 
createdAtdatetime Data de criação do arquivo 
totalRowsnumérico Número total de linhas do arquivo 
validRowsnumérico Número de linhas válidos do arquivo 
errorRowsnumérico Número de linhas com erro após a validação