Manual Leiautes CIP

Manual de Leiautes
CIP – R2C3
rtm.net.br
Relações com cliente: (21/11) 2102-7828 • NOC: 0800 704-1021
SÃO PAULO: Rua Libero Badaró, 377 • 11º e 22° andares • Centro • CEP 01009-000 • Tel.: (11) 2102-7860 • Fax.: (11) 2102-7878
RIO DE JANEIRO: Av. República do Chile, 230 • 7º andar • Centro • CEP 20031-170 • Tel.: (21) 2102-7860 • Fax.: (21) 2102-7840
Índice
Índice ............................................................................................................................................. 2
Versionamento .............................................................................................................................. 5
1. Objetivo ................................................................................................................................. 6
2. Autenticação ......................................................................................................................... 6
3. Paginação .............................................................................................................................. 6
4. Integrações ............................................................................................................................ 7
4.1 Agenda .......................................................................................................................... 7
4.1.1 Agenda - Consulta de retorno ....................................................................................... 7
4.1.2 Agenda - Consulta de unidades recebíveis.................................................................... 7
4.2 Baixa de recebíveis ........................................................................................................ 8
4.2.1 Baixa de recebíveis – Consulta de retorno .................................................................... 8
4.3 Opt-In ............................................................................................................................ 8
4.3.1 Notificação de Opt-In .................................................................................................... 9
4.4 Opt-Out ......................................................................................................................... 9
4.4.1 Notificação de Opt-Out ................................................................................................. 9
4.5 Contestação................................................................................................................. 10
4.5.1 Atualização de contestação......................................................................................... 10
4.6 Resumo de operações ................................................................................................. 10
4.7 Janela de negociações ................................................................................................. 11
4.8 Participantes................................................................................................................ 11
4.9 Operações ................................................................................................................... 12
4.10 Cancelamento de operações ....................................................................................... 12
4.11 Registro de operações para Credenciadora ................................................................ 12
4.11.1 Registro de operações para financiadora ................................................................... 13
4.11.2 Consulta de unidades recebíveis para financiadora ................................................... 13
4.11.3 Atualizar operação unidades recebíveis para financiadora ........................................ 13
4.11.4 Registro de operações - Resultado.............................................................................. 14
4.11.5 Registro de operações – Id de conjunto para UR para credenciadoras. ..................... 14
4.11.6 Registro de operações – Incluir lote de UR para credenciadoras ............................... 14
4.11.7 Registro de operações – Id de conjunto para UR para financiadoras ......................... 15
4.11.8 Registro de operações – Incluir lote de UR para financiadoras .................................. 15
4.12 Consulta de operações ................................................................................................ 15
4.12.1 Consulta recebíveis de operações ............................................................................... 16
4.12.2 Consulta recebíveis a constituir de operações............................................................ 16
2
4.13 Cadastro de credenciados ........................................................................................... 16
4.13.1 Consulta de credenciados ........................................................................................... 17
4.14 Requisição de cancelamento de operações da credenciadora ................................... 17
4.14.1 Consulta de resultado de cancelamento de operações .............................................. 17
4.15 Requisição de cancelamento de operações da financiadora ...................................... 18
4.16 Agendas consolidadas de financiadoras ..................................................................... 18
4.17 Consulta de operações da Financiadora ..................................................................... 18
4.17.1 Consulta recebíveis de operações da Financiadora .................................................... 19
4.17.2 Consulta recebíveis a constituir de operações da Financiadora ................................. 19
5. Webhooks e automação de resposta.................................................................................. 20
5.1 Estrutura para implementação de Webhooks ............................................................ 20
5.2 Retornos e política de retry......................................................................................... 20
5.3 Autenticação ............................................................................................................... 20
5.4 Integrações de Webhook de chamadas assíncronas. ................................................. 20
5.4.1 Notificação de Opt-In .................................................................................................. 20
5.4.2 Notificação de Opt-Out ............................................................................................... 21
5.4.3 Informe de janela de negociações .............................................................................. 21
5.4.4 Notificação de operações novas ................................................................................. 21
5.4.5 Notificação de operações atualizadas ......................................................................... 21
5.4.6 Notificação de cancelamento de operações ............................................................... 22
5.4.7 Notificação de resultado de operações ...................................................................... 22
5.4.8 Resposta do cancelamento de operações .................................................................. 22
5.5 Integrações de Webhook de arquivo recebido. .......................................................... 23
5.5.1 Unidades Recebíveis.................................................................................................... 23
5.5.2 Sumário de Operações ................................................................................................ 23
5.5.3 Participantes................................................................................................................ 23
5.5.4 Credenciados ............................................................................................................... 24
6. Modelos de dados ............................................................................................................... 25
7. Tabelas de apoio ................................................................................................................. 55
7.1 AccountType................................................................................................................ 55
7.2 ConstitutionType ......................................................................................................... 55
7.3 PaymentScheme.......................................................................................................... 55
7.4. NegociationTypeIndicator ........................................................................................... 56
8. Parâmetros de consulta – Métodos GET ............................................................................. 58
9. Códigos HTTP....................................................................................................................... 66
10. Material Confidencial ...................................................................................................... 67
3
4
Versionamento
Versão Descrição Área Responsável Data
2.0.0 • Versão Revisada NOC 23/08/2021

• Correções Gerais
• Inclusão de filtros para consulta da
ARRC018
2.1.0 NOC 27/01/2022
• Inclusão de filtros para consulta de
Unidades de recebíveis RRC0019
• Retirados payloads de exemplo
5
1. Objetivo
O Manual de Leiautes de Integração com o serviço R2C3 da registradora CIP tem como
objetivo descrever os leiautes das requisições utilizadas por Credenciadores ou
Subcredenciadores, descrever as validações realizadas nos campos e nos respectivos domínios.
Os leiautes aqui apresentados são referentes às integrações via API REST e os dados
fornecidos serão utilizados para a integração com registradora CIP para compartilhamento de
informações da agenda de recebíveis com a finalidade de atender a Resolução 4.734/19 e a
Circular 3.952/19.
2. Autenticação
A autenticação nos sistemas RTM acontece por meio de uma autorização OAUTH2, que
delega a autenticação de usuário ao serviço que hospeda a conta do usuário, autorizando
aplicações de terceiros a acessar a conta do usuário.
Para maiores informações consultar o Manual de API – Integração R2C3.
3. Paginação
Todas as consultas com método GET possuem por padrão uma paginação, portanto os
responses deverão estar aptos a receber o modelo do tipo dados de cada requisição
complementar à seguinte estrutura:
Estrutura – Paginação
pageNumber – Número da página consultada, iniciando em 0.
pageSize – Tamanho de registros disponíveis por página, default 10 e máximo 100.
totalElements – Número total de elementos
totalPages – Número total de páginas
content – Lista do tipo de dado da API consultada.
6
4. Integrações
4.1 Agenda
O envio da agenda deverá ser efetuado diariamente, sendo essas agendas reportadas à
CIP. Para efetuar a baixa desses recebíveis, deverão ser notificados os dados relativos ao
pagamento.
Emissor: Credenciadora/Subcredenciadora
Método: POST
Destinatário: Registradora CIP
Endpoint: {urlBase}/trade-repository/receivable-units
Tipo de dado: ReceivableUnitDto
Referência: ARRC001
4.1.1 Agenda - Consulta de retorno

A consulta da agenda consolidada deverá ser efetuada para o credenciador receber as
informações do processamento de agendamento dos recebíveis.
Método: GET
Paginação: Sim
Endpoint: {urlBase}/trade-repository/receivable-unit-responses/search
Tipo de dado: ReceivableUnitResponseDto
Referência: ARRC001RET
4.1.2 Agenda - Consulta de unidades recebíveis

Destinado ao credenciador consultar em tempo real os dados de unidades recebíveis e
seus dados diretamente com a registradora CIP.
Emissor: Credenciadora/Subcredenciadora.
Método: GET
Paginação: Sim
Endpoint: {urlBase}/trade-repository/receivable-units/consult-cip
Tipo de dado: ReceivableUnitFinalUserDto
Referência: RRC0010
7
4.2 Baixa de recebíveis
A baixa de recebíveis deverá ser efetuada para o credenciador informar a registradora CIP
a baixa total de unidades de recebíveis registradas por motivos de chargeback, cancelamento,
registro indevido ou fraude comprovada.
Método: POST
Destinatário: Registradora CIP
Endpoint: {urlBase}/trade-repository/receivable-units-deactivate
Tipo de dado: DeactivationDto
4.2.1 Baixa de recebíveis – Consulta de retorno

A consulta da baixa de recebíveis deverá ser efetuada para o credenciador receber as
informações do processamento das baixas de recebíveis.
Método: GET
Paginação: Sim
Endpoint: {urlBase}/trade-repository/receivable-units-deactivate-response
Tipo de dado: DeactivationResponseDto
4.3 Opt-In
Permitir que o Titular ou Usuário Final Recebedor, por meio de um Participante,
comunique que disponibiliza suas Agendas para Financiadores ou Não Financeiras.
Método: POST
Endpoint: {urlBase}/trade-repository/opt-ins
Tipo de dado: OptInDto
Tipo de resposta: OptInResponseDto
8
4.3.1 Notificação de Opt-In
Destinado a registradora CIP informar o processamento da inclusão da autorização de
envio de agenda de recebíveis.
Emissor: CIP
Método: GET
Paginação: Sim
Endpoint: {urlBase}/trade-repository/opt-ins/notification/search
Tipo de dado: OptInNotificationDto
4.4 Opt-Out
Permitir que o acesso a informações de Agendas seja cancelado, por decisão do
Financiador ou da Não Financeira solicitante anteriormente autorizado ou por solicitação do
Titular ou Usuário Final Recebedor das Agendas ao Participante que tenha realizado o informe
de Opt-in.
Método: POST
Endpoint: {urlBase}/trade-repository/opt-outs
Tipo de dado: OptOutDto
Tipo de resposta: OptOutResponseDto
4.4.1 Notificação de Opt-Out

