Dicionário de Campos do Payload

Nessa Cessão, trouxemos um material de apoio referente a todos os campos que podem aparecer nos Endpoints de Credor, como Opt-in, Opt-out, Averbação, Consulta e Notificação, contendo significado e explicação de como preenchê-lo:

account: Número da conta bancária do beneficiário sem o dígito verificador - Somente números sem formatação, ex: 00121;
accountDigit: Dígito verificador da conta - Sem formatação, ex: X3;
accountType: Código do Tipo da conta - Valores válidos CC,CD,CG,CI, PG,PP;
acquirer: CNPJ válido - Informar somente números sem formatação;
assetHolder: CNPJ/CPF do titular/beneficiário - Informar somente números sem formatação;
assetHolderDocumentType": Tipo do documento do titular/beneficiário - Valores válidos: CNPJ, CPF;
balanceAmount: Somente números sem formatação. Os valores em centavos devem ser multiplicados por 100, ex: Para R$10,00, enviar 1000;
balanceDue: Valor do saldo comprometido em contrato - Somente números sem formatação. Os valores em centavos devem ser multiplicados por 100, ex: Para R$10,00, enviar 1000;
bankAccount: Dados bancários do beneficiário do contrato onde o contrato deve ser liquidado;
beneficiary : CNPJ/CPF do Participante favorecido com a informação - Informar somente números sem formatação;
branch: Número da agência do beneficiário - Somente números sem formatação, ex: 3232;
committedAmount: Valor comprometido com contrato mas que ainda não foi aplicado efeito por falta de saldo. Somente números sem formatação. Os valores em centavos devem ser multiplicados por 100, ex: Para R$10,00, enviar 1000;
contractDueDate: Data de vencimento do contrato - Data no formato AAAA/MM/DD;
contractHolder: CNPJ/CPF do Credor beneficiário do contrato - Informar somente números sem formatação;
contractHolderDocumentType: Tipo do documento do beneficiário do Contrato - Valores válidos: CNPJ, CPF;
contractInfo: Informações resumidas do contrato notificado;
contractSpecifications: Especificações que foram comprometidas pelo contrato - Objeto;
contractSpecificationsCount: Contador de Especificações vinculadas a este contrato;
contractStatus: Status atual do contrato - Valores válidos: Active, Accomplished, Canceled, Refused;
contractUniqueIdentifier: Chave única gerada automaticamente do Contrato, baseado nos valores do contrato;
createdAt: Data da criação - Data no formato AAAA/MM/DD;
datePriority: Data no formato AAAA/MM/DD ex: 2020-02-02;
debtor: Instituição Credenciadora ou Subcredenciadora, responsável pela UR - CNPJ/CPF válido, informar somente números sem formatação;
divisionMethod: Regra de divisão do contrato - Opções válidas: percentage, fixedAmount;
documentNumber: Documento do titular da conta - CNPJ/CPF válido, informar somente números sem formatação;
documentType: Tipo do documento do titular da conta - Valores válidos: CPF/CNPJ;
effectPriority: Prioridade alcançada pelo contrato; effectStrategy: Opções válidas: specific, custom;
effectStrategy: Tipo de estratégia adotada para a averbação - Valores válidos: specific, custom ou overall;
effectType: Tipo de efeito de contrato - Opções válidas :warranty, ownershipAssignment, contractualBurden e pawn;
effectValue: Valor em reais que o contrato adquire da UR - Somente números sem formatação. Os valores em centavos devem ser multiplicados por 100, ex: Para R$10,00, enviar 1000;
endDate: Data no formato AAAA/MM/DD, ex: 2020-02-02;
errors: Conjunto de tipos de erros;
eventSource: Fonte do evento da notificação - Valores válidos: ContractHolder, TradeRepository;
eventType: Evento originador da notificação: (Contract, Consent, ContractUpdate, Position, Error, ContractBankAccount;
eventType: Tipo de situação do evento do contrato que originou a notificação - Opções válidas: update, create, canceled e execute;
expectedSettlementDate: Data de liquidação da especificação do contrato esperada pelo arranjo de pagamento ou com efeitos de antecipação - Data no formato AAAA/MM/DD, ex: 2020-02-02;
hasError: Flag de erro gerado ou não na notificação - Opções válidas - false e true;
isCanceled: Flag de contrato ativo ou inativo - Opções válidas - false e true;
ispb: Código da instituição do ISPB - Deve conter 8 dígitos, ex: 12100000;
key: Chave do contrato gerada automaticamente anteriormente - Formato em GUID;
lastUpdated: Data da última atualização do contrato - Data no formato AAAA/MM/DD;
message: Mensagem opcional em caso de erros na geração/envio da notificação;
notificationRecipient: Número do documento federal do recebedor da notificação - CNPJ/CPF válido, informar somente números sem formatação;
notificationRecipientDocumentType: Tipo do documento - Valores válidos: CNPJ, CPF;
notificationReferenceDate: Data da criação da notificação - Data no formato AAAA/MM/DD;
originalAssetHolder: Número do documento federal do titular originador da UR atingida pela especificação do contrato - Informar somente números sem formatação;
originalAssetHolderDocumentType: Tipo de documento do originador da UR atingida pela especificação do contrato - Valores válidos: CPF/CNPJ;
participantDocument: Número do documento federal (CPF/CNPJ) do titular da notificação;
paymentScheme: Arranjo de pagamento da UR atingida pela especificação do contrato - Sigla conforme Tabela de Arranjo de Pagamento ou "ALL" (para informar que são todos os arranjos);
percentageValue: orcentagem de valor da UR comprometido com o contrato - Deve ser preenchido somente se o divisionMethod for do tipo "percentage". Os valores devem ser multiplicados por 100, ex: Para 10%, enviar 1000;
processKey: Chave de processamento gerada automaticamente - Formato em GUID;
queryDate: Data da extração/consulta - Formato AAAA/MM/DD;
receivableDebtor: Instituição Credenciadora ou Subcredenciadora, responsável pela UR - CNPJ/CPF válido, informar somente números sem formatação;
reference: Chave única externa, Tamanho máximo 100 caracteres;
settledAmount: Valor liquidado - Somente números sem formatação. Os valores em centavos devem ser multiplicados por 100, ex: Para R$10,00, enviar 1000;
settlementExpectationAffected: Datas de Expectativa de Liquidação dos ativos afetados pelo contrato;
settlementObligationKey: Chave da SO gerada automaticamente - Formato em GUID;
signatureDate: Data de assinatura do contrato. Data no formato AAAA/MM/DD;
startDate: Data de início do Opt-in. Data no formato AAAA/MM/DD;
Status: Status da notificação - Valores Válidos: Sent, Error, Confirmed, Created;
totalAmount: Valor total da UR - Somente números sem formatação. Os valores em centavos devem ser multiplicados por 100, ex: Para R$10,00, enviar 1000;
uncommittedAmount: Valor livre para negociação - Somente números sem formatação. Os valores em centavos devem ser multiplicados por 100, ex: Para R$10,00, enviar 1000;
uniqueId: Chave única gerada automaticamente do Contrato, baseado nos valores do contrato ; Formato em GUID;
warrantyAmount: Valor referente ao tipo de garantia informado - Somente números sem formatação. Os valores em centavos devem ser multiplicados por 100, ex: Para R$10,00, enviar 1000. Deve-se preencher somente se o campo “effectType” estiver preenchido como “warranty”.