v1

latestOpenAPI 3.1.12026-07-2371254470.9 KB

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

onlineboolean

Parêmetro indicando se o pedido é de agenda online ou batch. No caso de agenda batch enviaremos os últimos dados que temos de cada agenda. No caso de agenda online faremos um pedido de agenda online para cara registradora envolvida e a resposta será assíncrona.

Request body

listaCnpjCredenciadorastring[] required

documentoUsuarioFinalRecebedorstring 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.

documentoTitularstring

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.

listaCodigoArranjoPagamentostring[] required

Código constante da tabela vigente neste manual.

99T = Usar esta opção para indicar todos os arranjos.

dataIniciostring date required

data início

dataFimstring 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.

participantestring

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.

carteirastring

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

Objeto de retorno de sucesso da consulta

entidadeRegistradorastring

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.

instituicaoCredenciadorastring

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.

documentoUsuarioFinalRecebedorstring

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.