Dicionário de Dados

Nesta local, esta mapeado os atributos que compõe os "Registros e Atualizações de Ativos Financeiros", o dicionário de dados tem como objetivo, orientar o uso cada campo, seu preenchimento, obrigatoriedade e um exemplo de seu conteúdo.

>
Atributo Informativo Definição Obrigatório
em
Conteúdo (Exemplo)
account Somente números sem formatação Número da conta Caso objeto settlements for preenchido Registro e Atualização de Ativos Financeiros Caso objeto settlement
bankAccount for preenchido
Envio de Posição de Agenda
13341
accountDigit Dígito da conta sem formatação, campo Alfanumérico com limite de dois (2) dígitos Dígito da conta Caso objeto settlements for preenchido Registro e Atualização de Ativos Financeiros Caso objeto settlement
bankAccount for preenchido
Envio de Posição de Agenda
X5
accountType Sigla de contas disponíveis Tipo de conta Caso objeto settlements for preenchido Registro e Atualização de Ativos Financeiros Caso objeto settlement
bankAccount for preenchido
Envio de Posição de Agenda
CC
CD
CG
CI
PG
PP
additionalData Aceita 100 dígitos alfanumericos, informações adicionais á referência Dados adicionais da solicitação de registro additional
Data-0
agencia Somente números sem formatação Número da Agência Caso objeto GrupoDados
ContaBancaria for preenchido
Registro em formato xml
3232
amount Campo numeral sem formatação Valor liquidado Caso objeto settlements for preenchido, Registro e Atualização de Ativos Financeiros 10000
arranjo
de
Pagamento
Sigla do Arranjo de pagamento Arranjo de pagamento Registro em formato xml, Consulta de Registro em formato xml por parâmetros VCC
assetHolder CNPJ/CPF válido, informar somente números sem formatação Beneficiário da Liquidação Consulta de Liquidação por Parâmetros Caso objeto settlements for preenchido, Registro e Atualização de Ativos Financeiros 999999
99999999
assetHolder
DocumentType
Documento Federal CPF ou CNPJ Documento Federeal do Beneficiário Registro e Atualização de Ativos Financeiros Transações Componentes de Unidades de Recebíveis Informe de Liquidação 999999
99999999
branch Somente números sem formatação Número da agência Caso objeto settlements for preenchido Registro e Atualização de Ativos Financeiros Caso objeto settlement
bankAccount for preenchido
Envio de Posição de Agenda
1144
commitment
DueDate
Data no formato yyyy-mm-dd Data da obrigação contratual Caso objeto settlement
Obligations for preenchido
Envio de Posição de Agenda
2020-02-02
conta Somente números sem formatação Número da Conta Caso objeto GrupoDados
ContaBancaria for preenchido
Registro em formato xml
022258
conta
Pagamento
Número da Conta de Pagamento Conta de Pagamento Registro em formato xml 00121
contract
Beneficiary
CPF/CNPJ válido, informar somente números sem formatação CPF/CNPJ do Participante Favorecido da Averbação Caso objeto settlement
Obligations for preenchido
Envio de Posição de Agenda
99999999999
createdDate Data no formato yyyy-mm-dd, apresenta tambem horario da criação Data de criação Envio de Posição de Agenda 2020-06-29
T23:17:32.
6441048Z
data
Liquidacao
Efetiva
Data no formato yyyy-mm-dd Data de Liquidação Efetiva Caso objeto GrupoLiquidacao
Efetiva for preenchido
Registro em formato xml
2020-02-02
data
Prevista
Liquidacao
Data no formato yyyy-mm-dd Data Prevista de Liquidação Caso objeto GrupoUnidade
Recebivel for preenchido
Registro em formato xml
2020-04-04
debtor Campo auto preenchido via autenticação CNPJ do Devedor Originário do Ativo Financeiro Consulta de Unidade de Recebíveis por Parâmetros
Consulta Histórico da Unidade de Recebíveis por Parâmetros
Consulta de Agenda por Parâmetros
Consulta de Liquidação por Parâmetros
Envio de Posição de Agenda
8888888
8888888
DigitoConta Somente números sem formatação, campo Alfanumérico com limite de dois (2) dígitos Dígito da conta Caso objeto GrupoDados
ContaBancaria for preenchido
Registro em formato xml
X3
document
Number
informar somente números sem formatação Número do documento federal Caso objeto settlements for preenchido Registro e Atualização de Ativos Financeiros Caso objeto original
Asset
Holders for preenchido
Envio de Posição de Agenda
0000000
0000000
documentType Documento Federal, valores válidos: CPF ou CNPJ Documento Federal Caso objeto settlements for preenchido Registro e Atualização de Ativos Financeiros Caso objeto settlement
Obligations for preenchido
Envio de Posição de Agenda
CNPJ
CPF
documentodo
Usuario
FinalRecebedor
CNPJ válido CNPJ do Devedor Originário do Ativo Financeiro, CNPJ válido, somente números sem formatação Registro em formato xml 9999999
9999999
documento
TitularConta
CNPJ válido, somente números sem formatação Número do documento do titular Caso objeto GrupoInstituicao
Domicilio
Liquidada for preenchido
Registro em formato xml
000000
00000000
dueDate Data no formato yyyy-mm-dd Data de vencimento da Unidade de Recebíveis Registro e Atualização de Ativos Financeiros, Consulta de Unidade de Recebíveis por Parâmetros, Consulta Histórico da Unidade de Recebíveis por Parâmetros Caso objeto receivable for preenchido Envio de Posição de Agenda 2022-03-23
effectType Podendo ser de Ônus e Gravames
(warranty), ou Alteração de Titularidade (ownership
Assignment)
Tipo de efeito da Averbação Caso objeto settlement
Obligations for preenchido
Envio de Posição de Agenda
warranty
endDueDate Data no formato yyyy-mm-dd Intervalo final para a data de vencimento da Unidade de Recebíveis Consulta de Agenda por Parâmetros 2020-01-16
endExpected
SettlementDate
Data no formato yyyy-mm-dd Intervalo final para a Data prevista de liquidação Consulta de Liquidação por Parâmetros 2020-02-02
eventType Campo alfanumérico Tipo de Evento Envio de Posição de Agenda consent
expected
Amount
Campo numeral sem formatação Valor a ser liquidado Caso objeto settlement
Expectancy for preenchido
Envio de Posição de Agenda
30000
expected
SettlementDate
Data no formato yyyy-mm-dd Data de expectativa de liquidação Caso objeto settlement
Expectancy for preenchido Envio de Posição de Agenda
2019-11-20
extraction
Date
Campo mostrando data e hora do processamento em formato yyyy-mm-dd, apresenta tambem horário da extração Data de Extração das Agendas Envio de Posição de Agenda 2020-07-26
T03:03:51
.164Z
freeAmount Campo numeral sem formatação Valor disponível das Unidades de Recebíveis Consulta Histórico da Unidade de Recebíveis por Chave e Consulta Histórico da Unidade de Recebíveis por Parâmetros 200000
identificador Identificador da Transação Caso objeto Grupo
Transacoes for preenchido
, Registro em formato xml
12458
identificador
Credenciador
Subcredenciador
CNPJ válido, somente números sem formatação CNPJ do Devedor Originário do Ativo Financeiro Registro em formato xml 888888
88888888
identifier Identificador da transação componente da Unidade de Recebíveis identificador da transação Caso objeto transactions for preenchido, Transações Componentes de Unidades de Recebíveis, Retificação das Transações de Unidades de Recebíveis e Envio de Posição de Agenda 0125048
520200512
ispb Identificador do Sistema de Pagamentos Brasileiro, código com oito (8) dígitos Código ISPB Caso objeto settlements for preenchido Registro e Atualização de Ativos Financeiros Caso objeto settlement
bankAccount for preenchido
Envio de Posição de Agenda
12345678
ISPB
Instituicao
Domicilio
Identificador do Sistema de Pagamentos Brasileiro, código com oito (8) dígitos Código ISPB Caso objeto GrupoInstituicao
Domicilio
Liquidada for preenchido
Registro em formato xml
12100000
key Campo alfanumérico composto por 32 dígitos(guid) Chave de identificação Transações Componentes de Unidades de Recebíveis, Retificação das Transações de Unidades de Recebíveis, consulta de Unidade de recebíveis por chave, Consulta Histórico da Unidade de Recebíveis por Chave, Consulta de Transações de Unidades de Recebíveis, Informe de Rejeição da Liquidação, consulta de liquidação por chave, Caso objeto settlement
Obligations e/ou receivable e/ou settlement
Expectancy for preenchido
Envio de Posição de Agenda
6404259d
5580-47eb
afde
05445366a587
key Campo numérico Chave única da Liquidação Informe de Liquidação 1231231
message Campo texto preenchido automaticamente com o retorno da solicitação (Descrição do problema de preenchimento de campos) Mensagem do processamento da solicitação Envio de Posição de Agenda
amount Somente números sem formatação. Os valores em centavos devem ser multiplicados por 100, ex: Para R$10,00, enviar 1000 Valor total da Unidade de Recebíveis decrescido do valor previamente pago (prePaidAmount) Registro e Atualização de Ativos Financeiros Caso objeto receivable for preenchido Envio de Posição de Agenda 210000
original
AssetHolder
CPF/CNPJ válido, informar somente números sem formatação CPF/CNPJ do Detentor Originário do Ativo Financeiro. Registro e Atualização de Ativos Financeiros, Consultas (todas referente Registro) Caso objeto receivable for preenchido Envio de Posição de Agenda 999999
99999999
prePaidAmount Somente números sem formatação. Os valores em centavos devem ser multiplicados por 100, ex: Para R$10,00, enviar 1000 Valor constituído Pré-Contratado Caso objeto receivable for preenchido Envio de Posição de Agenda 0
processDate Campo mostrando data e hora do processamento em formato yyyy-mm-dd, apresenta tambem horario da criação Data do processamento da posição Envio de Posição de Agenda 2020-06-29
T23:17:33.
6547781Z
processKey Conteúdo de valor único em formato alfanumérico, com dados serparados por hífen Chave da solicitação de processamento Consulta de Agenda por ProcessKey, Consulta de Liquidação por ProcessKey, Envio de Posição de Agenda 7f0b669c-bf0c
-49b0-b828-
7fd292
6faaa7
reason Motivo Informe de Rejeição da Liquidação Dispute
reasonDetails Razão detalhada Informe de Rejeição da Liquidação Liquidação não executada
reference Identificador externo do parâmetro Registro e Atualização de Ativos Financeiros
Transações Componentes de Unidades de Recebíveis
Retificação das Transações de Unidades de Recebíveis
Informe de Liquidação
Consulta de Liquidação por Referência
Envio de Posição de Agenda
ST-014
receivableKey Chave única da Unidade de Recebíveis a ser liquidada. Informe de Rejeição da Liquidação 8f1ed2be18
e9fd15e29f4
1dfeba58f6a
settlement
ObligationDate
Data Válida para Obrigação de Liquidação Data no formato yyyy-mm-dd Registro e Atualização de Ativos Financeiros
Informe de Liquidação
2020-06-29
settlementDate Data no formato yyyy-mm-dd Data da efetivação da liquidação Informe de Liquidação Caso objeto settlements for preenchido Registro e Atualização de Ativos Financeiros 2022-03-23
settlementPriority Prioridade de Liquidação (Certame) Caso objeto settlement
Obligations for preenchido
Envio de Posição de Agenda
0
startDueDate Data no formato yyyy-mm-dd Intervalo inicial para a data de vencimento da Unidade de Recebíveis Consulta de Agenda por Parâmetros 2020-01-03
rtatus Estado do processamento Envio de Posição de Agenda Registered
tipoConta Sigla de contas disponiveis Tipo da Conta Caso objeto GrupoInstituicao
Domicilio
Liquidada for preenchido
Registro em formato xml
CC,CD,CG,CI, PG,PP
transactionDate Data em que a transação componente da Unidade de Recebíveis foi criada respeitando o formato yyyy-mm-dd Data da transação Caso objeto transactions for preenchido, Transações Componentes de Unidades de Recebíveis e Retificação das Transações de Unidades de Recebíveis 2020-05-12
valor
Constituido
PreContratado
Campo numérico, sem formatação Valor constituído Pré-Contratado Caso objeto GrupoUnidade
Recebivel for preenchido
Registro em formato xml
0
valor
Constituido
Total
Campo numérico, sem formatação Valor total líquido da Unidade de Recebíveis Caso objeto GrupoUnidade
Recebivel for preenchido
Registro em formato xml
100
valor
Liquidacao
Efetiva
Campo numerico, sem formatação Valor Efetivo de Liquidação Caso objeto GrupoLiquidacao
Efetiva for preenchido
Registro em formato xml
100
value Campo numérico, sem formatação Valor da obrigação contratual Caso objeto settlement
Obligations e/ou uncommitted for preenchido
Envio de Posição de Agenda
30000
paymentScheme Sigla do arranjo de pagamento Arranjo de Pagamento Registro e Atualização de Ativos Financeiros, Consulta de Unidade de Recebíveis por Parâmetros, Consulta Histórico da Unidade de Recebíveis por Parâmetros, Consulta de Agenda por Parâmetros, Consulta de Liquidação por Parâmetros Caso objeto receivable for preenchido Envio de Posição de Agenda GCC