Central de Recebíveis

Webhook
Instituição Credenciadora

Arranjo de Pagamento

Versão 1.5
21 de abril de 2021
ALTERAÇÕES DA VERSÃO 1.5
I. Suporte ao envio de webhooks em lista
● Melhorias relacionadas ao envio de eventos. Agora o participante recebe as
notificações em listas separadas por evento, podendo receber até 100 eventos
em uma única requisição.
● Para que o participante receba os eventos em lista será necessário que escolha a
utilização da versão 1.5 do webhook, descrito na seção DEFINIÇÕES GERAIS.

II. Inclusão de novos eventos no webhook

● Inclusão dos Leiautes
○ CERC-AP002
■ As operações envolvendo o AP002 via API no endpoint assíncrono
terão o seu envio da resposta via webhook
○ CERC-AP007
■ As operações envolvendo o AP007 via API no endpoint assíncrono
terão o seu envio da resposta via webhook
○ CERC-AP005
■ A consulta de agenda online, terá o recebimento das agendas de
URs via webhook
○ CERC-AP020
■ Permitir que os Participantes sejam informados da abertura e
fechamento das janelas de processamento do ambiente de
registro de unidades de recebíveis em arranjos de pagamentos.

III. Inclusão de novos campos

● Efeito de contrato
○ O campo “Identificador do contrato”
○ O campo “Identificador do contrato gerador do evento” é o identificador
de contrato que gerou o evento que está sendo notificado para o
participante.
○ O campo "referência externa da unidade de recebível", código de
referência único (exclusivo) de controle do participante

A utilização da versão 1.5 do webhook é opcional e a versão 1.4.2 pode continuar sendo
utilizada.

Versão 1.5, de 21 de abril de 2021 - Informação Restrita 2

APRESENTAÇÃO
Objetivo
Definição dos detalhes da integração com o sistema de Webhook para Instituições
Credenciadoras da CERC.
A interface descrita neste documento é restrita aos testes iniciais, entendimento do fluxo
operacional e conectividade pelas instituições credenciadoras no âmbito do Sistema CERC.

Propósito da CERC
A CERC Central de Recebíveis S.A. é uma entidade registradora autorizada pelo BCB, que presta
serviços de Avaliação e Registro de ativos financeiros, inclusive recebíveis de arranjo de
pagamento.

Participantes
São Agentes de Registro com Direito de Acesso ao Sistema CERC e Prestadores de Serviços por
eles indicados e devidamente cadastrados no sistema CERC.

Usuários
São considerados usuários todos os representantes de Participantes, devidamente cadastrados
e com acesso ao Sistema CERC.

Divulgação e vigência deste manual

Este manual é de acesso restrito aos usuários do Sistema CERC e a versão corrente está
disponível no Portal CERC.

Contato
Favor entrar em contato nos casos de dúvidas ou considerações sobre as informações contidas
neste enviando uma mensagem para o e-mail suporte-operacoes@cerc.inf.br utilizando o
assunto “manual”. Agradecemos antecipadamente a sua colaboração para tornar nossa
documentação e nossos serviços melhores.

Versão 1.5, de 21 de abril de 2021 - Informação Restrita 3

ÍNDICE
APRESENTAÇÃO 3
Objetivo 3
Propósito da CERC 3
Participantes 3
Usuários 3
Divulgação e vigência deste manual 3
Contato 3

DEFINIÇÕES GERAIS 5

DEFINIÇÃO DA API PARA WEBHOOK 6

Estrutura da API 6
Tipos de Eventos 6

EVENTOS 7
Efeito de Contrato 7
Recebimento de contestação 10
Informação de Notificação 13
Retorno de operações envolvendo unidades de recebíveis 17
Retorno de operações envolvendo contratos 18
Consulta de agenda 23
Abertura/fechamento da janela de processamento 27

Versão 1.5, de 21 de abril de 2021 - Informação Restrita 4

DEFINIÇÕES GERAIS
O propósito deste documento, é definir o leiaute da API a ser implementada pelo participante, a
fim de que a CERC possa informar em tempo real a ocorrência de um novo evento.

A cada novo evento, o sistema envia um HTTPS POST para a URL configurada, com informações
sobre efeitos de contratos aplicáveis à unidades de recebíveis, contestações, entre outros. Desta
maneira, o seu sistema, ao receber essa notificação, pode tratá-la adequada e
tempestivamente.

Os eventos serão notificados a partir de webhooks enviados para a URL cadastrada pelo
participante.

Para escolher usar a versão 1.5 do webhook, descrita neste manual, o participante deve
informar a URL com a identificação “/v15/”. Exemplo:

https://{URL_AMBIENTE}/v15/{endpoint}

Caso a identificação não seja informada, as notificações seguirão as definições da versão 1.4.2
do manual de Webhook.

Versão 1.5, de 21 de abril de 2021 - Informação Restrita 5

DEFINIÇÃO DA API PARA WEBHOOK

Estrutura da API

Atributo Formato Regra Observação

Identificador do tipo de evento, constante da