Destinado a registradora CIP informar o processamento do cancelamento da autorização
de envio de agenda de recebíveis.
Emissor: CIP
Método: GET
Paginação: Sim
Endpoint: {urlBase}/trade-repository/opt-outs/notification/search
Tipo de dado: OptOutNotificationDto
9
4.5 Contestação
Permitir que o participante conteste um opt-in.
Método: POST
Endpoint: {urlBase}/trade-repository/pleas
Tipo de dado: PleaDto
Tipo de resposta: PleaResponseDto
4.5.1 Atualização de contestação

Permitir que o atualize uma contestação.
Método: PUT
Endpoint: {urlBase}/trade-repository/pleas/{pleaProtocol}
Tipo de dado: PleaDto
Tipo de resposta: PleaResponseDto
4.6 Resumo de operações

Permitir a registradora CIP informar ao credenciador e às instituições financeiras / não
financeiras o resumo das mensagens de operações de recebíveis enviadas durante a grade de
negociação.
Emissor: CIP
Método: GET
Paginação: Sim
Endpoint: {urlBase}/trade-repository/operation-summaries/search
Tipo de dado: OperationSummaryDto
10
4.7 Janela de negociações
Permitir a registradora CIP informar ao credenciador e às instituições financeiras / não
financeiras a abertura e fechamento da janela de negociações.
Emissor: CIP
Método: GET
Paginação: Sim
Endpoint: {urlBase}/trade-repository/timetables/search
Tipo de dado: TimetableDto
Referência: RRC0015, RRC0016
4.8 Participantes
Destinado a registradora CIP informar às Credenciadoras, Instituições Financeiras e Não
Financeiras a lista de Participantes ativos no sistema.
Emissor: CIP
Método: GET
Paginação: Sim
Endpoint: {urlBase}/trade-repository/participants/search
Tipo de dado: ParticipantDto
11
4.9 Operações
Destinado a registradora CIP informar ao Credenciador a inclusão ou a alteração de
negociação sobre unidades de recebíveis constituídas e a constituir.
Emissor: CIP
Método: GET
Paginação: Sim
Endpoint: {urlBase}/trade-repository/operations/search
Tipo de dado: OperationNotificationDto
4.10 Cancelamento de operações

Destinado a registradora CIP informar ao Credenciador o cancelamento parcial ou total de
uma negociação sobre unidades de recebíveis.
Emissor: CIP
Método: GET
Paginação: Sim
Endpoint: {urlBase}/trade-repository/operations/cancel/search
Tipo de dado: OperationCancelNotificationDto
4.11 Registro de operações para Credenciadora

Destinado ao credenciador informar a registradora CIP a inclusão ou alteração de
negociação sobre unidades de recebíveis. N
Método: POST
Paginação: Sim
Endpoint: {urlBase}/trade-repository/operations/register
Tipo de dado: OperationDto
Tipo de resposta: Assíncrono, disponível no item 4.11.4
12
4.11.1 Registro de operações para financiadora
Destinado ao financiador informar a registradora CIP a inclusão de negociação sobre
unidades de recebíveis.
Emissor: Financiadora
Método: POST
Paginação: Sim
Endpoint: {urlBase}/trade-repository/operations/financier/register
Tipo de dado: FinancierOperationDto
Tipo de resposta: Assíncrono, disponível no item 4.11.4
4.11.2 Consulta de unidades recebíveis para financiadora

Destinado a financiadora consultar em tempo real os dados de unidades recebíveis
disponíveis (selecionadas no registro da operação em caso de recusa do processamento) e
seus dados diretamente com a registradora CIP.
Método: GET
Paginação: Sim
Endpoint: {urlBase}/trade-repository/operations/financier/receivable-units-available
Tipo de dado: List<FinancierReceivableUnitDto>
4.11.3 Atualizar operação unidades recebíveis para financiadora

Destinado a financiadora atualizar os dados de operações diretamente com a registradora
CIP.
Método: PUT
Paginação: Sim
Endpoint: {urlBase}/trade-repository/operations/financier/{operationId}
Tipo de dado: FinancierOperationDto
13
4.11.4 Registro de operações - Resultado
Resultado de processamento de inclusão e alteração de operação.
Emissor: Credenciadora/Subcredenciadora/Financiadora.
Método: GET
Paginação: Sim
Endpoint: {urlBase}/trade-repository/operations/response/search
Tipo de dado: OperationResponseDto
4.11.5 Registro de operações – Id de conjunto para UR para credenciadoras.

Gera um identificador de um conjunto de unidade de recebíveis para credenciadoras.
Método: GET
Paginação: Não
Endpoint: {urlBase}/trade-repository/operations/set-id
Tipo de dado: ReceivableUnitSetIdDto
4.11.6 Registro de operações – Incluir lote de UR para credenciadoras

Incluir lotes de unidades recebíveis em um conjunto de unidades recebíveis. Id deve ter
sido gerado na chamada acima.
Método: POST
Endpoint: {urlBase}/trade-repository/operations/{receivableUnitsSetId}/receivable-units-lot
Tipo de dado: ReceivableUnitLotItemDto
14
4.11.7 Registro de operações – Id de conjunto para UR para financiadoras
Gera um identificador de um conjunto de unidade de recebíveis para financiadoras.
Emissor: Financiadora.
Método: GET
Paginação: Não
Endpoint: {urlBase}/trade-repository/operations/financier/set-id
Tipo de dado: ReceivableUnitSetIdDto
4.11.8 Registro de operações – Incluir lote de UR para financiadoras

Incluir lotes de unidades recebíveis em um conjunto de unidades recebíveis. Id deve ter
sido gerado na chamada acima.
Emissor: Financiadora.
Método: POST
Endpoint: {urlBase}/trade-repository/operations/financier/{receivableUnitsSetId}/receivable-
units-lot
Tipo de dado: FinancierReceivableUnitLotItemDto
4.12 Consulta de operações

Destinado ao credenciador realizar a consulta de uma negociação de recebíveis por
operação e/ou por usuário final recebedor.
Método: GET
Paginação: Não
Endpoint: {urlBase}/trade-repository/operations/search/{operationId}
Tipo de dado: OperationReturnDto
15
4.12.1 Consulta recebíveis de operações
Destinado ao credenciador realizar a consulta dos recebíveis em uma negociação por
Método: GET
Paginação: Não
Endpoint: {urlBase}/trade-repository/operations/search/{operationId}/receivable-units
Tipo de dado: List<OperationReceivableUnitDto>
4.12.2 Consulta recebíveis a constituir de operações

Destinado ao credenciador realizar a consulta dos recebíveis a constituir em uma negociação
por operação e/ou por usuário final recebedor.
Método: GET
Paginação: Não
Endpoint: {urlBase}/trade-repository/operations/search/{operationId}/receivable-units-to-
constitute
Tipo de dado: List<OperationReceivableUnitDto>
4.13 Cadastro de credenciados

Destinado ao credenciador informar a registradora CIP a lista de credenciados ativos que
poderão possuir unidades de recebíveis e/ou negociações registradas
Método: POST
Endpoint: {urlBase}/trade-repository/merchants
Tipo de dado: MerchantDto
16
4.13.1 Consulta de credenciados
Destinado a registradora CIP retornar o processamento da lista de credenciados ativos.
Emissor: CIP.
Método: GET
Paginação: Sim
Endpoint: {urlBase}/trade-repository/merchant-responses/search
Tipo de dado: MerchantResponseDto
4.14 Requisição de cancelamento de operações da credenciadora

Destinado ao credenciador requisitar o cancelamento de uma ou mais operações ativas à
CIP.
Método: POST
Endpoint: {urlBase}/trade-repository/cancel-operations/{operationId}
Tipo de dado: CancelOperationRequestDto
4.14.1 Consulta de resultado de cancelamento de operações

Destinado à consulta do retorno da registradora CIP, referente ao pedido de cancelamento
de uma ou mais operações.
Emissor: CIP.
Método: GET
Paginação: Sim
Endpoint: {urlBase}/trade-repository/cancel-operations/response/search
Tipo de dado: CancelOperationResponseDto
17
4.15 Requisição de cancelamento de operações da financiadora
Destinado a financiadora requisitar o cancelamento de uma ou mais operações ativas à
CIP.
Método: POST
Endpoint: {urlBase}/trade-repository/cancel-operations/financier/{operationId}
Tipo de dado: CancelFinancierOperationRequestDto
4.16 Agendas consolidadas de financiadoras

Destinado às financiadoras consultarem a posição consolidada com saldo livre e
comprometido das agendas de recebíveis cuja instituição está autorizada para o recebimento.
Emissor: CIP.
Método: GET
Paginação: Sim
Endpoint: {urlBase}/trade-repository/receivable-schedules/search
Tipo de dado: ReceivableScheduleDto
4.17 Consulta de operações da Financiadora

Destinado a financiadora realizar a consulta de uma negociação de recebíveis por operação
e/ou por usuário final recebedor.
Método: GET
Paginação: Não
Endpoint: {urlBase}/trade-repository/operations/financier/search/{operationId}
Tipo de dado: FinancierConsultOperationDto
18
4.17.1 Consulta recebíveis de operações da Financiadora
Destinado a financiadora realizar a consulta dos recebíveis em uma negociação por
Método: GET
Paginação: Não
Endpoint: {urlBase}/trade-repository/operations/financier/search/{operationId}/receivable-
units
Tipo de dado: List<FinancierConsultReceivableUnitOperationDto>
4.17.2 Consulta recebíveis a constituir de operações da Financiadora

