Skip to content

feat(credit portability): EOF-782 - PDC20 - Proposta para ajustar o payload do endpoint de consulta da Portabilidade de Crédito #4938

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Mar 21, 2025
Merged

feat(credit portability): EOF-782 - PDC20 - Proposta para ajustar o payload do endpoint de consulta da Portabilidade de Crédito #4938

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a708621
feat(Credit Portability): EOF-767 - PPC19 - Proposta para definir o e…
CeciliaFFernandes Mar 20, 2025
3780e29
feat(Credit Portability): EOF-774 - PPC33 - Proposta para documentar …
CeciliaFFernandes Mar 20, 2025
8462309
feat(credit portability): EOF-782 - PPC19 - Proposta para complementa…
CeciliaFFernandes Mar 20, 2025
4970ff8
fix
CeciliaFFernandes Mar 20, 2025
8909c98
Merge branch 'EOF-767' into EOF-774
CeciliaFFernandes Mar 20, 2025
5fc6c31
Merge branch 'EOF-774' into EOF-782
CeciliaFFernandes Mar 20, 2025
1924c69
feat(credit portability): EOF-782 - PPC20 - Proposta para ajustar o p…
CeciliaFFernandes Mar 20, 2025
7147a10
feat(credit portability): EOF-782 - PPC24 - Proposta para padronizar …
CeciliaFFernandes Mar 21, 2025
c443187
Revert "feat(credit portability): EOF-782 - PPC24 - Proposta para pad…
CeciliaFFernandes Mar 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 67 additions & 0 deletions dictionary/creditPortabilityGetPortabilitiesByPortabilityId_v1.0.0.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,18 @@ O preenchimento deve respeitar as 6 casas decimais, mesmo que venham preenchidas
/data/proposedContract/digitalSignatureProof/documentId;documentId;Código identificador do Documento assinado na instituição proponente.;Texto;100;Obrigatório;^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$;;1;1;"";Não permitido;string;54d5348c-1a3f-4ff4-a8a8-d0724fb806c6;1
/data/proposedContract/digitalSignatureProof/signatureDateTime;signatureDateTime;"Data e hora em que o contrato foi assinado pelo cliente no canal digital da Instituição Proponente
";Texto;20;Obrigatório;^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$;;1;1;"";Não permitido;string;2020-07-21T08:30:00Z;
/data/proposedContract/totalNumberOfInstalments;totalNumberOfInstalments;total de parcelas, segundo a periodicidade regular das parcelas referente à Modalidade de Crédito informada.;Número;;Obrigatório;;;1;1;"";Não permitido;number;30;
/data/proposedContract/instalmentPeriodicity;instalmentPeriodicity;Informação relativa à periodicidade regular das parcelas. (Vide Enum) sem periodicidade regular, semanal, quinzenal, mensal, bimestral, trimestral, semestral, annual.;Texto;;Obrigatório;;"SEM_PERIODICIDADE_REGULAR
SEMANAL
QUINZENAL
MENSAL
BIMESTRAL
TRIMESTRAL
SEMESTRAL
ANUAL
OUTROS";1;1;"";Não permitido;string;SEM_PERIODICIDADE_REGULAR;
/data/proposedContract/instalmentPeriodicityAdditionalInfo;instalmentPeriodicityAdditionalInfo;Campo obrigatório para complementar a informação relativa à periodicidade de pagamento regular quando tiver a opção OUTROS.;Texto;144;Obrigatório;^(?!\s)[\w\W\s]*[^\s]$;;1;1;"";Não permitido;string;Informações Adicionais;
/data/proposedContract/dueDate;dueDate;Prazo (data de vencimento final) da operação. Especificação RFC-3339;Texto;20;Obrigatório;^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$;;1;1;"";Não permitido;string;2020-07-21T08:30:00Z;20
/data/status;status;"Informação sobre o status de um pedido de portabilidade de crédito, onde:

`RECEIVED` - Estado inicial. Indica que o pedido de portabilidade foi solicitado junto a instituição credora. O pedido deve permanecer neste estado até que o próximo dia útil (D+1) aonde começará a contar o prazo de 3 dias úteis para a etapa de contraproposta e o pedido de portabilidade deverá ser movido para PENDING.
Expand Down Expand Up @@ -269,3 +281,58 @@ para discussão e mapeamento em futuras versões.
/data/statusReason/digitalSignatureProof/documentId;documentId;Código identificador do Documento assinado na instituição proponente.;Texto;100;Obrigatório;^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$;;1;1;"";Não permitido;string;54d5348c-1a3f-4ff4-a8a8-d0724fb806c6;1
/data/statusReason/digitalSignatureProof/signatureDateTime;signatureDateTime;"Data e hora em que o contrato foi assinado pelo cliente no canal digital da Instituição Proponente
";Texto;20;Obrigatório;^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$;;1;1;"";Não permitido;string;2020-07-21T08:30:00Z;
/data/creationDateTime;creationDateTime;"Data e hora em que a Proponente registrou a presente proposta (chamada ao POST /portabilities).
Uma string com data e hora conforme especificação [RFC-3339](https://datatracker.ietf.org/doc/html/rfc3339), sempre com a utilização de timezone UTC-0 (UTC time format).
";Texto;20;Obrigatório;^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$;;1;1;"";Não permitido;string;2020-07-21T08:30:00Z;20
/data/rejection;rejection;"Objeto contendo detalhes do cancelamento do pedido de portabilidade de crédito junto a Instituição Credora.

[RESTRIÇÃO] Campo de preenchimento obrigatório quando `status` for igual a `REJECTED` ou `CANCELED`
";Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/rejection/rejectedBy;rejectedBy;"Informar usuário responsável pela rejeição da proposta, onde:
PROPONENTE - Indica que o pedido de portabilidade de crédito foi rejeitado pela proponente, seja porque a
proponente rejeitou a liquidação que excedeu em 15% o valor do contrato original, entre outras possibilidades.
USUARIO - Indica que o cliente cancelou o pedido de portabilidade de crédito.
CREDORA- Indica que a Instituição Credora cancelou o contrato por retenção do cliente ou outros motivos
conforme motivo de recusa.
";Texto;;Obrigatório;;"PROPONENTE
USUARIO
CREDORA";1;1;"";Não permitido;string;PROPONENTE;
/data/rejection/reason;reason;Motivo de recusa do pedido de portabilidade de crédito.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/rejection/reason/type;type;"Motivo de recusa do pedido de portabilidade, onde:
CANCELADO_PELO_CLIENTE - Cliente desiste do pedido da portabilidade;
SALDO_DEVEDOR_ATUALIZADO_SUBSTANCIALMENTE_DIVERGENTE - Saldo devedor atualizado divergente (superior a 15%) do informado inicialmente;
POLITICA_DE_CREDITO - Proponente desiste da oferta ao cliente por políticas internas;
RETENCAO_DO_CLIENTE - Cliente aceitou contraproposta da instituição credora (dentro do prazo);
CONTRATO_JA_LIQUIDADO - Contrato liquidado pelo cliente;
DIVERGENCIA_DE_PAGAMENTO_EFETUADO - Proponente realizou a liquidação com valor divergente;
DECURSO_DO_PRAZO_PARA_PAGAMENTO - Proponente realizou a liquidação fora do prazo;
PORTABILIDADE_CANCELADA_POR_FALTA_DE_LIQUIDACAO - Proponente não realizou a liquidação da Portabilidade;
PORTABILIDADE_EM_ANDAMENTO - Posteriormente à efetivação do pedido de portabilidade, a IF credora identificou que o cliente já possui outro pedido de portabilidade em andamento para o mesmo contrato;
CLIENTE_COM_ACAO_JUDICIAL - Possui ação judicial;
MODALIDADE_DA_OPERACAO_INCOMPATIVEL - Modalidade divergente da indicada pela instituição proponente;
OUTROS - Motivo da rejeição não se encaixa nas opções disponíveis.
";Texto;;Obrigatório;;"CANCELADO_PELO_CLIENTE
SALDO_DEVEDOR_ATUALIZADO_SUBSTANCIALMENTE_DIVERGENTE
POLITICA_DE_CREDITO
RETENCAO_DO_CLIENTE
CONTRATO_JA_LIQUIDADO
DIVERGENCIA_DE_PAGAMENTO_EFETUADO
DECURSO_DO_PRAZO_PARA_PAGAMENTO
PORTABILIDADE_CANCELADA_POR_FALTA_DE_LIQUIDACAO
PORTABILIDADE_EM_ANDAMENTO
CLIENTE_COM_ACAO_JUDICIAL
MODALIDADE_DA_OPERACAO_INCOMPATIVEL
OUTROS";1;1;"";Não permitido;string;CANCELADO_PELO_CLIENTE;
/data/rejection/reason/typeAdditionalInfo;typeAdditionalInfo;"Informação sobre a disponibilidade ou não de um contrato para a portabilidade de crédito.
Ao utilizar essa opção, é fortemente recomendável enviar um ticket como sugestão da estrutura Open Finance para discussão e mapeamento em futuras versões.

[RESTRIÇÃO] Campo de preenchimento obrigatório quando campo type for igual a OUTROS.
";Texto;144;Opcional;^(?!\s)[\w\W\s]*[^\s]$;;0;1;"";Não permitido;string;Informações Adicionais;
/data/receipt;receipt;"Objeto contendo o recibo de quitação do contrato original de empréstimo após finalizado o
pedido de portabilidade de crédito com sucesso junto a Instituição Credora.

[RESTRIÇÃO] Campo de preenchimento obrigatório quando `status` for igual a `PORTABILITY_COMPLETED`
";Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/receipt/settlementDateTime;settlementDateTime;Data e hora em que a instituição credora realizou a quitação do contrato de empréstimo.;Texto;20;Obrigatório;^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$;;1;1;"";Não permitido;string;2020-07-21T08:30:00Z;20
/data/receipt/settlementAmount;settlementAmount;Valor pago para liquidação do contrato de empréstimo.;Texto;20;Obrigatório;^\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0400;4
/data/receipt/transactionId;transactionId;Identificador da transação utilizado para liquidar o contrato de empréstimo. No contexto de STR0047, utilizar o valor do campo de retorno NumCtrlSTR (Número de Controle da STR).;Texto;20;Obrigatório;^(?!\s)[\w\W\s]*[^\s]$;;1;1;"";Não permitido;string;STR20181108000000013;1
28 changes: 28 additions & 0 deletions dictionary/creditPortabilityPostPortabilitiesCancel_v1.0.0.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Formato;Domínio;Mínimo de Ocorrências;Máximo de Ocorrências;Restrições;Nulidade;Tipo de Dado Json;Exemplo;Tamanho mínimo
/data;data;Objeto para notificar a respeito da liquidação efetuada pela proponente a Credora.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/rejectedBy;rejectedBy;"Informar usuário responsável pela rejeição da proposta, onde:

`PROPONETE ` - Indica que o pedido de portabilidade de crédito foi rejeitado pela proponente, seja porque a proponente rejeitou a liquidação que excedeu em 15% o valor do contrato original, entre outras possibilidades.

`USUARIO` - Indica que o cliente cancelou o pedido de portabilidade de crédito.
";Texto;;Opcional;;"PROPONENTE
USUARIO";0;1;"";Não permitido;string;;
/data/reason;reason;Motivo de recusa do pedido de portabilidade;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/reason/type;type;"Motivo de recusa do pedido de portabilidade, onde:

`CANCELADO_PELO_CLIENTE` - Cliente desiste do pedido da portabilidade

`SALDO_DEVEDOR_ATUALIZADO_SUBSTANCIALMENTE_DIVERGENTE` - Saldo devedor atualizado divergente (superior a 15%) do informado inicialmente

`POLITICA_DE_CREDITO` - Proponente desiste da oferta ao cliente por políticas internas

`OUTROS` - Motivo da rejeição não se encaixa nas opções disponíveis
";Texto;;Obrigatório;;"CANCELADO_PELO_CLIENTE
SALDO_DEVEDOR_ATUALIZADO_SUBSTANCIALMENTE_DIVERGENTE
POLITICA_DE_CREDITO
OUTROS";1;1;"";Não permitido;string;;
/data/reason/typeAdditionalInfo;typeAdditionalInfo;"Informação sobre a disponibilidade ou não de um contrato para a portabilidade de crédito.
Ao utilizar essa opção, é fortemente recomendável enviar um ticket como sugestão da estrutura Open Finance para discussão e mapeamento em futuras versões.

[RESTRIÇÃO] Campo de preenchimento obrigatório quando campo `reasonType` for igual `OUTROS`.
";Texto;144;Opcional;^(?!\s)[\w\W\s]*[^\s]$;;0;1;"";Não permitido;string;Informações Adicionais;
3 changes: 3 additions & 0 deletions dictionary/creditPortabilityPostPortabilities_v1.0.0.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,6 @@ CANCELED";0;1;"";Não permitido;string;;
/data/strCode;strCode;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/strCode/isbpIfCredora;isbpIfCredora;Número do ISBP da Instituição credora;Número;;Obrigatório;;;1;1;"";Não permitido;number;;
/data/strCode/agency;agency;Número da Agência creditada;Número;;Obrigatório;;;1;1;"";Não permitido;number;;
/data/creationDateTime;creationDateTime;"Data e hora em que a Proponente registrou a presente proposta (chamada ao POST /portabilities).
Uma string com data e hora conforme especificação [RFC-3339](https://datatracker.ietf.org/doc/html/rfc3339), sempre com a utilização de timezone UTC-0 (UTC time format).
";Texto;20;Obrigatório;^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$;;1;1;"";Não permitido;string;2020-07-21T08:30:00Z;20
Loading
Loading