tipoEvento Alfa Obrigatório
tabela Tipos de Eventos neste manual.
dataHoraEvento Alfa Obrigatório Data no formato RFC3339
Especificado de acordo com o campo
evento Objeto Obrigatório
tipoEvento

Tipos de Eventos

Identificador Evento Descrição

Inclusão/Alteração de um efeito de contrato aplicável a uma

efeitoContrato Efeito de Contrato
unidade de recebível, para fins de liquidação

Informação da contestação de uma transação efetuada pelo

contestacao Contestação
participante.

notificacao Notificação Informação de notificação para o participante

Unidades de
unidadeRecebivel Operações com Unidades de Recebíveis
Recebíveis

contrato Contrato Operações envolvendo contratos

Consulta de agenda Consulta de informações de agenda por força de contrato ou

agenda
online opt-in
Abertura/Fechamento
Abertura e fechamento das janelas de processamento do
janelaProcessamento de janela de
ambiente de registro
processamento

Versão 1.5, de 21 de abril de 2021 - Informação Restrita 6

EVENTOS

Efeito de Contrato

Descrição

Permitir que o participante obtenham as devidas informações detalhadas sobre a situação das
unidades de recebíveis registradas, e assim proceder com a liquidação financeira aderente com
a situação das trocas de titularidades e constituição de ônus decorrentes de contratos. Esse
item se relaciona ao processo 5.12 da convenção referente a Circular do BCB nº 3.952, de 27 de
junho de 2019.

● Emissor: CERC
● Destinatário: Participante
● Tipo de transmissão: Webhook
● Formato: JSON
● Periodicidade: A cada novo efeito de contrato que afete as unidades de recebíveis
registradas

Definição de Leiaute

Campo Formato Regra Observação

CNPJ da instituição credenciadora ou

cnpjCredenciadora Alfa Obrigatório subcredenciadora responsável pelos
reflexos. Sem formatação.
Obrigatório Tipo da constituição da unidade de
Opções recebível, sendo:
constituicaoUnidadeRecebivel Alfa aceitas:
● 1 = Constituída
● 1
● 2 ● 2 = A constituir

documentoUsuarioFinalRecebedor Alfa Obrigatório CNPJ ou CPF do usuário final recebedor.

Código identificador do arranjo de

codigoArranjoPagamento
dataLiquidacao
documentoTitular
identificadorContratoGeradorEvento
referenciaExternaUnidadeRecebivel
Alfa Obrigatório pagamento, constante da tabela de
dicionário de domínio neste manual.
Data de liquidação do recebível prevista
pelo arranjo de pagamento ou com
Data Obrigatório
efeitos de pré-contratada. Formato:
AAAA-MM-DD
CNPJ ou CPF do Titular da unidade de
Alfa Obrigatório
recebível.
Identificador CERC do contrato que
Alfa (max.100) Obrigatório
gerou a notificação do evento.
Obrigatório, Código de referência único (exclusivo)
Alfa caso de controle do participante, para
constituicao

Versão 1.5, de 21 de abril de 2021 - Informação Restrita 7

 UnidadeRec identificação nas próximas transações
ebivel = 1 futuras, utilizado no registro da UR.
efeitosContrato - Lista de efeitos de contrato sobre a unidade de recebível
Identificador CERC do contrato
identificadorContrato Alfa (max.100) Obrigatório
correspondente ao efeito.
Alfa (max. Protocolo para identificação do efeito
Protocolo Obrigatório
100) de contrato.
Valor sequencial do item do conjunto
de efeitos de contratos existentes sobre
a unidade de recebíveis, dada a
indicadorEfeitosContrato Alfa Obrigatório possibilidade de coexistência de mais
de um ônus sobre a mesma unidade de
recebível, considerada a regra de
divisão.
CNPJ da entidade registradora que
instruiu o efeito decorrente do
cnpjEntidadeRegistradora Alfa Obrigatório
contrato.
Sem formatação.
Obrigatório Indicador do tipo de efeito decorrente
Opções do contrato. Podendo ser:
aceitas: ● 1 = Troca de titularidade;
tipoEfeito Alfa ● 1 ● 2 = Ônus - Cessão fiduciária;
● 2 ● 3 = Ônus - Outros;
● 3 ● 4 = Bloqueio judicial
● 4
Critério de comprometimento das
Obrigatório unidades de recebíveis, podendo ser:
Opções ● 1 = Comprometimento de
regraDivisao Alfa aceitas: valor definido;
● 1 ● 2 = Comprometimento de
● 2 percentual do valor que vier a
ser constituído.
CNPJ do beneficiário ou titular em
cnpjBeneficiarioTitular Alfa Obrigatório decorrência do contrato.
Sem formatação.
valorComprometido Parâmetro do comprometimento
Decimal Obrigatório (número percentual ou valor em reais),
conforme a regra da divisão contratada.
domicilioPagamento - Domicílio de Pagamento
CPF ou CNPJ do titular da conta
documentoTitularDomicilio Alfa Obrigatório bancária ou conta de pagamento.
Sem formatação.
Nome do titular da conta bancária ou
nomeTitularDomicilio Alfa Opcional conta de pagamento.
Sem formatação.
Obrigatório Tipo de conta onde o pagamento será
tipoConta Alfa Opções liquidado:
aceitas: ● CC = Conta Corrente;