Destinado a financiadora realizar a consulta dos recebíveis a constituir em uma negociação
por operação e/ou por usuário final recebedor.
Método: GET
Paginação: Não
Endpoint: {urlBase}/trade-repository/operations/financier/search/{operationId}/receivable-
units-to-constitute
Tipo de dado: List<FinancierOperationReceivableUnitToBeConstitutedDto>
19
5. Webhooks e automação de resposta
5.1 Estrutura para implementação de Webhooks
Na seção anterior, foram listadas as consultas ativas através das integrações disponíveis na
RTM, além disso, também providenciamos estruturas para o cadastro de um endpoint
customizado para o envio e recebimento passivo de dados, em uma estrutura de webhook. Estes
itens são disponibilizados no endpoint logo após a recebimento da resposta de processamento
pela CIP.
A implementação deste passo é aditiva à anterior, e opcional. Para esta feature, espera-se
que o cliente exponha os caminhos listados abaixo em seu ambiente conforme indicado.
Além disso, é necessário cadastrar dados de configuração para o webhook, incluindo itens
como a URL Base que receberá as chamadas, e o token fixo que será usado para autenticação.
5.2 Retornos e política de retry

Todo envio de webhook espera apenas como resposta o Status Code da operação para
quaisquer chamadas que não for recebido 200 (Ok), haverá novas tentativas até totalizar 5
tentativas inteiras, onde o dado será descartado. Qualquer outro código será interpretado como
falha.
Considerando downtime como uma das possíveis causas de falha, nossa política inclui
distancias de tempo crescentes, com uma distância total de 1 hora e 45 minutos entre a primeira
e a última tentativa de envio de cada dado.
5.3 Autenticação
Para autenticação é necessário informar um token fixo que será enviado no header das
requisições como “Bearer <token>”
5.4 Integrações de Webhook de chamadas assíncronas.

Os itens abaixo podem ser configurados em sua própria API. Uma vez que exista
configuração de URL e token válida, nós ativamente consultaremos as APIs em todos os
endpoints abaixo. Aqui, {urlBaseAPI} refere-se à URL cadastrada previamente.
5.4.1 Notificação de Opt-In

Enviado quando a registradora CIP informar o processamento da inclusão da autorização
de envio de agenda de recebíveis.
Método: POST
Endpoint: {urlBaseAPI}/webhook-notifications/opt-in-notification
Campos para palavra SHA256: OptInProtocol + PaymentScheme + RecipientDocument
Tipo de dado: OptInNotificationDto
20
5.4.2 Notificação de Opt-Out

Enviado quando a registradora CIP informar o processamento do cancelamento da
autorização de envio de agenda de recebíveis.
Método: POST
Endpoint: {urlBaseAPI}/webhook-notifications/opt-out-notification
Campos para palavra SHA256: OptInProtocol + OptOutProtocol + OptOutReceiverDocument
Tipo de dado: OptOutNotificationDto
5.4.3 Informe de janela de negociações

Enviado quando a registradora CIP informar ao credenciador e às instituições financeiras /
não financeiras a abertura e fechamento da janela de negociações.
Método: POST
Endpoint: {urlBaseAPI}/webhook-notifications/time-table
Campos para palavra SHA256: OpeningDate + ClosingDate
Tipo de dado: TimetableDto
5.4.4 Notificação de operações novas

Enviado quando a registradora CIP informar ao Credenciador a inclusão de negociação sobre
unidades de recebíveis constituídas e a constituir. O link recebido na entidade depende da
requisição original ser de uma credenciadora ou financiadora.
Método: POST
Endpoint: {urlBaseAPI}/webhook-notifications/operation-notification
Campos para palavra SHA256: OperationId + OperationHref
5.4.5 Notificação de operações atualizadas

Enviado quando a registradora CIP informar ao Credenciador a alteração de negociação
sobre unidades de recebíveis constituídas e a constituir. O link recebido na entidade depende
da requisição original ser de uma credenciadora ou financiadora.
Método: POST
21
Endpoint: {urlBaseAPI}/webhook-notifications/operation-notification/update
Campos para palavra SHA256: OperationId + OperationHref
5.4.6 Notificação de cancelamento de operações

Enviado quando a registradora CIP informar ao Credenciador o cancelamento parcial ou
total de uma negociação sobre unidades de recebíveis.
Método: POST
Endpoint: {urlBaseAPI}/webhook-notifications/operation-cancel-notification
Campos para palavra SHA256: OperationId + OperationCancelId
Tipo de dado: OperationCancelNotificationDto
5.4.7 Notificação de resultado de operações

Enviado quando a registradora CIP informar ao Credenciador o resultado do processamento
de inclusão e alteração de operação.
Método: POST
Endpoint: {urlBaseAPI}/webhook-notifications/operation-response
Campos para palavra SHA256: OperationId + ReceivableNegotiationId + Status
Tipo de dado: OperationResponseDto
5.4.8 Resposta do cancelamento de operações

Enviado quando a registradora CIP informar ao Credenciador o resultado do pedido de
cancelamento de uma operação.
Método: POST
Endpoint: {urlBaseAPI}/webhook-notifications/cancel-operation-response
Campos para palavra SHA256: ReceivableUnitIdentifier + OperationIdentifier + Status
22
Tipo de dado: CancelOperationResponseDto
5.5 Integrações de Webhook de arquivo recebido.
5.5.1 Unidades Recebíveis

Enviado quando a registradora CIP devolver um arquivo com o resultado do
processamento de um lote de Unidades Recebíveis enviado.
Método: POST
Endpoint: {urlBaseAPI}/webhook-notifications/files/receivable-unit-response
Campos para palavra SHA256: FileName + ResponseSituation
Tipo de dado: ReceivableUnitResponseDto
5.5.2 Sumário de Operações

Enviado quando a registradora CIP enviar um arquivo com um lote de sumário de
operações.
Método: POST
Endpoint: {urlBaseAPI}/webhook-notifications/files/operation-summary
Campos para palavra SHA256: FileName + MainParticipantId
Tipo de dado: OperationSummaryDto
5.5.3 Participantes
Enviado quando a registradora CIP enviar um arquivo com um lote de participantes
atualizados.
Método: POST
Endpoint: {urlBaseAPI}/webhook-notifications/files/updated-participant-list
Campos para palavra SHA256: PrimeiroItem.UpdatedAt + Tamanho(lista) + PrimeiroItem.Name
Tipo de dado: Lista de ParticipantDto
23
5.5.4 Credenciados
Enviado quando a registradora CIP devolver um arquivo com o resultado do
processamento de um lote de credenciados enviado.
Método: POST
Endpoint: {urlBaseAPI}/webhook-notifications/files/merchant-response
Campos para palavra SHA256: FileName + ResponseSituation
Tipo de dado: MerchantResponseDto
24
6. Modelos de dados
Os dados podem ser do tipo alfanumérico, numérico ou booleano, em encoding UTF-8,
seguindo as seguintes definições:
Alfanumérico – Campo do tipo texto. Tamanho máximo default 255 ou de acordo com
documentação fornecida pela CIP.
Numérico – Números reais com casas decimais separados por ponto. Tamanho máximo
default 19 sendo 13 casas para o número inteiro e 6 casas para os decimais ou de acordo com
documentação fornecida pela CIP.
Booleano – Os dados booleanos servem para representar informações verdadeiras (true) ou

