---
title: "Consultar informações de agenda por força de um contrato ou opt-in (CERC-AP005)"
method: POST
path: "/v15/agenda/consultar"
tags: ["Consulta de informações de agenda"]
---

# Consultar informações de agenda por força de um contrato ou opt-in (CERC-AP005)

`POST /v15/agenda/consultar`

## Query parameters

- `online` boolean

## Request body

- ConsultarV15AgendaRequest
  - `listaCnpjCredenciadora` string[], required
  - `documentoUsuarioFinalRecebedor` string, required — CPF ou CNPJ do Usuário final recebedor da UR. 14 dígitos alfanuméricos para CNPJ e 11 dígitos para CPF e completar com 0 à esquerda, se necessário.
  - `documentoTitular` string — CPF ou CNPJ do Titular da UR. 14 dígitos alfanuméricos para CNPJ e 11 dígitos para CPF e completar com 0 à esquerda, se necessário.
  - `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 início
  - `dataFim` string, date, required — data fim
  - `tipoAvaliacao` 'avaliacao_agenda_basica_ap' | 'avaliacao_agenda_completa_ap' — Tipo de avaliação geradora de indicadores de consistência de acordo com tabela fornecida pela CERC.
  - `participante` string — CNPJ do agente de registro/administrador que será responsável pelo faturamento da operação. É o administrador legal da carteira informada. 14 dígitos alfanuméricos para CNPJ.
  - `carteira` string — Identificador da carteira à qual o contrato pertence. Caso o campo não seja informado será utilizada a carteira padrão do participante. Obrigatório e atualizável caso a empresa seja do tipo "Prestador de Serviço".

## Response `200`

Objeto de retorno de sucesso da consulta

- object[]
  - `entidadeRegistradora` string — CNPJ da entidade registradora onde a agenda está registrada. 14 dígitos para CNPJ e 11 dígitos para CPF e completar com 0 à esquerda, se necessário.
  - `instituicaoCredenciadora` string — CNPJ da instituição credenciadora ou subcredenciadora responsável pela agenda. 14 dígitos alfanuméricos para CNPJ e 11 dígitos para CPF e completar com 0 à esquerda, se necessário.
  - `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).
  - `documentoUsuarioFinalRecebedor` string — CPF ou CNPJ do usuário final recebedor. 14 dígitos alfanuméricos para CNPJ e 11 dígitos para CPF e completar com 0 à esquerda, se necessário.
  - `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
  - `unidadesRecebiveis` object[]
    - `dataLiquidacao` string, date — Data de liquidação do recebível prevista pelo arranjo de pagamento ou com efeitos de pré-contratada.
    - `constituicao` '1' | '2' — Tipo da constituição da unidade de recebível, sendo: 1 = Constituída 2 = A constituir
    - `valorConstituidoTotal` number — Valor (em reais) constituído total, líquido, a pagar pela instituição credenciadora ou subcredenciadora da UR.
    - `valorConstituidoAntecipacaoPre` number — Valor (em reais) constituído total, líquido, a pagar pela instituição credenciadora ou subcredenciadora oriundo de pré-contratada da UR.
    - `valorBloqueado` number — Valor bloqueado para pagamento na unidade de recebível da UR.
    - `valorLivre` number — Valor livre da UR.
    - `valorTotalUR` number — Valor total da UR, a ser utilizado como base no cálculo dos efeitos de contrato. Equivale à soma dos valores de todas as frações de URs com o mesmo usuário final Recebedor, independente do titular.
    - `dataHoraUltimaAtualizacao` string, date-time — Data da última atualização da UR.
    - `pagamentos` object[]
      - `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 comprometido por contratos), conforme a regra da divisão contratada.
      - `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.
      - `valorAPagar` number — Valor previsto a ser pago pela credenciadora.
      - `beneficiario` string — CNPJ do beneficiário em decorrência do contrato, para o tipo de efeito ônus. Sem formatação. 14 dígitos alfanuméricos para CNPJ e 11 dígitos para CPF e completar com 0 à esquerda, se necessário.
      - `dataLiquidacaoEfetiva` string, date — Data do efetivo pagamento, no formato YYYY-MM-DD. Obrigatório em caso de baixa.
      - `valorLiquidacaoEfetiva` number — Valor final pago pela Instituição Credenciadora ou Subcredenciadora. Obrigatório em caso de baixa.
      - `motivoDeNaoPagamento` '001' | '002' | '999' — Tipo de conta onde o pagamento será liquidado: - 001 = Dados bancários inválidos. - 002 - Liquidação bloqueada. - 999 - Outros motivos
      - `tipoInformacaoPagamento` '1' | '2' | '3' | '4' | '5' | '6' | '7' — 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 - 5 = Antecipação Pós-contratada - 6 = Liquidação - 7 = Domicílio de pagamento
      - `indicadorEfeitosContrato` string — Valor sequencial do item do conjunto de efeitos de contratos existentes sobre a unidade de recebíveis, dada a possibilidade de coexistência de mais de um ônus sobre a mesma unidade de recebível, considerada a regra de divisão.
      - `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.
    - `titulares` object[]
      - `documentoTitular` string — CNPJ do Titular da UR. 14 dígitos alfanuméricos para CNPJ e 11 dígitos para CPF e completar com 0 à esquerda, se necessário.
      - `valorConstituidoTotal` number — Valor (em reais) constituído total, líquido, a pagar pela instituição credenciadora ou subcredenciadora para a fração da UR correspondente a esse titular.
      - `valorConstituidoAntecipacaoPre` number — Valor (em reais) constituído total, líquido, a pagar pela instituição credenciadora ou subcredenciadora oriundo de pré-contratada para a fração da UR correspondente a esse titular.
      - `valorBloqueado` number — Valor bloqueado para pagamento na unidade de recebível para a fração da UR correspondente a esse titular.
      - `valorLivre` number — Valor livre da fração da UR correspondente a esse titular.
      - `dataHoraUltimaAtualizacao` string, date-time — Data da última atualização da fração da UR correspondente a esse titular.
      - `pagamentos` object[]
        - `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 comprometido por contratos), conforme a regra da divisão contratada.
        - `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.
        - `valorAPagar` number — Valor previsto a ser pago pela credenciadora.
        - `beneficiario` string — CNPJ do beneficiário em decorrência do contrato, para o tipo de efeito ônus. Sem formatação. 14 dígitos alfanuméricos para CNPJ e 11 dígitos para CPF e completar com 0 à esquerda, se necessário.
        - `dataLiquidacaoEfetiva` string, date — Data do efetivo pagamento, no formato YYYY-MM-DD. Obrigatório em caso de baixa.
        - `valorLiquidacaoEfetiva` number — Valor final pago pela Instituição Credenciadora ou Subcredenciadora. Obrigatório em caso de baixa.
        - `motivoDeNaoPagamento` '001' | '002' | '999' — Tipo de conta onde o pagamento será liquidado: - 001 = Dados bancários inválidos. - 002 - Liquidação bloqueada. - 999 - Outros motivos
        - `tipoInformacaoPagamento` '1' | '2' | '3' | '4' | '5' | '6' | '7' — 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 - 5 = Antecipação Pós-contratada - 6 = Liquidação - 7 = Domicílio de pagamento
        - `indicadorEfeitosContrato` string — Valor sequencial do item do conjunto de efeitos de contratos existentes sobre a unidade de recebíveis, dada a possibilidade de coexistência de mais de um ônus sobre a mesma unidade de recebível, considerada a regra de divisão.
        - `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` — Tabela de Erros |CÓDIGO|DESCRIÇÃO | |------|-------------------------------------------------------------------------------| |105001|NAO FORAM ENCONTRADOS REGISTROS COM OS FILTROS ESPECIFICADOS NO OPT-IN/CONTRATO| |105002|USUARIO FINAL RECEBEDOR OU TITULAR NAO ENCONTRADOS | |105003|FALHA NA COMUNICACAO COM ENTIDADE REGISTRADORA RESPONSAVEL PELO REGISTRO | |105999|ERRO INESPERADO |

---

[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)