Versão 1.5, de 21 de abril de 2021 - Informação Restrita 8

 ● CC ● CD - Conta de Depósito;
● CD ● PG - Conta de Pagamento;
● PG ● PP - Conta Poupança.
● PP
Código COMPE da Instituição de
compe Numérico (3) Opcional Domicílio, complementar com 0 à
esquerda.
Número do ISPB da Instituição de
ispb Numérico (8) Obrigatório Domicílio, complementar com 0 à
esquerda.
Número da Agência para pagamento,
agencia Alfa Obrigatório quando o tipo de conta for diferente de
PG.
Número da conta bancária, quando o
tipo de conta for CC, CD ou PP ou
numeroConta Alfa Obrigatório
Número da conta de pagamento,
quando o tipo de conta for PG.

Exemplo:

[
{
"tipoEvento": "efeitoContrato",
"dataHoraEvento": "2021-01-05T04:07:02.830Z",
"evento": {
"referenciaExternaUnidadeRecebivel": "ref_ur1",
"cnpjCredenciadora": "08561701000101",
"constituicaoUnidadeRecebivel": "2",
"identificadorContratoGeradorEvento": "341e9640-48a0-4756-ab76-7e3b08161316",
"documentoUsuarioFinalRecebedor": "42889916090",
"codigoArranjoPagamento": "VCD",
"dataLiquidacao": "2022-09-22",
"documentoTitular": "42889916090",
"efeitosContrato": [
{
"protocolo": "d38d3e02-5b08-40bc-a880-1cc89ac0d40f",
"indicadorEfeitosContrato": "1",
"cnpjEntidadeRegistradora": "23399607000191",
"tipoEfeito": "3",
"regraDivisao": "1",
"cnpjBeneficiarioTitular": "10264663000177",
"valorComprometido": "900.0",
"identificadorContrato": "341e9640-48a0-4756-ab76-7e3b08161316",
"domicilioPagamento": {
"documentoTitularDomicilio": "42889916090",
"nomeTitularDomicilio": "João dos Santos",

Versão 1.5, de 21 de abril de 2021 - Informação Restrita 9

 "tipoConta": "CC",
"compe": "341",
"ispb": "60701190",
"agencia": "0910",
"numeroConta": "093973"
}
}
]
}
}
]

Versão 1.5, de 21 de abril de 2021 - Informação Restrita 10

Recebimento de contestação
Descrição

Receber informação da contestação de uma transação efetuada pelo participante.

Campo Formato Regra Observação

Código da referência externa a qual a contestação

referenciaExterna Alfa Obrigatório
se refere.
Obrigatório Tipo de contestante, sendo:
Opções aceitas: ● 1 = Estabelecimento comercial
tipoContestante Alfa ● 1 ● 2 = Instituição financeira ou não financeira
● 2 ● 3 = Instituição credenciadora ou
● 3 subcredenciadora
CNPJ do participante contestante ou recebedor da
contestação (quando o contestante for o usuário
documentoContestante
Alfa Obrigatório final recebedor).
OuRecebedora
Sem formatação. Completar com 0 à esquerda, se
necessário.
Código do motivo da contestação.
motivoContestacao Alfa Obrigatório
Ver tabela neste manual.
Alfa (max.
descricao Opcional Observação adicional informada pelo contestante.
2000)

documentoUsuarioFinal Documento do Usuário Final Recebedor ou Titular.

Alfa Obrigatório Formato: 14 dígitos para CNPJ e 11 dígitos para
RecebedorOuTitular
CPF.

identificadorOperacaoO
Alfa Obrigatório Identificador do objeto da Contestação.
uContrato

Obrigatório
Tipo do objeto da Contestação, podendo ser:
Opções aceitas:
tipoContestacao Alfa ● 1 = Opt-in;
● 1
● 2 = Contrato.
● 2

Exemplo de notificação:
[
{
"tipoEvento": "contestacao",
"dataHoraEvento": "2020-01-30T18:58:36.087Z",
"evento": {
"referenciaExterna": "39ed6e2e-7a76-4ed4-ab5e-7922162dff63",
"tipoContestante": "1",
"documentoContestanteOuRecebedora": "10264663000177",
"motivoContestacao": "01",
"descricao": "O usuário final recebedor não reconhece opt-in cadastrado",

Versão 1.5, de 21 de abril de 2021 - Informação Restrita 11

 "documentoUsuarioFinalRecebedorOuTitular": "42889916090",
"identificadorOperacaoOuContrato": "341e9640-48a0-4756-ab76-7e3b08161316",
"tipoContestacao": "1"
}
}
]

Versão 1.5, de 21 de abril de 2021 - Informação Restrita 12

Informação de Notificação
Descrição

Receber informação de notificação.

Leiaute

Formato Regra Observação

Campo
Documento identificador da entidade
registradoraOrigem Alfa(14) Obrigatório registradora que está encaminhando a
comunicação.

Obrigatório Código identificador do tipo da comunicação,