falsas (false).
ReceivableUnitDto
Campo Obrigatório Tipo Preenchimento
Documento do
Estabelecimento Comercial.
customerDocument Sim Alfanumérico
Tamanho máximo 11 ou 14.
<CNPJ_CPFUsuFinalRecbdr>
Código de identificação do
customerId Sim Alfanumérico
Estabelecimento Comercial
errors Não List<ErrorDto> Lista de Erros
Identificador da Unidade de
Id Não Alfanumérico Recebível – Gerado pela
aplicação
Tipo da operação
operationType Sim Alfanumérico
{CREATION|UPDATE}
CNPJ da Instituição
Sub/Credenciadora
participantDocumentId Sim Alfanumérico
Participante.
Tamanho máximo 11 ou 14
Domínio de identificação do
Arranjo de Pagamento
paymentScheme Sim Alfanumérico
conforme item 8.3
Tamanho máximo 03
Informações de pagamento da
payments Sim List<PaymentsDto>
Unidade de Recebível
25
O valor total, líquido, em reais,
preContractedAmount Sim Numérico pré-contratado
<VlrPreContrd>
Data prevista de liquidação
settlementDate Sim Alfanumérico
<DtPrevtLiquid>
O valor total, em reais, que
compõe a Unidade de
totalAmount Sim Numérico
Recebível
<VlrTot>
PaymentsDto
Informações do domicílio de
paymentsInformation Sim PaymentInformationDto
pagamento
Identificador da Operação de
Negociação
operationId Não Alfanumérico
Tamanho máximo 19.
<IdentdOp>
settledAmount Não Numérico liquidado
<VlrEftLiquid>
settlementAmount Sim Numérico a ser liquidado
<VlrPrevtLiquid>
Data efetiva de liquidação
settlementDate Não Alfanumérico
<DtEftLiquid>
PaymentInformationDto
26
Número da conta
Tamanho máximo 20 para
accountNumber Sim Alfanumérico accountType = PG e 13 nos
demais tipos.
<Ct> ou <CtPgto>
Tipo da conta conforme item
accountType Sim Alfanumérico 8.1
<TpCt>
Agência
Tamanho máximo 04.
bankBranch Sim Alfanumérico Não deverá ser preenchido
caso accountType = PG.
<Ag>
codeCompe Sim Alfanumérico Código COMPE
Código ISPB
codeIspb Sim Alfanumérico Tamanho máximo 08.
<ISPBBcoRecbdr>
Documento do Titular da conta
customerDocument Sim Alfanumérico Tamanho máximo 11 ou 14
<CNPJ_CPFTitlarCt>
DeactivationDto
Identificador Participante
mainParticipantId Sim Alfanumérico
Principal
managedParticipantId Sim Alfanumérico
Administrado
List
receivableUnitsToDeactivate Sim <ReceivableUnit Grupo Recebíveis para Baixa
DeactivateDto>
27
ReceivableUnitsDeactivateDto
Documento do titular da
receivableOwnerDocument Sim Alfanumérico
paymentScheme Sim Alfanumérico Arranjo de Pagamento
conforme item 8.3
settlementDate Sim Alfanumérico Data Prevista Liquidação
deactivationReason Sim Alfanumérico Indicador Motivo Baixa
DeactivationResponseDto
mainParticipantId Sim Alfanumérico Identificador Participante Principal
Administrado
responseSituation Sim Alfanumérico Situação de Retorno da Requisição
List<ReceivableUnitDeacti Grupo de Recebíveis aprovados
receivableUnitsDeactivated Sim
vateDto> para baixa
List<ReceivableUnitDeacti
receivableUnitsRefused Sim Grupo de Recebíveis Recusados
vateDto>
ReceivableUnitResponseDto
Principal
Administrado
Situação de Retorno da
responseSituation Sim Alfanumérico
Requisição
List
receivableUnitsApproved Sim Grupo de Recebíveis Aprovados
<ReceivableUnitDto>
List
receivableUnitsRefused Sim Grupo de Recebíveis Recusados
<ReceivableUnitDto>
errorCode Não Alfanumérico Código de erro do arquivo
fileDate Não Alfanumérico Data de geração do arquivo
fileName Não Alfanumérico Nome do arquivo
issuerControlNumber Não Alfanumérico Número de controle do emissor
issuerIspb Não Alfanumérico ISPB do emissor
Número de controle do
recipientControlNumber Não Alfanumérico
destinatário
recipientIspb Não Alfanumérico ISPB do destinatário
referenceDate Não Alfanumérico Data de referência
28
ErrorDto
code Sim Alfanumérico Código de identificação de erro
field Sim Alfanumérico Campo com valor incorreto
value Sim Alfanumérico Valor enviado
OptInDto
Identificador Controle
requestProtocol Sim Alfanumérico
Requisição Solicitante
CNPJ ou CPF do Usuário Final
recipientDocument Sim Alfanumérico Recebedor ou do titular do
recebível
CNPJ
participantDocumentId Sim Alfanumérico
Credenciadora/Subcredenciador
financierDocument Sim Alfanumérico CNPJ ou CPF Financiador
paymentScheme Sim Alfanumérico Arranjo de Pagamento
conforme item 8.3
optInSignatureDate Sim Alfanumérico Data Assinatura Opt-In
optInStartingDate Sim Alfanumérico Data Início Opt-In
optInEndingDate Sim Alfanumérico Data Fim Opt-In
domicileIndicator Sim Alfanumérico Indicador de Domicilio
managedParticipantId Não Alfanumérico
Administrado
OptInResponseDto
requestProtocol Não Alfanumérico
optInProtocol Não Alfanumérico Identificador Controle Opt-In
tradeRepositoryDocument Não Alfanumérico CNPJ Entidade Registradora
Mensagem de retorno da CIP
cipMessage Não List<CipMessageDto>
em casos de erro
processingDate Não Alfanumérico Data de processamento
CipMessageDto
code Sim Alfanumérico Código da Mensagem
Conteudo do campo que está
content Sim Alfanumérico
com erro
field Sim Alfanumérico Campo que está com erro
message Sim Alfanumérico Descrição da mensagem
29
OptOutDto
optInProtocol Sim Alfanumérico Identificador Controle Opt-In
Administrado
OptOutResponseDto
requestProtocol Não Alfanumérico
optOutProtocol Não Alfanumérico Identificador Controle Opt-Out
em casos de erro
PleaDto
Documento da instituição
pleadingParticipantDocument Sim Alfanumérico
originadora da contestação
Documento da instituição
pleadedParticipantDocument Sim Alfanumérico
contestada
Identificador do motivo da
pleaIndicatorReason Sim Alfanumérico
contestação
pleaDescription Sim Alfanumérico Descrição da contestação
optInProtocol Sim Alfanumérico Identificador Controle Opt-In
operationId Sim Alfanumérico Identificador da operação
Administrado
PleaResponseDto
pleaProtocol Sim Alfanumérico
Contestação
em casos de erro
30
OperationSummaryDto
Principal
Administrado
Data de recepção do arquivo
cipFileDate Sim Alfanumérico
enviado pela CIP
Nome do arquivo enviado pela
cipFileName Sim Alfanumérico
CIP
List<OperationSummar Grupo de controle do resumo de
operationSummaryControl Não
yControlDto> Operações
ReceivableUnitSetIdDto
Identificador do conjunto de
receivableUnitSetId Não Alfanumérico
Unidades Recebíveis
Administrado
TimetableDto
Data de referência, no modelo
date Sim Alfanumérico
'yyyy-MM-dd'
Data de abertura da janela, no
openingDate Não Alfanumérico modelo 'yyyy-MM-
dd'T'HH:mm:ss.SSSz'
Data de fechamento da janela,
closingDate Não Alfanumérico no modelo 'yyyy-MM-
dd'T'HH:mm:ss.SSSz'
Data de abertura da janela -
tradeRepositoryOpeningDate Não Alfanumérico Registradora, no modelo 'yyyy-
MM-dd'T'HH:mm:ss.SSSz'
Data de fechamento da janela -
tradeRepositoryClosingDate Não Alfanumérico Registradora, no modelo 'yyyy-
31
ParticipantDto
document Sim Alfanumérico CNPJ ou CPF do Participante
documentType Sim Alfanumérico Indicador Tipo de Pessoa
domicileIndicator Não Alfanumérico Indicador de Domicílio
email Não Alfanumérico E-mail Participante
homologationEntryDate Não Alfanumérico Data Adesão Homologação
IsActive Não Boolean True / False
Não Nome ou Razão Social do
name Alfanumérico
Participante
participanteType Não Alfanumérico Indica o tipo do Participante
productionEntryDate Não Alfanumérico Data de Entrada em Produção
telephone Não Alfanumérico Número Telefone Participante
updatedAt Não Alfanumérico Data de Atualização do Registro
Administrado
OperationNotificationDto
operationId Não Alfanumérico Identificador da Operação de Negociação
operationHref Não Alfanumérico Localização da operação nos serviços da CIP
Data de recebimento da notificação, no modelo
createdDate Não Alfanumérico
'yyyy-MM-dd'T'HH:mm:ss.SSSz'
Data de atualização da notificação, no modelo
updateDate Não Alfanumérico
managedParticipantId Não Alfanumérico Identificador Participante Administrado
32
OperationCancelNotificationDto
CPF ou CNPJ do Participante
negociatingParticipantDocument Não Alfanumérico Negociador
Identificador Negociação
receivableNegociationId Não Alfanumérico
Recebível
Negociação
Documento do titular da
receivableOwnerDocument Não Alfanumérico
Indicador cancelamento de
totalValueCancelOperationIndicator Não Alfanumérico
valor total
operationCancelId Não Alfanumérico
Cancelamento
Indicador cancelamento de
lienToConstituteCancelIndicator Não Alfanumérico
cessão a constituir
List<ReceivableUnitCa Unidades de recebiveis da
receivableUnits Não
ncelDto> operação de cancelamento
Data de recebimento da
createdDate Não Alfanumérico notificação, no modelo 'yyyy-
Data de atualização da
updateDate Não Alfanumérico notificação, no modelo 'yyyy-
ReceivableUnitCancelDto
CNPJ
subOrAcquirerDocument Não Alfanumérico Credenciadora/Subcredenciad
ora
recipientDocument Não Alfanumérico
Recebedor
paymentScheme Não Alfanumérico Arranjo de Pagamento
conforme item 8.3
settlementDate Não Alfanumérico Data prevista de liquidação
CNPJ ou CPF Titular Vendedor
traderDocument Não Alfanumérico
ou Negociador do Recebível
negociatedValueCanceled Não Alfanumérico Valor negociado cancelado
Valor ou Percentual negociado
valueOrPercentToConstituteCanceled Não Alfanumérico
a Constituir cancelado
33
OperationDto
Obriga
Campo Tipo Preenchimento
tório
Tipo de objeto, titular ou usuario
objectType Não Alfanumérico final recebedor {“P” – Participante |
“E” – ER}
receivableNegociationId Não Alfanumérico Identificador Negociação Recebível
Indicador Tipo Negociação conforme
negociationTypeIndicator Não Alfanumérico
item 8.4
Data Vencimento Operação, no
operationDueDate Não Alfanumérico
modelo 'yyyy-MM-dd'
totalValueLimitOrDebitBalance Não Alfanumérico Valor Total Limite ou Saldo Devedor
tradeRepositoryManagementInd Indicador Gestão Entidade
Não Alfanumérico
icator Registradora {“S” – Sim | ”N” – Não}
Indicador Regra Divisão {“P” –
divisionRuleIndicator Não Alfanumérico
Porcentual | “V” – Valor}
unconditionalAcceptedOperation Indicador Aceite Incondicional
Não Alfanumérico
Indicator Operação {“S” – Sim | ”N” – Não}
receivableUnitSetId Não Alfanumérico Unidades Recebíveis – Coleta no item
4.11.5
Mensagem de retorno da CIP em
casos de erro
operationOwners Não List<OperationOwnerDto> Titulares
OperationResponseDto
operationId Não Alfanumérico Identificador da Operação de Negociação
Situação de Retorno da Requisição
responseSituation Sim Alfanumérico
(Aceito/recusado/Erro)
operationHref Não Alfanumérico Localização da operação nos serviços da CIP
Data de atualização da notificação, no modelo 'yyyy-
34
OptInNotificationDto
CNPJ ou CPF do Usuário Final Recebedor ou do titular
recipientDocument Não Alfanumérico
do recebível
participantDocumentId Não Alfanumérico CNPJ Credenciadora/Subcredenciadora
financierDocument Não Alfanumérico CNPJ ou CPF Financiador
Domínio de identificação do Arranjo de Pagamento
paymentScheme Não Alfanumérico
conforme item 8.3
optInSignatureDate Não Alfanumérico Data Assinatura Opt-In
optInStartingDate Não Alfanumérico Data Início Opt-In
optInEndingDate Não Alfanumérico Data Fim Opt-In
domicileIndicator Não Alfanumérico Indicador de Domicilio
tradeRepositoryDocume
Não Alfanumérico CNPJ Entidade Registradora
nt
optInReceiverDocument Não Alfanumérico CPF ou CNPJ Recebedor Opt-In
Data de atualização da notificação, no modelo 'yyyy-
OperationReceivableUnitDto
Campo Campo Campo Campo
CNPJ (Completo ou Base) ou CPF
receivableOwnerDocument Sim Alfanumérico
do Titular
Documento do titular do
bankAccountOwnerDocument Sim Alfanumérico
domicílio bancário
codeIspb Sim Alfanumérico Código ISPB do Banco Recebedor
accountType Sim Alfanumérico Tipo da conta conforme item 8.1
bankBranch Não Alfanumérico Agência
accountNumber Não Alfanumérico Número da conta
paymentAccountNumber Não Alfanumérico Número da conta pagamento
receivableUnitPriority Sim Alfanumérico Prioridade Negociação Recebível
recipientDocument Sim Alfanumérico
Recebedor
holderDocument Não Alfanumérico CNPJ ou CPF Titular
35
paymentScheme Sim Alfanumérico Arranjo de Pagamento conforme
item 8.3
settlementDate Sim Alfanumérico Data prevista de liquidação
negociatedValue Sim Alfanumérico Valor ou percentual negociado
Tipo de constituição da unidade
constitutionType Não Alfanumérico
de recebível conforme item 8.2
OperationReturnDto
CPF ou CNPJ do Participante
participantTraderDocument Não Alfanumérico
Negociador
Negociação
negociationTypeIndicator Não Alfanumérico Indicador Tipo Negociação
operationDueDate Não Alfanumérico Data Vencimento Operação
totalValueLimitOrDebitBalanc
Não Alfanumérico Valor Total Limite ou Saldo Devedor
e
guaranteeValue Não Numérico Valor Garantia
tradeRepositoryManagementI Indicador Gestão Entidade
Não Alfanumérico
ndicator Registradora
divisionRuleIndicator Não Alfanumérico Indicador Regra Divisão
unconditionalAcceptedOperat Indicador Aceite Incondicional
Não Alfanumérico
ionIndicator Operação
reservedReceivableUnitAccep Indicador Aceite Unidade de
Não Alfanumérico
tedIndicator Recebível Reservada
inclusionDate Não Alfanumérico Data e Hora Inclusão
operationSituationIndicator Não Alfanumérico Indicador de Situação da operação
lienAutorizationIndicator Não Alfanumérico Indicador Autorização Cessão
operationTypeOriginIndicator Não Alfanumérico Indicador Tipo Operação Origem
Localização das unidades de
receivableUnitsHref Não Alfanumérico
recebíveis nos serviços da CIP
toConstituteReceivableUnitsH
Não Alfanumérico recebíveis a constituir nos serviços da
ref
CIP
operationsOrigin Não List<Alfanumérico> Indicador Tipo Operação Origem
36
MerchantDto
Id Não Alfanumérico Identificador do Merchant cadastrado
operationType Sim Alfanumérico Indicador Manutenção Cadastro
customerDocumentType Sim Alfanumérico Indicador Tipo de Pessoa
customerDocument Sim Alfanumérico CPF ou CNPJ do Cliente
legalName Não Alfanumérico Nome ou Razão Social do Cliente
socialName Não Alfanumérico Nome Fantasia
address Não Alfanumérico Endereço
zipCode Não Alfanumérico CEP
city Não Alfanumérico Município
state Não Alfanumérico UF
errors Não List<ErrorDto> Lista de Erros
MerchantResponseDto
mainParticipantId Sim Alfanumérico Identificador Participante Principal
managedParticipantId Sim Alfanumérico Identificador Participante Administrado
responseSituation Sim Alfanumérico Situação de Retorno da Requisição
approvedMerchants Não List<MerchantDto> Lista de credenciados aceitos
rejectedMerchants Não List<MerchantDto> Lista de credenciados rejeitados
errorCode Não Alfanumérico Código de erro do arquivo
fileDate Não Alfanumérico Data de geração do arquivo
fileName Não Alfanumérico Nome do arquivo
issuerControlNumber Não Alfanumérico Número de controle do emissor
37
issuerIspb Não Alfanumérico ISPB do emissor
recipientControlNumber Não Alfanumérico Número de controle do destinatário
recipientIspb Não Alfanumérico ISPB do destinatário
referenceDate Não Alfanumérico Data de referência
OptOutNotificationDto
optOutProtocol Não Alfanumérico Identificador Controle Opt-Out
optInEndingDate Não Alfanumérico Data Fim Opt-In
optOutReceiverDocument Não Alfanumérico CPF ou CNPJ Recebedor Opt-Out
Data de recebimento da notificação,
createdDate Não Alfanumérico no modelo 'yyyy-MM-
dd'T'HH:mm:ss.SSSz'
Data de atualização da notificação,
updateDate Não Alfanumérico no modelo 'yyyy-MM-
dd'T'HH:mm:ss.SSSz'
Administrado
OperationOwnerDto
accountType Não Alfanumérico Tipo da conta conforme item 8.1
Documento do titular do domicílio
bankAccountOwnerDocument Sim Alfanumérico
bancário
codeIspb Sim Alfanumérico ISPB Banco Recebedor
operationStartingDate Não Alfanumérico Data inicial da operação

