v1

latestOpenAPI 3.1.12026-07-2371254470.9 KB
Informação e atualização de contrato

Operações envolvendo contratos (CERC-AP007A e CERC-AP007B). A resposta de cada item da requisição será enviada como um evento "contrato", via Webhook.

put/v15/contratos

Request body

tipoOperacao'C' | 'A' | 'I' | 'B' | 'S' | 'P' | 'R' required

Identifica o tipo de operação correspondente àquela entrada, sendo::

  • C = Criar contrato;
  • A = Atualizar contrato;
  • I = Inativar contrato;
  • B = Baixar contrado;
  • S = Simular contrato;
  • P = Resilição parcial;
  • R = Resilição total.
referenciaExternastring required

Código de referência único (exclusivo), de controle do participante, para identificação nas transações futuras. [Não atualizável]

identificadorContratostring required

Código de identificação do contrato nos controles do Participante. Em caso de bloqueio judicial informar o código do processo judicial.

documentoContratantestring 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. [Não atualizável]

repactuacao'0' | '1' required

Indica se o contrato atual se trata de repactuação, onde: 0 = Não 1 = Sim

identificacaoContratosAnterioresstring[]

Em caso de contrato de repactuação, indicar os contratos anteriores a que faz referência a repactuação.

cnpjParticipantestring required

CNPJ do participante. 14 dígitos alfanuméricos para CNPJ e 11 dígitos para CPF e completar com 0 à esquerda, se necessário. [Não atualizável]

cnpjDetentorstring required

CNPJ do detentor do contrato. 14 dígitos alfanuméricos para CNPJ e 11 dígitos para CPF e completar com 0 à esquerda, se necessário.

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

saldoDevedornumber required

Valor do saldo devedor em reais se operação de garantia ou valor presente em reais se operação de desconto (cessão).

limiteOperacaoGarantidanumber required

Limite em reais da operação garantida pelas unidades de recebíveis

valorMantidonumber required

Valor mínimo a ser mantido se operação de garantia ou valor futuro em reais se operação de desconto (cessão). Valor em reais.

dataAssinaturastring date required

Data da assinatura do contrato. Formato: AAAA-MM-DD

dataVencimentostring 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

carteirastring

Código da carteira à qual o contrato pertence. Caso o campo não seja informado será utilizada a carteira padrão 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.

taxaJurosnumber

Valor expresso em Taxa Anual (a.a.) com duas casas decimais. O campo deverá ser preenchido quando se tratar de contrato associado ao Programa Emergencial de Acesso a Crédito (PEAC). (20.53 para indicar 20.53% a.a)

indexador'1' | '2' | '3' | '4' | '5' | '6' | '7' | '8'

Indexador da operação: (O campo deverá ser preenchido como Taxa Prefixada quando se tratar de contrato associado ao Programa Emergencial de Acesso a Crédito (PEAC).) 1 = Taxa Prefixada; 2 = Taxa Selic; 3 = Taxa DI; 4 = IPCA; 5 = IGPM; 6 = Moeda Dólar; 7 = Moeda Euro; 8 = Outros.

aceiteIncondicional'1' | '2'

Critério de aceite do contrato, podendo ser: 1 = Aceitar; 2 = Recusar.

Response

Registro de contratos recebido, será enviado um webhook para a URL do participante uma vez que o contrato for processado. Necessário consultar individualmente cada item para obter o status de processamento.

referenciaExternastring

Código de referência único (exclusivo), de controle do participante, para identificação nas próximas consultas relacionadas

protocolostring

GUID ID de Protocolo gerado pela CERC, confirmando o recebimento da requisição.

quantidadeUnidadesRecebiveisAlcancadasinteger

Quantidade total de unidades de recebíveis alcançadas pelo contrato.

valorUnidadesRecebiveisAlcancadasnumber

Valor total das unidades de recebíveis alcançadas pelo contrato.

resultadoDistribuicaoOnus'0' | '1' | '2' | '3'

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
idDoContratostring

Identificador do contrato que foi registrado na CERC

dataHoraProcessamentostring date-time

Data/hora da requisição

statusstring

Código 0 em caso de sucesso