Opções aceitas: podendo ser:
● 1 ● 1 = Realização de Pós-Contratada
tipoComunicacao Alfa(1)
● 2 ● 2 = Realização de Opt-in
● 3 ● 3 = Realização de Opt-out
● 4 ● 4 = Aplicação de efeitos de Contrato
Código de identificação da Pós-Contratada,
identficadorTransacaoOrigem Alfa Obrigatório do Opt-in, do Opt-out ou do Contrato, que
deu origem à notificação.
Dados que permitam o encaminhamento de
Obrigatório
ações a partir da comunicação, podendo ser:
Opções aceitas:
● 1 = Usuário Final Recebedor ou
dadosReferencia Data ● 1
Titular
● 2
● 2 = Agendas ou URs
● 3
● 3 = Financiador ou Não-Financeira
descricao (quando tipoComunicacao = 1)
Data de liquidação do recebível prevista pelo
arranjo de pagamento ou com os efeitos de
dataLiquidacaoPrevista Data Obrigatório
pré-contratada.
Formato: AAAA-MM-DD
titular Alfa(14) Obrigatório CNP ou CPF do titular da UR.
CPF ou CNPJ do usuário final recebedor,
titular da conta bancária ou da conta de
usuarioFinalRecebedor Alfa(14) Obrigatório pagamento. Sem formatação. Preencher até
11 caracteres para CPF ou 14 caracteres com
CNPJ, sempre com os 0 à esquerda.
CNPJ da Instituição Credenciadora ou
documentoCredenciadora Alfa(14) Obrigatório Subcredenciadora Participante. Formato: 14
dígitos para CNPJ.
Código identificador do arranjo de
codigoArranjoPagamento Alfa(3) Obrigatório pagamento, constante da tabela de
dicionário de domínio neste manual.

Versão 1.5, de 21 de abril de 2021 - Informação Restrita 13

 Data de liquidação efetiva da antecipação.
dataLiquidacaoEfetiva Data Obrigatório
Formato: AAAA-MM-DD
Valor final a ser pago pela instituição
valorAntecipado Decimal(13,2) Obrigatório credenciadora ou subcredenciadora, em
reais.
CPF ou CNPJ do titular da conta bancária ou
conta de pagamento.
documentoTitularConta Alfa(14) Obrigatório Formatação. Preencher até 11 caracteres
para CPF ou 14 caracteres com CNPJ,
completar com 0 à esquerda, se necessário.
Obrigatório Tipo de conta onde o pagamento será
Opções aceitas: liquidado:
● CC ● CC = Conta Corrente;
tipoConta Alfa(2)
● CD ● CD - Conta de Depósito;
● PG ● PG - Conta de Pagamento;
● PP ● PP - Conta Poupança.
Número do ISPB da Instituição de Domicílio.
ispb Alfa(8) Obrigatório
Complementar com 0 à esquerda.
Obrigatório, se
Número da Agência para pagamento.
agencia Alfa(16) Tipo de Conta
Formato: sem dígito verificador.
diferente de PG
Número da conta bancária, quando o tipo de
conta for CC, CD ou PP e,
Número da conta de pagamento, quando o
numeroConta Alfa(20) Obrigatório
tipo de conta for PG.
Formato: incluir o dígito verificador. Quando
alfa, substituir por 0.
valorPago Decimal(13,2) Obrigatório Valor liquidado antecipado.

descricao (quando tipoComunicacao = 2 e 3)

CNPJ do solicitante. Formato: 14 dígitos para
documentoSolicitante Alfa(14) Obrigatório CNPJ e completar com 0 à esquerda, se
necessário.
CNPJ do financiador ou não financeira
documentoFinanciador Alfa(14) Opcional
autorizado.
CNPJ (completo ou raiz) ou CPF do Usuário
Obrigatório, se
Final Recebedor que originou a UR.
campo titular
usuarioFinalRecebedor Alfa(14) Formato: 14 dígitos para CNPJ e 11 dígitos
vazio. Opcional
para CPF e completar com 0 à esquerda, se
caso contrário.
necessário.
Código identificador do arranjo de
pagamento, constante da tabela de
Obrigatório
dicionário de domínio neste manual.
Opções aceitas:
99T = Usar esta opção para indicar todos os
● 99T
codigoArranjoPagamento Lista(Alfa(3)) arranjos
● 99C
99C = Todos os arranjos modalidade crédito
● 99D
99D = Todos os arranjos modalidade débito
● Lista
Para envio de Lista usar o separador ‘|’, com
conteúdo entre aspas. Ex: “VCC|MCC”

Versão 1.5, de 21 de abril de 2021 - Informação Restrita 14

 Obrigatório, se CNPJ (completo ou raiz) ou CPF do Titular da