operationEndingDate Não Alfanumérico Data fim da operação
Documento do titular da Unidade de
Recebível
valueOrReceivableUnitTotalPe Valor ou Percentual Total da
Não Alfanumérico
rcent Operação na Unidade de Recebível
Domínio de identificação do Arranjo
PaymentSchemes Não List<Alfanumérico>
de Pagamento conforme item 8.3
ReceivableUnitSetIdDto
38
receivableUnitSetId Sim Alfanumérico Unidades Recebíveis
managedParticipantId Não Alfanumérico Administrado
39
FinancierOperationDto
Tipo de objeto (“P” - Participante – “E”
objectType Sim Alfanumérico
- ER)
receivableNegociationId Sim Alfanumérico Identificador da Negociação Recebível
Indicador do Tipo de Negociação
negociationTypeIndicator Sim Alfanumérico
conforme item 8.4
operationDueDate Sim Alfanumérico Data de Vencimento da Operação
totalValueLimitOrDebitBalance Sim Numérico Valor Total Limite ou Saldo Devedor
tradeRepositoryManagementIndic Indicador Gestão da Entidade

Sim Alfanumérico
ator Registradora {“S” – Sim | “N” – Não}
Indicador Regra Divisão {“P” –
divisionRuleIndicator Sim Alfanumérico
Porcentual | “V” – Valor}
unconditionalAcceptedOperationI Indicador de Aceite Incondicional da
Não Alfanumérico
ndicator Operação {“S” – Sim | “N” – Não}
Indicador de Alcance do Contrato de
contractReachIndicator Não Alfanumérico Credenciadoras/Subcredenciadoras
{“G” – Geral | “E” – Específico}
Indicador de aceite da Unidade de
reserveAcceptedIndicator Não Alfanumérico Recebível Reservada {“S” – Sim | “N” –
Não}
Identificador da Operação
disconstitutedReceivableUnitOper
Não Alfanumérico Desconsituição da Negociação de
ationId
Recebível
Identificador do Conjunto de Unidades
receivableUnitSetId Não Alfanumérico
de Recebível – Coleta no item 4.11.7
Indicador de Autorização de Cessão
cancelAuthorizationIndicator Não Alfanumérico
{“S” – Sim | “N” – Não}
CNPJs ou CPFs de Titular das Contas
authorizedAssigneesDocuments Sim List<Alfanumérico>
Autorizadas
Identificadores da Operação Original da
debtRenegociationIds Sim List<Alfanumérico>
Renegociação de Divida
List<FinancierOpera
operationOwners Sim Titulares
tionOwnerDto>
guaranteeValue Não Numérico Valor de Garantia
40
FinancierOperationOwnerDto
CNPJ (Completo ou Base) ou CPF do
Titular
valueOrReceivableUnitTotalPe Valor ou Percentual Total da
Não Alfanumérico
rcent Operação na Unidade de Recebível
operationStartingDate Sim Alfanumérico Data de Início da Operação
operationEndingDate Sim Alfanumérico Data de Fim da Operação
bankAccountOwnerDocument Sim Alfanumérico CNPJ ou CPF do Titular da Conta
codeIspb Não Numérico ISPB do Banco Recebedor

accountType Não Alfanumérico Tipo da conta conforme item 8.1
accountNumber Não Numérico Conta
paymentAccountNumber Não Numérico Conta de Pagamento
Documentos (CNPJs Completo ou
accreditorDocuments Não List<Alfanumérico>
Base, ou CPF) de credenciadores
paymentSchemes Não List<Alfanumérico>
Documentos (CNPJs Completo ou
receivingFinalUserDocuments Não List<Alfanumérico>
Base, ou CPF) de recebedores finais.
41
ReceivableUnitLotItemDto
anticipationDate Não Alfanumérico Data Antecipação
anticipationSettlementDate Não Alfanumérico Data Efetiva Liquidação Antecipação
anticipationSettlementNetAm Valor Efetivo Liquidação Atencipação

