Você está na página 1de 9

Central de Recebíveis

Webhook
Instituição Credenciadora

Arranjo de Pagamento

Versão 1.0
24 de janeiro de 2020
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.

Data de emissão desta versão


24 de janeiro de 2020.

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.0, de 24 de janeiro de 2020 - Informação Restrita 2


ÍNDICE
APRESENTAÇÃO 2
Objetivo 2
Propósito da CERC 2
Participantes 2
Usuários 2
Divulgação e vigência deste manual 2
Data de emissão desta versão 2
Contato 2

DEFINIÇÕES GERAIS 4

DEFINIÇÃO DA API PARA WEBHOOK 5


Estrutura da API 5
Tipos de Eventos 5

EVENTOS 6
Efeito de Contrato 6
Recebimento de contestação 9

Versão 1.0, de 24 de janeiro de 2020 - Informação Restrita 3


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 atualização, 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.

Cada participante tem liberdade para escolher sobre quais eventos quer ser notificado e para
qual URL cada webhook será enviado.

Versão 1.0, de 24 de janeiro de 2020 - Informação Restrita 4


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.
Data no formato YYYY-MM-DD
dataHoraEvento Alfa Obrigatório
HH:MM:SS.mmm
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.

Versão 1.0, de 24 de janeiro de 2020 - Informação Restrita 5


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 recebível,


constituicaoUnidadeReceb Opções aceitas: sendo:
Alfa
ivel ● 1 ● 1 = Constituída
● 2 ● 2 = A constituir

Obrigatório Identificação do tipo de documento do usuário


tipoDocumentoUsuarioFin Opções aceitas: final recebedor, sendo:
Alfa
alRecebedor ● 1 ● 1 = CPF
● 2 ● 2 = CNPJ
documentoUsuarioFinalRe CNPJ ou CPF do usuário final recebedor.
Alfa Obrigatório
cebedor
Código identificador do arranjo de pagamento,
codigoArranjoPagamento Alfa Obrigatório constante da tabela de dicionário de domínio
neste manual.
Data de liquidação do recebível prevista pelo
dataLiquidacao Data Obrigatório arranjo de pagamento ou com efeitos de
pré-contratada. Formato: AAAA-MM-DD
Valor apurado com base no valor constituído e nos
valorLivre Decimal Obrigatório efeitos de contratos existentes.
Valor em reais.

Versão 1.0, de 24 de janeiro de 2020 - Informação Restrita 6


efeitosContrato - Lista de efeitos de contrato sobre a unidade de recebível
Valor sequencial do item do conjunto de efeitos de
contratos existentes sobre a unidade de
indicadorEfeitosContrat
Alfa Obrigatório recebíveis, dada a possibilidade de coexistência de
o
mais de um ônus sobre a mesma unidade de
recebível, considerada a regra de divisão.
CNPJ da entidade registradora que instruiu o
cnpjEntidadeRegistrador
Alfa Obrigatório efeito decorrente do contrato.
a
Sem formatação.
Obrigatório Indicador do tipo de efeito decorrente do
Opções aceitas: contrato. Podendo ser:
tipoEfeito Alfa
● 1 ● 1 = Troca de titularidade;
● 2 ● 2 = Ônus
Critério de comprometimento das unidades de
Obrigatório
recebíveis, podendo ser:
Opções aceitas:
Regras de divisão Alfa ● 1 = Comprometimento de valor definido;
● 1
● 2 = Comprometimento de percentual do
● 2
valor que vier a ser constituído.
CNPJ do beneficiário ou titular em decorrência do
cnpjBeneficiarioTitular Alfa Obrigatório contrato.
Sem formatação.
valorComprometido Parâmetro do comprometimento (número
Decimal Obrigatório percentual ou valor em reais), conforme a regra
da divisão contratada.
domicilioPagamento - Domicílio de Pagamento

Obrigatório, Tipo do documento do titular da conta bancária ou


Opções aceitas: conta de pagamento, sendo:
tipoDocumentoTitular Alfa
● 1 ● 1 = CPF;
● 2 ● 2 = CNPJ;
CPF ou CNPJ do titular da conta bancária ou conta
documentoTitular Alfa Obrigatório de pagamento.
Sem formatação.
Obrigatório
Tipo de conta onde o pagamento será liquidado:
Opções aceitas:
● CC = Conta Corrente;
● CC
tipoConta Alfa ● CD - Conta de Depósito;
● CD
● PG - Conta de Pagamento;
● PG
● PP - Conta Poupança.
● PP
Código COMPE da Instituição de Domicílio,
compe Numérico (3) Obrigatório
complementar com 0 à esquerda.
Número do ISPB da Instituição de Domicílio,
ispb Numérico (8) Obrigatório
complementar com 0 à esquerda.
Número da Agência para pagamento, quando o
agencia Alfa Obrigatório
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.

Versão 1.0, de 24 de janeiro de 2020 - Informação Restrita 7


Exemplo:

{
"tipoEvento":"",
"dataHoraEvento":"",
"evento":{
"cnpjCredenciadora": "",
"tipoDocumentoUsuarioFinalRecebedor": "",
"documentoUsuarioFinalRecebedor": "",
"codigoArranjoPagamento": "",
"dataLiquidacao": "",
"valorLivre": "",
"efeitosContrato":
[
{
"indicadorEfeitosContrato": "",
"cnpjEntidadeRegistradora,": "",
"tipoEfeito": "",
"cnpjBeneficiarioTitular": "",
"valorComprometido": "",
"domicilioPagamento": {
"tipoDocumentoTitular":"",
"documentoTitular":"",
"tipoConta": "",
"compe": "",
"ispb": "",
"agencia": "",
"numeroConta": ""
},
}
]
}
}

Versão 1.0, de 24 de janeiro de 2020 - Informação Restrita 8


Recebimento de contestação
Descrição

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

Leiaute

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
Obrigatório Tipo de operação correspondente àquela entrada,
tipoDocumentoContest Opções aceitas: sendo:
Alfa
ante ● 1 ● 1 = CPF;
● 2 ● 2 = CNPJ
CNPJ ou CPF do contestante da transação. ​Sem
contestante Alfa Obrigatório
formatação. Completar com 0 à esquerda.
Código do motivo da contestação.
motivoContestacao Alfa Obrigatório
Ver tabela neste manual.
observação Alfa Opcional Observação adicional informada pelo contestante.

Exemplo de notificação:

{
"referenciaExterna":"",
"tipoContestante":"",
"tipoDocumentoContestante": "",
"contestante": "",
"motivoContestacao": "",
"observação": ""
}

Versão 1.0, de 24 de janeiro de 2020 - Informação Restrita 9