campo UR.
titular Alfa(14) usuraioFinalRecebe Formato: 14 dígitos para CNPJ e 11 dígitos
dor vazio. Opcional para CPF e completar com 0 à esquerda, se
caso contrário. necessário.
Data em que foi concedida a autorização
dataAssinatura Data Obrigatório pelo Usuário Final Recebedor ou Titular, no
formato AAAA-MM-DD
Data do início da consulta no formato
dataInicio Data Obrigatório
AAAA-MM-DD
Data do fim da consulta no formato
dataFim Data Opcional
AAAA-MM-DD
descricao (quando tipoComunicacao = 4)
Código único de identificação do contrato
identificadorContratoCERC Alfa(36) Obrigatório
junto a entidade registradora.
Código de identificação do contrato nos
identificadorContratoFinan controles do Participante.Em caso de
Alfa(256) Opcional
ciador bloqueio judicial, trata-se do código do
processo judicial.
CPF/CNPJ do Contratante da Dívida,
documento pagador da dívida.
documentoContratante Alfa(14) Obrigatório Formato: 14 dígitos para CNPJ e 11 dígitos
para CPF e completar com 0 à esquerda, se
necessário.
CNPJ do detentor do contrato.Formato: 14
documentoDetentor Alfa(14) Obrigatório dígitos para CNPJ e completar com 0 à
esquerda, se necessário.
Obrigatório Tipo de efeito sobre as unidades de
Opções aceitas: recebíveis, sendo:
● 1 ● 1 = Troca de titularidade;
tipoEfeito Alfa(1)
● 2 ● 2 = Ônus - Cessão fiduciária;
● 3 ● 3 = Ônus - Outros;
● 4 ● 4 = Bloqueio judicial
dataAssinatura Data Obrigatório Data da assinatura do contrato.
Data de vencimento do instrumento
dataVencimento Data Obrigatório contratual.
Formato: AAAA-MM-DD

Exemplo de notificação:

[
{
"tipoEvento": "notificacao",
"dataHoraEvento": "2020-01-30T18:58:36.087Z",
"evento": {

Versão 1.5, de 21 de abril de 2021 - Informação Restrita 15

 "registradoraOrigem": "23399607000191",
"tipoComunicacao": "2",
"identificadorTransacaoOrigem": "6ec4d8b3-c2fa-44a2-9d81-49f256d2a81b",
"dadosReferencia": "1",
"descricao" {
"solicitante": "10264663000177",
"usuarioFinalRecebedor": "42889916090",
"titular": "42889916090",
"dataAssinatura": "2020-01-30",
"dataInicio": "2020-01-30",
"dataFim": "2020-03-30",
}
}
}
]

Versão 1.5, de 21 de abril de 2021 - Informação Restrita 16

Retorno de operações envolvendo unidades de recebíveis
Descrição

Receber informação do status envolvendo o status das unidades de recebíveis

Leiaute

Formato Regra Observação

Campo
Código de referência de controle do
referenciaExterna Alfa Opcional participante, para identificação nas próximas
consultas relacionadas

Código identificador do status da resposta

status Alfa Obrigatório ● 0 = Operação realizada com sucesso
● 1 = Falha na operação
GUID ID de Protocolo gerado pela CERC,
protocolo Alfa Obrigatório
confirmando o recebimento da requisição
Data/hora da requisição
dataHoraProcessamento Data Obrigatório

erros - Lista de erros

codigo Alfa Obrigatório Código do erro - Consultar Tabela de Erro

mensagem Alfa Obrigatório Descrição do erro - Consultar Tabela de Erro

Exemplo de notificação:

[
{
"tipoEvento": "unidadeRecebivel",
"dataHoraEvento": "2020-01-30T18:58:36.087Z",
"evento": {
"referenciaExterna": "",
"protocolo": "d0a52985-1cfc-4c45-92c4-574d87f13163",
"dataHoraProcessamento": "2021-01-09T23:45:09.353Z",
"status": "0",
"erros": []
}
}
]

Versão 1.5, de 21 de abril de 2021 - Informação Restrita 17

 Retorno de operações envolvendo contratos
Descrição

Receber informação do status envolvendo contratos

Leiaute

Campo Formato Regra Observação

Código de referência de controle do

referenciaExterna Alfa Opcional participante, para identificação nas próximas
consultas relacionadas
Código identificador do status da resposta
Alfa Obrigatório ● 0 = Operação realizada com sucesso
status
● 1 = Falha na operação

GUID ID de Protocolo gerado pela CERC,

Alfa Obrigatório
protocolo confirmando o recebimento da requisição

Data/hora da requisição
Data Obrigatório
dataHoraProcessamento

Obrigatório, Quantidade total de unidades de recebíveis

Numérico em caso de alcançadas pelo contrato.
quantidadeUnidadesRecebiveisAlcancadas
Sucesso
Obrigatório, Valor total das unidades de recebíveis
Decimal em caso de alcançadas pelo contrato.
valorUnidadesRecebiveisAlcancadas
Sucesso
Resultado da distribuição dos ônus do contrato
pelas unidades de recebíveis, sendo:
Obrigatório,
● 0 = Não se aplica
Alfa em caso de
resultadoDistribuicaoOnus ● 1 = Suficiente
Sucesso
● 2 = Insuficiente
● 3 = Em excesso

garantiasAlcancadas - Garantias alcançadas (Obrigatório em caso de Sucesso)

Código de referência de controle do