Não Numérico
ount
anticipationUnregisteredAmo Valor antecipado não registrado
Não Numérico
unt
bankAccountOwnerDocument Sim Alfanumérico bancário
forecastSettlementDate Sim Alfanumérico Data Prevista Liquidação
holderDocument Sim Alfanumérico CNPJ ou CPF Titular
negociatedValue Sim Numérico Valor ou Percentual Negociado
paymentAccountNumber Não Numérico Conta Pagamento

receivableOwnerDocument Sim Alfanumérico CNPJ ou CPF do Titular

recipientDocument Sim Alfanumérico Recebedor
42
FinancierReceivableUnitLotItemDto
CNPJ da Credenciadora ou
accreditorDocument Sim Alfanumérico Subcredenciadora

bankAccountOwnerDocument Sim Alfanumérico bancário
forecastSettlementDate Sim Alfanumérico Data Prevista Liquidação
negociatedValue Sim Numérico Valor ou Percentual Negociado
paymentAccountNumber Não Numérico Conta Pagamento

receivableOwnerDocument Sim Alfanumérico CNPJ ou CPF do Titular

recipientDocument Sim Alfanumérico Recebedor
43
OperationSummaryControlDto
Data/Hora recepção/envio do
fileDate Sim Alfanumérico arquivo
fileNameReceived Não Alfanumérico Nome físico do arquivo recepcionado
fileNameSent Não Alfanumérico Nome físico do arquivo enviado
participantNegociationProtoc Código alfanumérico identificador da

Não Alfanumérico negociação enviado pelo participante
ol
Identificador controle da requisição
requestProtocol Não Alfanumérico do solicitante
tradeRepositoryDeconstructio Desconsituição da Negociação de
Não Alfanumérico
nProtocol Recebível enviado pela registradora
tradeRepositoryNegociationCa Cancelamento da Negociação de
Não Alfanumérico
ncellProtocol Recebível enviado pela registradora
tradeRepositoryOperationProt Identificador Operação enviado pela

Não Alfanumérico registradora
ocol
Identificador de controle do OPT-IN
tradeRepositoryOptInProtocol Não Alfanumérico na registradora
tradeRepositoryOptOutProtoc Identificador de controle do OPT-OUT

Não Alfanumérico na registradora
ol
tradeRepositoryOriginalOpera Identificador da operação original no

Não Alfanumérico caso de uma renegociação de dívida
tionProtocol
Identificador de controle de
tradeRepositoryPleaProtocol Não Alfanumérico contestação na registradora
44
CancelOperationRequestDto
operationType Sim Alfanumérico O Tipo da operação: “Cancelamento“
receivableNegociationId Sim Alfanumérico Identificador da operação.
Indicador “S” ou “N” para

completeCancelIndicator Sim Alfanumérico cancelamento de todos os itens.

Recebedor das Unidades Recebíveis a
receivableOwnerDocument Não Alfanumérico serem canceladas. Ausente se
“completeCancelIndicator” for “N”,
obrigatório caso contrário.
Lista de Unidades Recebíveis para

List<ReceivableUnitCanc cancelar. Ausente se
receivableUnits Não “completeCancelIndicator” for “S”,
elDto>
CancelOperationResponseDto
requestResult Sim Alfanumérico O Resultado: “Aceito“ ou “Erro”
receivableUnitIdentifier Sim Alfanumérico Identificador da unidade recebível.
operationIdentifier Sim Alfanumérico Identificador da Operação.
Identificador único do protocolo de

operationCancelProtocolIdenti cancelamento, presente em caso de
Não Alfanumérico
fier sucesso.
Presente em caso de erro. Momento

dateTime Não Alfanumérico do erro.
Presente em caso de erro. Lista de

messages Não List<CipMessageDto> causa(s) do erro.
45
CancelFinancierOperationRequestDto
operationType Sim Alfanumérico O Tipo da operação: “Cancelamento“
receivableNegociationId Sim Alfanumérico Identificador da operação.
Indicador “S” ou “N” para

completeCancelIndicator Sim Alfanumérico cancelamento de todos os itens.

Recebedor das Unidades Recebíveis a
receivableOwnerDocument Não Alfanumérico serem canceladas. Ausente se
“completeCancelIndicator” for “S”,
Lista de Unidades Recebíveis para

List<ReceivableUnitCanc cancelar. Ausente se
receivableUnits Não “completeCancelIndicator” for “S”,
elDto>
Indicador “S” ou “N” de liquidação

settlementOperationIndicator Sim Alfanumérico antecipada da operação
assignmentCancelToBeConstit Indicador “S” ou “N” de

Sim Alfanumérico cancelamento de cessão a constituir
utedIndicator
46
ReceivableUnitFinalUserDto
O tipo de objeto: Titular é ‘T’, Usuario
objectType Sim Alfanumérico Final Recebedor é ‘U’
tradeRepositoryDocument Sim Alfanumérico CNPJ da Entidade Registradora
CNPJ da
participantDocumentId Sim Alfanumérico Credenciadora/Subcredenciadora

CNPJ (Completo ou Base) ou CPF do
recipientDocument Sim Alfanumérico Usuário Final Recebedor
Valor Livre do Usuário Final

recipientAvailableAmount Sim Numérico Recebedor
settlementDate Sim Alfanumérico Data Prevista de Liquidação
totalAmount Sim Alfanumérico Valor Total
domicileIndicator Sim Alfanumérico Indicador de Domicílio
List<
holders Sim ReceivableUnitFinalUser Titulares da unidade recebível.
HolderDto>
47
ReceivableUnitFinalUserHolderDto
bankAccountOwnerDocument Sim Alfanumérico CNPJ ou CPF do Titular
bankAccountOwnerTotalAmo Valor Total pertencente ao Titular

Sim Numérico
unt
amountComprimisedInOtherI Valor Comprometido em Outras
Sim Numérico Instituições
nstitutions
amountComprimisedOnInstitu Valor Comprometido na Instituição
Sim Numérico
tion
totalAvalableAmount Sim Numérico Valor Livre Total
Valor Livre Antecipação

participantAvailableAmount Sim Numérico Credenciadora/Subcredenciadora
preContractedAmount Sim Numérico Valor Pré-Contratado
technicalReserveChargeAmou Valor de Ônus para Reserva Técnica

Sim Numérico
nt
List<
Domicílios. Presentes se objeto pai
domiciles Não ReceivableUnitDomicile
tiver um indicador de domicílios “S”
Dto>
List<
otherInstitutionOperations Não ReceivableUnitOtherInst Operações de outras instituições
itutionsDto>
ReceivableUnitOtherInstitutionsDto
Indicador de Regra de Divisão (V ou
divisionRuleIndicator Sim Alfanumérico F)
negociatedAmount Sim Numérico Valor Negociado
Valor ou percentual a constituir com

creditorAmountToConstitute Sim Numérico a IF credora
Data final do contrato com a IF

operationEndingDate Sim Alfanumérico credora
Prioridade da Negociação do
receivableUnitPriority Sim Numérico Recebível
48
ReceivableUnitDomicileDto
bankAccountOwnerDocument Sim Alfanumérico CNPJ ou CPF do Titular
bankBranch Sim Alfanumérico Agência
accountNumber Sim Alfanumérico Conta
paymentAccountNumber Sim Alfanumérico Conta para Pagamento
effectiveLiquidationDate Sim Alfanumérico Data Efetiva de Liquidação
effectiveLiquidationAmount Sim Numérico Valor Efetivo de Liquidação
availableAmount Sim Numérico Valor Livre
List<
operations Sim ReceivableUnitDomicile Lista de operações
OperationDto>
ReceivableUnitDomicileOperationDto
operationId Sim Alfanumérico Identificador da operação.
Prioridade da Negociação do
receivableUnitPriority Sim Numérico Recebível
tradeRepositoryDocument Sim Alfanumérico CNPJ da Entidade Registradora
negociatedValue Sim Numérico Valor Negociado
Valor ou percentual a constituir à IF

creditorAmountToConstitute Sim Numérico credora
Indicador de Regra de Divisão (V ou

divisionRuleIndicator Sim Alfanumérico F)
operationEndingDate Sim Alfanumérico Data fim do contrato IF credora
49
ReceivableScheduleDto
Nome do arquivo cuja CIP informou a
sourceFileName Sim Alfanumérico agenda.
Data da atualização das informações

createdAt Sim Alfanumérico em formato ISO8601
Código Instituidor Arranjo de

paymentSchemeCode Sim Alfanumérico Pagamento
Lista<
receiverFinalUsers Sim ReceivableScheduleRece Lista de usuários finais recebedores
ivingFinalUserDto>
Lista<
receivableScheduleHolders Sim ReceivableScheduleHold Lista de Titulares
erDto>
ReceivableScheduleReceivingFinalUserDto
finalUserDocument Sim Alfanumérico Recebedor
Valor livre deste usuário final

finalUserFreeValue Sim Decimal recebedor
Lista< Lista de Unidades Recebíveis deste

receivableUnitSchedules Sim ReceivingFinalUserRecei usuário final
vableUnitDto>
ReceivingFinalUserReceivableUnitDto
Data prevista de liquidação, em
expectedSettlementDate Sim Alfanumérico formato ISO8601
totalValue Sim Decimal Valor total
domicileIndicator Sim Alfanumérico Indicador de domicílio
Lista<
holders Sim ReceivableUnitFinalUser Lista de Titulares
HolderDto>
50
ReceivableScheduleHolderDto
holderDocument Sim Alfanumérico CNPJ Completo ou CPF do Titular
Lista< Lista de Unidades Recebíveis do

