--- title: "Consultar Contrato" method: POST path: "/contrato/consultar" tags: ["Informação e atualização de contrato"] --- # Consultar Contrato `POST /contrato/consultar` ## Request body - ContratoConsultarRequest — Consulta de Contrato - `referenciaExterna` string, required — Código de referência de controle do participante, para identificação. - `identificadorContrato` string, required — Código de identificação do contrato nos controles do Participante. - `tipoAvaliacao` 'avaliacao_agenda_basica_ap' | 'avaliacao_agenda_completa_ap' | 'avaliacao_contrato_basica_ap' | 'avaliacao_contrato_completa_ap' — Tipo de avaliação geradora de indicadores de consistência de acordo com tabela fornecida pela CERC. ## Response `200` Contrato encontrado - ContratoConsultaResponse — observação - Apenas o campo 'referenciaExterna' é obrigatório caso a operação consultada seja do tipo S (simulação de contrato) - `referenciaExterna` string, required — Código de referência de controle do participante, para identificação nas transações futuras. - `identificadorContrato` string, required — Código de identificação do contrato nos controles do Participante. - `carteira` string — Código da carteira à qual o contrato pertence. Caso o campo não seja informado será utilizada a carteira padrão do participante. - `documentoContratante` string, required — CNPJ do Contratante da Dívida. 14 dígitos alfanuméricos para CNPJ e 11 dígitos para CPF e completar com 0 à esquerda, se necessário. - `quantidadeUnidadesRecebiveisAlcancadas` integer, required — Quantidade total de unidades de recebíveis alcançadas pelo contrato. - `valorUnidadesRecebiveisAlcancadas` number, required — Valor total das unidades de recebíveis alcançadas pelo contrato. - `resultadoDistribuicaoOnus` '0' | '1' | '2' | '3', required — Resultado da distribuição dos ônus do contrato pelas unidades de recebíveis, sendo: - 0 = Não se aplica - 1 = Suficiente - 2 = Insuficiente - 3 = Em excesso - `indicadoresConsistencia` IndicadorConsistencia[] - `indicador` string, required — Identificador do indicador de consistência. - `resultado` string, required — Resultado da saída do indicador em formato de texto. - `parametros` object[], required — Lista de parâmetros de saída do indicador. - `chave` string — Identificador do parâmetro - `valor` string — Valor do parâmetro - `criticidade` '0' | '1' | '2' | '3', required — Código que identifica a criticidade do resultado do indicador, sendo: - 0 = Consistente - 1 = Neutro - 2 = Alerta - 3 = Crítico - `repactuacao` '0' | '1', required — Indica se o contrato atual se trata de repactuação, onde: 0 = Não 1 = Sim - `identificacaoContratoAnterior` string — Em caso de contrato de repactuação, indicar o contrato anterior a que faz referência. - `cnpjParticipante` string, required — CNPJ do participante. Sem formatação. - `cnpjDetentor` string, required — CNPJ do detentor do contrato - `tipoEfeito` '1' | '2' | '3' | '4', required — Tipo de efeito sobre as unidades de recebíveis, sendo: 1 = Troca de titularidade; 2 = Ônus - Cessão fiduciária; 3 = Ônus - Outros; 4 = Bloqueio judicial - `domicilioPagamento` DomicilioPagamento, required - `numeroDocumentoTitular` string, required — CPF ou CNPJ do titular da conta bancária ou conta de pagamento. Sem formatação. Preenchidos com 0 à esquerda. - `nomeTitular` string — Nome do titular da conta bancária ou conta de pagamento. - `tipoConta` 'CC' | 'CD' | 'CG' | 'CI' | 'PG' | 'PP', required — Tipo de conta onde o pagamento será liquidado: - CC = Conta Corrente - CD - Conta de Depósito - CG - Conta Garantia - CI - Conta Investimento - PG - Conta de Pagamento - PP - Conta Poupança - `compe` string — Código COMPE da Instituição de Domicílio, complementar com 0 à esquerda. - `ispb` string, required — Número do ISPB da Instituição de Domicílio, complementar com 0 a esquerda - `agencia` string, required — Número da Agência para pagamento. - `numeroConta` string, required — Número da conta bancária, quando o tipo de conta for CC, CD, CG, CI ou PP e; Número da conta de pagamento, quando o tipo de conta for PG. Dígito verificador deve ser separado com hífen (ex. 999999-9). Caso não seja informado o hífen a operação será rejeitada. - `saldoDevedor` number, required — Valor do saldo devedor em reais. - `limiteOperacaoGarantida` number, required — Limite em reais da operação garantida pelas unidades de recebíveis. - `valorMantido` number, required — Valor a ser preenchido se for uma operação de garantia. Valor em reais. - `dataVencimento` string, date, required — Data de vencimento do instrumento contratual. Formato: AAAA-MM-DD - `identificacaoGestaoEntidadeRegistradora` '1' | '2' | '3', required — Indicador da delegação à entidade registradora para efetuar a gestão dos ônus conforme a atualização do conjunto de recebíveis e/ou parâmetros do contrato. Tipos de gestão: 1 = Gestão de entidade registradora; 2 = Gestão do financiador ou não financeira. 3 = Gestão do financiador ou não financeira com monitoramento e alertas pela CERC. - `modalidadeOperacao` '1' | '2' | '3', required — Modalidade da operação, onde: 1 = Rotativo; 2 = Parcelado; 3 = Cessão - `parcelas` object[] — Parcelas do contrato. - `vencimento` string, date, required — Data de vencimento da parcela. - `valor` number, required — Valor em reais da parcela. - `garantiasAlcancadas` GarantiasAlcancadas[], required - `referenciaExterna` string — Código de referência de controle do participante, para identificação nas transações futuras - `definicaoUnidadeRecebivel` DefinicaoUnidadeRecebivelTitular, required — Objeto com a definição de unidade recebível - `listaCnpjCredenciadora` string[], required — CNPJ da instituição credenciadora ou subcredenciadora responsável pela agenda. Sem formatação. Preenchidos com 0 à esquerda. - 99T = Usar esta opção para indicar todos as credenciadoras/sub. - `documentoUsuarioFinalRecebedor` string — CPF ou CNPJ (completo ou raiz) do Usuario final recebedor da UR. Sem formatação. Preenchidos com 0 à esquerda. - `documentoTitular` string — CPF ou CNPJ (completo ou raiz) do Titular da UR. Sem formatação. Preenchidos com 0 à esquerda. - `listaCodigoArranjoPagamento` string[], required — Código constante da tabela vigente neste manual. - 99T = Usar esta opção para indicar todos os arranjos. - `dataInicio` string, date, required — Data Inicio - `dataFim` string, date, required — Data Fim - `regrasDivisao` '1' | '2', required — Critério de comprometimento das unidades de recebíveis, podendo ser: 1 = Comprometimento de valor definido; 2 = Comprometimento de percentual do valor que vier a ser constituído. - `valorAOnerar` number, required — Parâmetro do comprometimento (número percentual ou valor em reais), conforme a regra da divisão contratada. - `unidadesRecebiveisAlcancadas` UnidadesRecebiveisAlcancadas[] - `cnpjCredenciadora` string — CNPJ da instituição credenciadora ou subcredenciadora responsável pela unidade de recebível. Sem formatação. - `tipoDocumentoUsuarioFinalRecebedor` '1' | '2' — Identificador do tipo de documento do usuário final recebedor. - 1 = CPF - 2 = CNPJ - `documentoUsuarioFinalRecebedor` string — CNPJ ou CPF do usuário final recebedor da unidade de recebível alcançada. Sem formatação. - `documentoTitular` string — CNPJ ou CPF do titular da unidade de recebível alcançada. Sem formatação. - `codigoArranjoPagamento` 'ACC' | 'BCC' | 'BCD' | 'CBC' | 'CBD' | 'ECC' | 'ECD' | 'GCC' | 'HCC' | 'JCC' | 'MCC' | 'MCD' | 'OCD' | 'SCC' | 'SCD' | 'VCC' | 'VCD' | 'VDC' | 'HCD' | 'SIC' | 'BRS' | 'MAC' | 'CUP' | 'CZC' | 'FRC' | 'MXC' | 'SFC' | 'TKC' | 'BNC' | 'CCD' | 'BRC' | 'SPC' | 'CSC' | 'DAC' | 'DCC' | 'AGC' | 'AUC' | 'RCC' | 'AVC' | 'DBC' — Código constante da tabela vigente neste manual. Para obter a lista atualizada na base de controle do ambiente de Interoperabilidade, consulte o [Dicionário de domínios de arranjos de pagamento](https://docs.cerc.com/arranjos-de-pagamento/informacoes-gerais/integracao/referencias-tecnicas-para-operacao?q=/bases_controle/arranjos#dicionario-de-dominios-de-arranjos-de-pagamento). - `dataLiquidacao` string, date — Data de liquidação do recebível prevista pelo arranjo de pagamento ou com efeitos da antecipação pré-contratada. Formato: AAAA-MM-DD - `constituicao` '1' | '2' — Tipo da constituição da unidade de recebível, sendo: 1 = Constituída 2 = A constituir - `valorConstituidoTotal` number — Valor constituído total da unidade de recebível. - `valorBloqueado` number — Valor bloqueado para pagamento na unidade de recebível. - `indicadorOneracao` string — Identificador sequencial que indica a prioridade do ônus, sendo: 0 = Insucesso; 1 a N = Prioridade do ônus. - `regrasDivisao` '1' | '2' — Critério de comprometimento das unidades de recebíveis, podendo ser: 1 = Comprometimento de valor definido; 2 = Comprometimento de percentual do valor que vier a ser constituído. - `valorOnerado` number — Parâmetro do comprometimento (número percentual ou valor em reais), conforme a regra da divisão contratada. - `valorConstituidoEfeito` number — Valor calculado pela CERC aplicando o efeito de contrato na Unidade de Recebível. Representa o montante do valor constituído total que foi afetado pelo efeito. ## Other responses - `400` — Dados inválidos - `404` — Contrato não encontrado --- [API](https://skmtc.net/cerc/apis/receb-veis-de-arranjo-de-pagamento-institui-es-financeiras-d.md) · [All operations](https://skmtc.net/cerc/apis/receb-veis-de-arranjo-de-pagamento-institui-es-financeiras-d/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cerc/receb-veis-de-arranjo-de-pagamento-institui-es-financeiras-d/revisions/98997c37ec38/schema)