referenciaExterna Alfa Obrigatório participante, para identificação nas transações
futuras
Critério de comprometimento das unidades de
recebíveis, podendo ser:
● 1 = Comprometimento de valor
regrasDivisao Alfa Obrigatório
definido;
● 2 = Comprometimento de percentual
do valor que vier a ser constituído.
Parâmetro do comprometimento (número
valorAOnerar Decimal Obrigatório percentual ou valor em reais), conforme a
regra da divisão contratada.

Versão 1.5, de 21 de abril de 2021 - Informação Restrita 18

 definicaoUnidadeRecebivel - Definição da unidade de recebível

CPF ou CNPJ do usuário final recebedor da UR.

documentoUsuarioFinalRecebedor Alfa Obrigatório
Sem formatação.

documentoTitular Alfa Obrigatório CPF ou CNPJ do Titular da UR. Sem formatação.

dataInicio Data Obrigatório Data Início

Data Fim
dataFim Data Obrigatório

CNPJ da instituição credenciadora ou

listaCnpjCredenciadora Lista(Alfa) Obrigatório subcredenciadora responsável pela agenda.
Sem formatação.

listaCodigoArranjoPagamento Lista(Alfa) Obrigatório Código constante da tabela.

unidadesRecebiveisAlcancadas - Lista de unidade de recebíveis alcançadas

CNPJ da instituição credenciadora ou

Alfa Obrigatório subcredenciadora responsável pela unidade de
cnpjCredenciadora
recebível
Identificador do tipo de documento do usuário
final recebedor.
Alfa Obrigatório ● 1 = CPF
tipoDocumentoUsuarioFinalRecebedor
● 2 = CNPJ

CNPJ ou CPF do usuário final recebedor da

documentoUsuarioFinalRecebedor Alfa Obrigatório unidade de recebível alcançada. Sem
formatação.

CNPJ ou CPF do titular da unidade de recebível

Alfa Obrigatório
documentoTitular alcançada. Sem formatação.

Código de arranjo de pagamento constante da

Alfa Obrigatório
codigoArranjoPagamento tabela

Data de liquidação do recebível prevista pelo

arranjo de pagamento ou com efeitos da
Data Obrigatório
dataLiquidacao antecipação pré-contratada. Formato:
AAAA-MM-DD
Tipo da constituição da unidade de recebível,
sendo:
Alfa Obrigatório
constituicao ● 1 = Constituída
● 2 = A constituir

Decimal Obrigatório Valor constituído total da unidade de recebível.

valorConstituidoTotal

Valor bloqueado para pagamento na unidade

Decimal Obrigatório
valorBloqueado de recebível.

Identificador sequencial que indica a

Alfa Obrigatório prioridade do ônus, sendo:
indicadorOneracao
● 0 = Insucesso;

Versão 1.5, de 21 de abril de 2021 - Informação Restrita 19

 ● 1 a N = Prioridade do ônus.
Critério de comprometimento das unidades de
recebíveis, podendo ser:
● 1 = Comprometimento de valor
Alfa Obrigatório
regrasDivisao definido
● 2 = Comprometimento de percentual
do valor que vier a ser constituído.

Parâmetro do comprometimento (número

Decimal Obrigatório percentual ou valor em reais), conforme a
valorOnerado
regra da divisão contratada.

Valor calculado pela CERC aplicando o efeito

de contrato na Unidade de Recebível.
valorConstituidoEfeito Decimal Opcional
Representa o montante do valor constituído
total que foi afetado pelo efeito.

indicadoresConsistencia - Lista de Indicadores de Consistência (Opcional)

indicador Alfa Obrigatório Identificador do indicador de consistência.

Resultado da saída do indicador em formato de

resultado Alfa Obrigatório
texto.

parametros - Lista de parâmetros de saída do indicador

chave Alfa Obrigatório Identificador do parâmetro

valor Alfa Obrigatório Valor do parâmetro

Código que identifica a criticidade do resultado

do indicador, sendo:
● 0 = Consistente
criticidade Alfa Obrigatório
● 1 = Neutro
● 2 = Alerta
● 3 = Crítico
erros - Lista de erros (Obrigatório em caso de Erro)

codigo Alfa Obrigatório Código do erro - Consultar Tabela de Erro

mensagem Alfa Obrigatório Descrição do erro - Consultar Tabela de Erro

Exemplo de notificação:

[
{
"tipoEvento": "contrato",
"dataHoraEvento": "2020-01-30T18:58:36.087Z",
"evento": {
"referenciaExterna": "referenciaContrato1",
"protocolo": "a0439fea-ac6e-4f03-a72e-1167999dcec5",
"quantidadeUnidadesRecebiveisAlcancadas": 1,
"valorUnidadesRecebiveisAlcancadas": 10,

Versão 1.5, de 21 de abril de 2021 - Informação Restrita 20

 "resultadoDistribuicaoOnus": "0",
"indicadoresConsistencia": [
{
"indicador": "estabilidade_agenda",
"resultado": "Agenda estável para o usuário final recebedor",
"parametros": [
{
"chave": "estabilidade",
"valor": "estável"
}
],
"criticidade": "0"
}
],
"garantiasAlcancadas": [
{
"definicaoUnidadeRecebivel": {
"listaCnpjCredenciadora": [
"99T"
],
"listaCodigoArranjoPagamento": [
"ACC"
],
"dataInicio": "2020-12-04",
"dataFim": "2020-12-04",
"documentoUsuarioFinalRecebedor": "22751826000125",
"documentoTitular": "22751826000125"
},
"regrasDivisao": "1",
"valorAOnerar": 10,
"referenciaExterna": "",
"unidadesRecebiveisAlcancadas": [
{
"cnpjCredenciadora": "36216798000150",
"tipoDocumentoUsuarioFinalRecebedor": "1",
"documentoUsuarioFinalRecebedor": "22751826000125",
"documentoTitular": "22751826000125",
"codigoArranjoPagamento": "ACC",
"dataLiquidacao": "2020-12-04",
"constituicao": "1",
"valorConstituidoTotal": 10,
"valorBloqueado": 10,
"indicadorOneracao": "1",
"regrasDivisao": "1",
"valorOnerado": 10,

Versão 1.5, de 21 de abril de 2021 - Informação Restrita 21

 "valorConstituidoEfeito": 1000.00
}
]
}
],
"dataHoraProcessamento": "2020-12-04T18:01:28.733Z",
"status": "",
"erros": []
}
}
]

Versão 1.5, de 21 de abril de 2021 - Informação Restrita 22

Consulta de agenda
Descrição
Receber informações da consulta de agenda online, contendo as unidades de recebíveis da
agenda que foi consultada;
Definição de Leiaute
Campo
entidadeRegistradora
instituicaoCredenciadora
documentoUsuarioFinalRecebedor
codigoArranjoPagamento
dataLiquidacao
documentoTitular
constituicao
valorConstituidoTotal
valorConstituidoAntecipacaoPre
Versão 1.5, de 21 de abril de 2021 - Informação Restrita
Formato Regra Observação
CNPJ da entidade registradora onde a agenda
está registrada.
Alfa Obrigatório
Formato: 14 dígitos para CNPJ e completar
com 0 à esquerda, se necessário.
CNPJ da instituição credenciadora ou
subcredenciadora responsável pela agenda.
Alfa Obrigatório
Formato: 14 dígitos para CNPJ e completar
com 0 à esquerda, se necessário.
CPF ou CNPJ do usuário final recebedor.
Formato: 14 dígitos para CNPJ e 11 dígitos
Alfa Obrigatório
para CPF e completar com 0 à esquerda, se
necessário.
Código identificador do arranjo de
Alfa Obrigatório pagamento, constante da tabela de dicionário
de domínio neste manual.
Data de liquidação do recebível prevista pelo
arranjo de pagamento ou com efeitos de
Data Obrigatório
pré-contratada.
Formato: AAAA-MM-DD
CNPJ ou CPF do titular da UR.
Formato: 14 dígitos para CNPJ e 11 dígitos
Alfa Obrigatório
para CPF e completar com 0 à esquerda, se
necessário.
Obrigatório Tipo da constituição da unidade de recebível,
Opções aceitas: sendo:
Alfa
● 1 ● 1 = Constituída
● 2 ● 2 = A constituir
Valor (em reais) constituído total, líquido, a
Decimal Obrigatório pagar pela instituição credenciadora ou
subcredenciadora para o Titular indicado.
Valor (em reais) constituído total, líquido, a
pagar pela instituição credenciadora ou
Decimal Obrigatório
subcredenciadora oriundo de pré-contratada
para o Titular indicado.
23
 Valor bloqueado para pagamento na unidade
Decimal Obrigatório
valorBloqueado de recebível para o Titular indicado.
Identificador da carteira à qual a unidade de
carteira Alfa Opcional
recebível pertence, caso aplicável.

valorLivre Decimal Obrigatório Valor livre da UR.

Valor total da UR, a ser utilizado como base

no cálculo dos efeitos de contrato. Equivale à
valorTotalUR Decimal Obrigatório soma dos valores de todas as frações de URs
com o mesmo usuário final Recebedor,
independente do titular.
Data no formato RFC3339 da última
dataHoraUltimaAtualizacao Alfa Obrigatório
atualização da UR.
Lista de informações de pagamento da unidade de recebível

valorAPagar Decimal Opcional Valor previsto a ser pago.