holderReceivableUnits Sim HolderReceivableUnitDt titular
o>
HolderReceivableUnitDto
expectedSettlementDate Sim Alfanumérico Data prevista de liquidação
totalAmount Sim Numérico Valor Total pertencente ao Titular
amountComprimisedInOtherI Valor Comprometido em Outras

nstitutions
amountComprimisedOnInstitu Valor Comprometido na Instituição
Sim Numérico
tion
totalAvalableAmount Sim Numérico Valor Livre Total
participantAnticipationAvailab Valor Livre Antecipação

Sim Numérico Credenciadora/Subcredenciadora
leAmount
preContractedAmount Sim Numérico Valor Pré-Contratado
technicalReserveChargeAmou Valor de Ônus para Reserva Técnica

Sim Numérico
nt
List<
Domicílios. Presentes se objeto pai
domiciles Não ReceivableUnitDomicile
tiver um indicador de domicílios “S”
Dto>
List<
otherInstitutionOperations Não ReceivableUnitOtherInst Operações de outras instituições
itutionsDto>
51
FinancierReceivableUnitDto
Tipo de objeto (F – Financiadora, C –
paymentAccountNumber Sim Alfanumérico Credenciadora)
accreditorDocument Sim Alfanumérico CNPJ Financiadora
recipientDocument Sim Alfanumérico CNPJ ou CPF Usuário Final Recebedor
paymentScheme Sim Alfanumérico Código Instituidor Arranjo Pagamento
Valor Livre Antecipação

totalAmount Sim Numérico Credenciadora/Subcredenciadora
totalAvailableAmount Sim Numérico Valor Pré-Contratado
participantAvailableAmount Sim Numérico Valor de Ônus para Reserva Técnica
Domicílios. Presentes se objeto pai tiver

preContractedAmount Sim Numérico
um indicador de domicílios “S”
technicalReserveChargeAmount Sim Numérico Operações de outras instituições
amountComprimisedInOtherInstituti Valor Comprometido em outras

ons
amountComprimisedOnInstiturion Sim Numérico Valor Comprometido na instituição
settlementDate Sim Alfanumérico Data Prevista de Liquidação
52
FinancierConsultOperationDto
authorizedAssigneesDocuments Não List<Alfanumérico> Cessionários Autorizados
Negociação
negociationTypeIndicator Não Alfanumérico Indicador Tipo Negociação
operationDueDate Não Alfanumérico Data Vencimento Operação
totalValueLimitOrDebitBalance Não Alfanumérico Valor Total Limite ou Saldo Devedor
guaranteeValue Não Numérico Valor Garantia
tradeRepositoryManagementInd Indicador Gestão Entidade
Não Alfanumérico
icator Registradora
divisionRuleIndicator Não Alfanumérico Indicador Regra Divisão
unconditionalAcceptedOperation Indicador Aceite Incondicional
Não Alfanumérico
Indicator Operação
debitRenegociation Não List<Alfanumérico> Renegociações de Dividas
inclusionDate Não Alfanumérico Data e Hora Inclusão
operationSituationIndicator Não Alfanumérico Indicador de Situação da operação
contractReachIndicator Não Alfanumérico Indicador de Alcance de Contrato
Indicador Aceite Unidade de
reserveAcceptedIndicator Não Alfanumérico Recebível
Reservada
receivableUnitsHref Não Alfanumérico
recebíveis nos serviços da CIP
toConstituteReceivableUnitsHref Não Alfanumérico recebíveis a constituir nos serviços da
CIP
cancelAuthorizationIndicator Não Alfanumérico Indicador de Autorização de Cessão
Identificador CIP da Operação
cipOriginDebtRenegotiation Não Alfanumérico
Original Renegociação Dívida
Administrado
53
FinancierConsultReceivableUnitOperatioDto
receivableOwnerDocument Sim Alfanumérico CNPJ (Completo ou Base) ou CPF do Titular
bankAccountOwnerDocument Sim Alfanumérico Documento do titular do domicílio bancário
recipientDocument Sim Alfanumérico CNPJ ou CPF do Usuário Final Recebedor
accreditorDocument Sim Alfanumérico CNPJ do Credenciador
Domínio de identificação do Arranjo de
Pagamento conforme item 8.3
forecastSettlementDate Sim Alfanumérico Data prevista de liquidação
negociatedValue Sim Numérico Valor ou percentual negociado
FinancierOperationReceivableUnitToBeConstitutedDto
receivableOwnerDocument Sim Alfanumérico CNPJ (Completo ou Base) ou CPF do Titular
bankAccountOwnerDocument Sim Alfanumérico Documento do titular do domicílio bancário
recipientDocument Sim Alfanumérico CNPJ ou CPF do Usuário Final Recebedor
accreditorDocument Sim Alfanumérico CNPJ do Credenciador
Domínio de identificação do Arranjo de
Pagamento conforme item 8.3
settlementDate Sim Alfanumérico Data prevista de liquidação
negociatedConstituteValue Sim Numérico Valor ou percentual negociado
54
7. Tabelas de apoio
7.1 AccountType
Valor Descrição
CC Conta Corrente
CD Conta de Depósito
PG Conta Pagamento
PP Conta Poupança
7.2 ConstitutionType
Valor Descrição
CONSTITUTED Constituída
TO_BE_CONSTITUTED A Constituir
7.3 PaymentScheme
Valor Descrição
006 Amex Cartão de Crédito
013 Banescard Cartão de Crédito
043 Banescard Cartão de Débito
010 Cabal Crédito
030 Cabal Débito
023 CREDZ Crédito
005 Diners Cartão de Crédito
008 Elo Cartão de Crédito
027 Elo Cartão de Débito
037 Goodcard Crédito
021 Hipercard Cartão de Crédito
031 JCB Cartão de Crédito
003 Mastercard Cartão de Crédito
025 Mastercard Cartão de Débito
55
047 Ourocard Cartão de Débito
019 Sorocred Cartão de Crédito
048 Sorocred Cartão de Débito
004 Visa Cartão de Crédito
026 Visa Cartão de Débito
020 Verdecard Cartão de Crédito
015 Mais Cartão de Crédito
016 China UnionPay
007 Hipercard Cartão de Débito
018 Sicred Crédito
060 Agiplan
061 Aura
062 Avista
063 Banese Card
064 Brasil Card
065 Banrisul
066 Calcard
067 Credi-Shop
069 Dacasa
070 Discover
071 Fortbrasil
072 Maxifrota
073 Redesplan
074 Senff
075 Sem Parar
076 TicketLog Pós
7.4. NegociationTypeIndicator
Valor Descrição
TC Troca de Titularidade
OG Ônus - Gravame
56
OP Ônus – Penhora
OR Ônus – Reserva Financeira
AN Antecipação
GC Ônus Gravame Cessão Fiduciária
GP Ônus Gravame Penhor
57
8. Parâmetros de consulta – Métodos GET
/trade-repository/receivable-unit-responses/search
Parâmetro Tipo Descrição
errorCodes array[string] Código de erro
fileNames array[string] Nome dos arquivos
ids array[string] Identificação
issuerControlNumbers array[string] Número de controle do emissor
issuerIspbs array[string] ISPB do emissor
mainParticipantIds array[string] Identificador Participante Principal
managedParticipantIds array[string] Identificador Participante Administrado
maximumFileDate string($date) Data máxima de geração do arquivo
maximumReferenceDate string($date) Data máxima de referência
minimumFileDate string($date) Data mínima de geração do arquivo
minimumReferenceDate string($date) Data mínima de referência
pageNumber integer($int32) Número da página consultada, default em 0.
Tamanho de registros disponíveis por página,
pageSize integer($int32)
default 10.
recipientControlNumbers array[string] Número de controle do destinatário
recipientIspbs array[string] ISPB do destinatário
responseSituations array[string] Situação de Retorno da Requisição
sortDirection string Ordenação, default ASC.
sortParameter string Parâmetro de ordenação, default Id.
/trade-repository/opt-ins/notification/search
domicileIndicators array[string] Indicador de domicílios
financierDocuments array[string] Documento do Financiador
maximumCreatedDate string($date) Data máxima de recebimento da notificação
maximumOptInEndingDate string($date) Data máxima de fim Opt-In
maximumOptInSignatureDate string($date) Data máxima de assinatura Opt-In
maximumOptInStartingDate string($date) Data máxima de início Opt-In
maximumUpdateDate string($date) Data máxima de atualização da notificação

minimumCreatedDate string($date) Data mínima de recebimento da notificação
minimumOptInEndingDate string($date) Data mínima de fim Opt-In
minimumOptInSignatureDate string($date) Data mínima de assinatura Opt-In
58
minimumOptInStartingDate string($date) Data mínima de início Opt-In
minimumUpdateDate string($date) Data mínima de atualização da notificação

optInProtocols array[string] Identificadores Controle Opt-In
optInReceiverDocuments array[string] CPF ou CNPJ Recebedor Opt-In
default 10.
participantDocumentIds array[string] CNPJ Credenciadora/Subcredenciadora
paymentSchemes array[string] Códigos Instituidor Arranjo Pagamento
CNPJ ou CPF do Usuário Final Recebedor ou do
recipientDocuments array[string]
titular do recebível
tradeRepositoryDocuments array[string] CNPJ Entidade Registradora
managedParticipantId string Identificador Participante Administrado
/trade-repository/opt-outs/notification/search
maximumOptInEndingDate string($date) Data máxima de fim Opt-In

minimumOptInEndingDate string($date) Data mínima de fim Opt-In
minimumUpdateDate string($date) Data mínima de recebimento da notificação