CNPJ do beneficiário em decorrência do
contrato, para o tipo de efeito ônus.
beneficiario Alfa Opcional Formato: 14 dígitos para CNPJ e 11 dígitos
para CPF e completar com 0 à esquerda, se
necessário..
Data do efetivo pagamento.
dataLiquidacaoEfetiva Data Opcional
Formato: AAAA-MM-DD
Valor (em reais) final pago pela instituição
valorLiquidacaoEfetiva Decimal Opcional
credenciadora ou subcredenciadora.
Critério de comprometimento da unidade de
Opcional recebível, podendo ser:
Opções ● 1 = Comprometimento de valor
regrasDivisao Alfa aceitas: definido;
● 1 ● 2 = Comprometimento de
● 2 percentual do valor que vier a ser
constituído.
Parâmetro do comprometimento (número
valorOnerado Decimal Opcional percentual ou valor em reais), conforme a
regra da divisão contratada.
Obrigatório
Tipo de efeito sobre as unidades de
Opções
recebíveis, sendo:
aceitas:
● 1 = Troca de titularidade;
● 1
● 2 = Ônus - Cessão fiduciária;
● 2
tipoInformacaoPagamento Alfa ● 3 = Ônus - Outros;
● 3
● 4 = Bloqueio judicial
● 4
● 5 = Antecipação Pós-contratada
● 5
● 6 = Liquidação
● 6
● 7 = Domicílio de pagamento
● 7
Obrigatório, Valor sequencial do item do conjunto de
caso a efeitos de contratos existentes sobre a
indicadorEfeitosContrato Alfa
informação unidade de recebíveis, dada a
seja de um possibilidade de coexistência de mais de

Versão 1.5, de 21 de abril de 2021 - Informação Restrita 24

 efeito de um efeito sobre a mesma unidade de
contrato recebível, considerada a regra de
divisão.
Obrigatório,
caso a Valor calculado pela CERC aplicando o efeito
informação de contrato na Unidade de Recebível.
valorConstituidoEfeito Decimal
seja de um Representa o montante do valor constituído
efeito de total que foi afetado pelo efeito.
contrato
domicilioPagamento - Domicílio de Pagamento

CPF ou CNPJ do titular da conta bancária ou

numeroDocumentoTitular Alfa Obrigatório conta de pagamento.
Sem formatação.
Obrigatório Tipo de conta onde o pagamento será
Opções aceitas: liquidado:
● CC ● CC = Conta Corrente;
tipoConta Alfa
● CD ● CD - Conta de Depósito;
● PG ● PG - Conta de Pagamento;
● PP ● PP - Conta Poupança.
Numérico Código COMPE da Instituição de Domicílio,
compe Obrigatório
(3) complementar com 0 à esquerda.
Numérico Número do ISPB da Instituição de Domicílio,
ispb Obrigatório
(8) complementar com 0 à esquerda.
Número da Agência para pagamento, quando
agencia Alfa Obrigatório
o tipo de conta for diferente de PG.
Número da conta bancária, quando o tipo de
conta for CC, CD ou PP ou
numeroConta Alfa Obrigatório
Número da conta de pagamento, quando o
tipo de conta for PG.
erros - Lista de erros (Obrigatório em caso de Erro)

codigo Alfa Obrigatório Código do erro - Consultar Tabela de Erro

mensagem Alfa Obrigatório Descrição do erro - Consultar Tabela de Erro

Versão 1.5, de 21 de abril de 2021 - Informação Restrita 25

Exemplo:

[
{
"tipoEvento": "agenda",
"dataHoraEvento": "2020-01-30T18:58:36.087Z",
"evento": {
"entidadeRegistradora": "23399607000191",
"instituicaoCredenciadora": "36216798000150",
"documentoUsuarioFinalRecebedor": "22751826000125",
"codigoArranjoPagamento": "VCC",
"documentoTitular": "22751826000125",
"dataLiquidacao": "2020-12-04",
"constituicao": "1",
"valorConstituidoTotal": 1000.00,
"valorConstituidoAntecipacaoPre": 0.00,
"valorBloqueado": 0.00,
"dataHoraUltimaAtualizacao": "2020-01-29T04:58:36.087Z",
"pagamentos": [
{
"DomicilioPagamento": {
"documentoTitularDomicilio": "22751826000125",
"tipoConta": "CC",
"ispb": "123456",
"agencia": "0001",
"numeroConta": "464561-6",
"compe": "123"
},
"regrasDivisao": "1",
"valorOnerado": 1000.00,
"valorAPagar": 1000.00,
"beneficiario": "12322822000178",
"dataLiquidacaoEfetiva": null,
"valorLiquidacaoEfetiva": null,
"motivoDeNaoPagamento": "001",
"tipoInformacaoPagamento": "2",
"indicadorEfeitosContrato": "1",
"valorConstituidoEfeito": 1000.00
}
]
},
"erros": []
}
]

Versão 1.5, de 21 de abril de 2021 - Informação Restrita 26

Abertura/fechamento da janela de processamento
Descrição

Informar a abertura e fechamento das janelas de processamento do ambiente de registro de

unidades de recebíveis em arranjos de pagamentos.

Leiaute

Campo Formato Regra Observação

Obrigatório Tipo de grade horária, sendo:

Opções aceitas: ● 1 = Janela Batch (00:00 às 06:00)
tipoJanela Alfa
● 1 ● 2 = Janela Online (08:30 às 21:00)
● 2
Obrigatório
Sendo:
Opções aceitas:
status Alfa ● 1 = Abertura
● 1
● 2 = Fechamento
● 2

Exemplo de notificação:
[
{
"tipoEvento": "janelaProcessamento",
"dataHoraEvento": "2020-01-30T18:58:36.087Z",
"evento": {
"tipoJanela": "1",
"status": "1"
}
}
]

Versão 1.5, de 21 de abril de 2021 - Informação Restrita 27