optInProtocols array[string] Identificadores Controle Opt-In
optOutProtocols array[string] Identificadores Controle Opt-Out
optOutReceiverDocuments array[string] CPF ou CNPJ Recebedor Opt-Out
59
default 10.
/trade-repository/operation-summaries/search
cipFileNames array[string] Nome dos arquivos
maximumCipFileDate string($date) Data máxima de geração do arquivo
minimumCipFileDate string($date) Data mínima de geração do arquivo
default 10.
/trade-repository/timetables/search
maximumClosingDate string($date) Data máxima de fechamento da janela
maximumDate string($date) Data máxima de referência
maximumOpeningDate string($date) Data máxima de abertura da janela
maximumTradeRepositoryClosingD Data máxima de fechamento da janela -
string($date)
ate Registradora
maximumTradeRepositoryOpening Data máxima de abertura da janela -
string($date)
Date Registradora
minimumClosingDate string($date) Data mínima de fechamento da janela
minimumDate string($date) Data máxima de referência
minimumOpeningDate string($date) Data máxima de abertura da janela
minimumTradeRepositoryClosingDa Data máxima de fechamento da janela -
string($date)
te Registradora
60
minimumTradeRepositoryOpeningD Data máxima de abertura da janela -
string($date)
ate Registradora
default 10.
/trade-repository/participants/search
documents array[string] CNPJ ou CPF dos Participantes
domicileIndicators array[string] Indicadores de Domicílio
emails array[string] e-mails
isActive boolean Indicador de participante ativo
maximumHomologationEntryDate string($date) Data máxima de adesão em homologação
maximumProductionEntryDate string($date) Data máxima de adesão em produção
maximumUpdatedAtDate string($date) Data máxima de atualização
minimumHomologationEntryDate string($date) Data mínima de adesão em homologação
61
minimumProductionEntryDate string($date) Data mínima de adesão em produção
minimumUpdatedAtDate string($date) Data mínima de atualização
names array[string] Nome ou Razão Social dos Participantes

default 10.
participantTypes array[string] Indicadores do tipo do Participante
telephones array[string] Número Telefones Participantes
/trade-repository/operations/search
operationHrefs array[string] Localização da operação nos serviços da CIP
operationIds array[string] Identificadores da Operação de Negociação
default 10.
/trade-repository/operations/cancel/search
lienToConstituteCancelIndicators array[string] Indicador cancelamento de cessão a constituir

negociatingParticipantDocuments array[string] CPF ou CNPJ dos Participantes Negociadores
operationCancelIds array[string] Identificadores das Operações de Cancelamento

operationIds array[string] Identificadores das Operações de Negociação
62
default 10.
receivableNegociationIds array[string] Identificadores Negociação Recebível
Documentos dos titulares das Unidades de
receivableOwnerDocuments array[string]
Recebíveis
totalValueCancelOperationIndicator
array[string] Indicador cancelamento de valor total
s
tradeRepositoryDocuments array[string] CNPJ Entidade Registradora
/trade-repository/operations/response/search
operationIds array[string] Identificadores das Operações de Negociação
default 10.
receivableNegociationIds array[string] Identificadores Negociação Recebível
statuses array[string] Status da operação
/trade-repository/merchants/search
errorCodes array[string] Código de erro do arquivo
fileNames array[string] Nome dos arquivos
issuerControlNumbers array[string] Número de controle do emissor
issuerIspbs array[string] ISPB do emissor
maximumFileDate string($date) Data máxima de geração do arquivo
maximumReferenceDate string($date) Data máxima de referência
minimumFileDate string($date) Data mínima de geração do arquivo
63
minimumReferenceDate string($date) Data mínima de referência
default 10.
recipientControlNumbers array[string] Número de controle do destinatário
recipientIspbs array[string] ISPB do destinatário
responseSituations array[string] Situação de Retorno da Requisição
/trade-repository/cancel-operations/response/search
requestResults string Código de erro do arquivo
receivableUnitIdentifiers string Nome dos arquivos
operationIdentifiers string Identificadores da Operação de Negociação
default 10.
64
/trade-repository/receivable-units/consult-cip
CNPJ (Completo ou Base) ou CPF Usuário Final
recipientDocument string
Recebedor,
paymentScheme string Código Instituidor Arranjo Pagamento
participantDocumentId string CNPJ da Credenciadora/Subcredenciadora.
availableAmount double Valor Livre.
startSettlementDate string($date) Data Inicial Prevista da Liquidação.
endSettlementDate string($date) Data Final Prevista da Liquidação.
negotiationTypeIndicator string Indicador do Tipo Negociação.
receivableOwnerDocument string CNPJ (Completo ou Base) ou CPF do Titular.
default 10.
/trade-repository/operations/financier/receivable-units-available
Identificador do Conjunto de Unidades de
receivableUnitId string
Recebível
default 10.
/trade-repository/receivable-schedules/search
fileNames string Nome do arquivo Recebido
minimumCreatedAt string($date) Data mínima de recebimento dos arquivos
maximumCreatedAt string($date) Data máxima de recebimento dos arquivos
paymentSchemes array[string] Código Instituidor Arranjo de Pagamento
finalUsers array[string] CPF ou CNPJ do usuário final recebedor
minimumSettlementDate string($date) Data mínima de Liquidação do Recebível
maximumSettlementDate string($date) Data máxima de Liquidação do Recebível
default 10.
65
9. Códigos HTTP
O integrador deve estar preparado para receber os seguintes códigos do protocolo
HTTP:
Código Descrição
200 Requisição efetuada com sucesso.
201 Recurso criado com sucesso.
204 No Content - Consulta sem resultado.
400 Não foi possível receber as informações.
401 Acesso negado. O usuário não tem permissão para realizar a ação solicitada.
404 Recurso não encontrado.
406 Informações não são válidas.
408 Timeout.
409 Conflito de informações.
417 Erro no processamento das informações.
424 Erro nas dependências da aplicação.
500 Erro interno.
502 Erro do servidor.
503 Serviço fora do ar.
66
10. Material Confidencial
Todas as informações contidas neste documento são consideradas privilegiadas e
pertencentes à RTM.
Este material inclui descrição de metodologias e conceitos obtidos através de pesquisas e

esforços de desenvolvimento e, portanto, sua divulgação só deverá ser praticada com a
finalidade específica de avaliação de seu conteúdo para aprovação e contratação desses
serviços.
Sendo assim, nenhuma parte deste documento poderá ser reproduzida, divulgada ou
franqueada a terceiros, por quaisquer meios, sem a permissão da RTM.
67

Manual Leiautes CIP

Caricato da

Informazioni sul documento

Titolo originale

Copyright

Formati disponibili

Condividi questo documento

Condividi o incorpora il documento

Opzioni di condivisione

Hai trovato utile questo documento?

Questo contenuto è inappropriato?

Copyright:

Formati disponibili

Manual Leiautes CIP

Caricato da

Copyright:

Formati disponibili

Manual de Leiautes

2.0.0 • Versão Revisada NOC 23/08/2021

Destinatário: Registradora CIP

Tipo de dado: ReceivableUnitDto

4.1.1 Agenda - Consulta de retorno

Tipo de dado: ReceivableUnitResponseDto

4.1.2 Agenda - Consulta de unidades recebíveis

Tipo de dado: ReceivableUnitFinalUserDto

Destinatário: Registradora CIP

Tipo de dado: DeactivationDto

4.2.1 Baixa de recebíveis – Consulta de retorno

Tipo de dado: DeactivationResponseDto

Tipo de dado: OptInDto

Tipo de resposta: OptInResponseDto

Tipo de dado: OptInNotificationDto

Tipo de dado: OptOutDto

Tipo de resposta: OptOutResponseDto

4.4.1 Notificação de Opt-Out

Tipo de dado: OptOutNotificationDto

Tipo de dado: PleaDto

Tipo de resposta: PleaResponseDto

4.5.1 Atualização de contestação

Tipo de dado: PleaDto

Tipo de resposta: PleaResponseDto

4.6 Resumo de operações

Tipo de dado: OperationSummaryDto

Tipo de dado: TimetableDto

Referência: RRC0015, RRC0016

Tipo de dado: ParticipantDto

Tipo de dado: OperationNotificationDto

Referência: RRC0003, RRC0009

4.10 Cancelamento de operações

Tipo de dado: OperationCancelNotificationDto

4.11 Registro de operações para Credenciadora

Tipo de dado: OperationDto

Tipo de resposta: Assíncrono, disponível no item 4.11.4

Tipo de dado: FinancierOperationDto

Tipo de resposta: Assíncrono, disponível no item 4.11.4

4.11.2 Consulta de unidades recebíveis para financiadora

Tipo de dado: List<FinancierReceivableUnitDto>

4.11.3 Atualizar operação unidades recebíveis para financiadora

Tipo de dado: FinancierOperationDto

Tipo de dado: OperationResponseDto

Referência: RRC0005, RRC00019

4.11.5 Registro de operações – Id de conjunto para UR para credenciadoras.

Tipo de dado: ReceivableUnitSetIdDto

4.11.6 Registro de operações – Incluir lote de UR para credenciadoras

Tipo de dado: ReceivableUnitLotItemDto

Tipo de dado: ReceivableUnitSetIdDto

4.11.8 Registro de operações – Incluir lote de UR para financiadoras

Tipo de dado: FinancierReceivableUnitLotItemDto

4.12 Consulta de operações

Tipo de dado: OperationReturnDto

Tipo de dado: List<OperationReceivableUnitDto>

4.12.2 Consulta recebíveis a constituir de operações

Tipo de dado: List<OperationReceivableUnitDto>

4.13 Cadastro de credenciados

Tipo de dado: MerchantDto

Tipo de dado: MerchantResponseDto

4.14 Requisição de cancelamento de operações da credenciadora

Tipo de dado: CancelOperationRequestDto

4.14.1 Consulta de resultado de cancelamento de operações

Tipo de dado: CancelOperationResponseDto