You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: dictionary/creditPortabilityGetPortabilitiesByPortabilityId_v1.0.0.csv
+67
Original file line number
Diff line number
Diff line change
@@ -188,6 +188,18 @@ O preenchimento deve respeitar as 6 casas decimais, mesmo que venham preenchidas
188
188
/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
189
189
/data/proposedContract/digitalSignatureProof/signatureDateTime;signatureDateTime;"Data e hora em que o contrato foi assinado pelo cliente no canal digital da Instituição Proponente
/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;
192
+
/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
/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;
202
+
/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
191
203
/data/status;status;"Informação sobre o status de um pedido de portabilidade de crédito, onde:
192
204
193
205
`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.
@@ -269,3 +281,58 @@ para discussão e mapeamento em futuras versões.
269
281
/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
270
282
/data/statusReason/digitalSignatureProof/signatureDateTime;signatureDateTime;"Data e hora em que o contrato foi assinado pelo cliente no canal digital da Instituição Proponente
/data/creationDateTime;creationDateTime;"Data e hora em que a Proponente registrou a presente proposta (chamada ao POST /portabilities).
285
+
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).
/data/rejection/rejectedBy;rejectedBy;"Informar usuário responsável pela rejeição da proposta, onde:
292
+
PROPONENTE - Indica que o pedido de portabilidade de crédito foi rejeitado pela proponente, seja porque a
293
+
proponente rejeitou a liquidação que excedeu em 15% o valor do contrato original, entre outras possibilidades.
294
+
USUARIO - Indica que o cliente cancelou o pedido de portabilidade de crédito.
295
+
CREDORA- Indica que a Instituição Credora cancelou o contrato por retenção do cliente ou outros motivos
296
+
conforme motivo de recusa.
297
+
";Texto;;Obrigatório;;"PROPONENTE
298
+
USUARIO
299
+
CREDORA";1;1;"";Não permitido;string;PROPONENTE;
300
+
/data/rejection/reason;reason;Motivo de recusa do pedido de portabilidade de crédito.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
301
+
/data/rejection/reason/type;type;"Motivo de recusa do pedido de portabilidade, onde:
302
+
CANCELADO_PELO_CLIENTE - Cliente desiste do pedido da portabilidade;
303
+
SALDO_DEVEDOR_ATUALIZADO_SUBSTANCIALMENTE_DIVERGENTE - Saldo devedor atualizado divergente (superior a 15%) do informado inicialmente;
304
+
POLITICA_DE_CREDITO - Proponente desiste da oferta ao cliente por políticas internas;
305
+
RETENCAO_DO_CLIENTE - Cliente aceitou contraproposta da instituição credora (dentro do prazo);
306
+
CONTRATO_JA_LIQUIDADO - Contrato liquidado pelo cliente;
307
+
DIVERGENCIA_DE_PAGAMENTO_EFETUADO - Proponente realizou a liquidação com valor divergente;
308
+
DECURSO_DO_PRAZO_PARA_PAGAMENTO - Proponente realizou a liquidação fora do prazo;
309
+
PORTABILIDADE_CANCELADA_POR_FALTA_DE_LIQUIDACAO - Proponente não realizou a liquidação da Portabilidade;
310
+
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;
311
+
CLIENTE_COM_ACAO_JUDICIAL - Possui ação judicial;
312
+
MODALIDADE_DA_OPERACAO_INCOMPATIVEL - Modalidade divergente da indicada pela instituição proponente;
313
+
OUTROS - Motivo da rejeição não se encaixa nas opções disponíveis.
/data/rejection/reason/typeAdditionalInfo;typeAdditionalInfo;"Informação sobre a disponibilidade ou não de um contrato para a portabilidade de crédito.
327
+
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.
328
+
329
+
[RESTRIÇÃO] Campo de preenchimento obrigatório quando campo type for igual a OUTROS.
/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
337
+
/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
338
+
/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
/data/strCode/isbpIfCredora;isbpIfCredora;Número do ISBP da Instituição credora;Número;;Obrigatório;;;1;1;"";Não permitido;number;;
15
15
/data/strCode/agency;agency;Número da Agência creditada;Número;;Obrigatório;;;1;1;"";Não permitido;number;;
16
16
/data/creationDateTime;creationDateTime;"Data e hora em que a Proponente registrou a presente proposta (chamada ao POST /portabilities).
17
-
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).PPC-21
17
+
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).
Copy file name to clipboardExpand all lines: swagger-apis/credit-portability/1.0.0-beta.1.yml
+149-1
Original file line number
Diff line number
Diff line change
@@ -792,7 +792,7 @@ components:
792
792
type: string
793
793
description: |
794
794
Data e hora em que a Proponente registrou a presente proposta (chamada ao POST /portabilities).
795
-
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).PPC-21
795
+
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).
description: Código identificador do pedido de portabilidade realizado.
@@ -1074,6 +1075,10 @@ components:
1074
1075
- contractedFees
1075
1076
- contractedFinanceCharges
1076
1077
- digitalSignatureProof
1078
+
- totalNumberOfInstalments
1079
+
- instalmentPeriodicity
1080
+
- instalmentPeriodicityAdditionalInfo
1081
+
- dueDate
1077
1082
properties:
1078
1083
cet:
1079
1084
type: string
@@ -1253,6 +1258,37 @@ components:
1253
1258
required:
1254
1259
- documentId
1255
1260
- signatureDateTime
1261
+
totalNumberOfInstalments:
1262
+
type: number
1263
+
description: total de parcelas, segundo a periodicidade regular das parcelas referente à Modalidade de Crédito informada.
1264
+
example: 30
1265
+
instalmentPeriodicity:
1266
+
type: string
1267
+
description: Informação relativa à periodicidade regular das parcelas. (Vide Enum) sem periodicidade regular, semanal, quinzenal, mensal, bimestral, trimestral, semestral, annual.
1268
+
enum:
1269
+
- SEM_PERIODICIDADE_REGULAR
1270
+
- SEMANAL
1271
+
- QUINZENAL
1272
+
- MENSAL
1273
+
- BIMESTRAL
1274
+
- TRIMESTRAL
1275
+
- SEMESTRAL
1276
+
- ANUAL
1277
+
- OUTROS
1278
+
example: SEM_PERIODICIDADE_REGULAR
1279
+
instalmentPeriodicityAdditionalInfo:
1280
+
type: string
1281
+
description: Campo obrigatório para complementar a informação relativa à periodicidade de pagamento regular quando tiver a opção OUTROS.
1282
+
maxLength: 144
1283
+
pattern: '^(?!\s)[\w\W\s]*[^\s]$'
1284
+
example: Informações Adicionais
1285
+
dueDate:
1286
+
type: string
1287
+
description: Prazo (data de vencimento final) da operação. Especificação RFC-3339
Data e hora em que a Proponente registrou a presente proposta (chamada ao POST /portabilities).
1420
+
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).
Objeto contendo detalhes do cancelamento do pedido de portabilidade de crédito junto a Instituição Credora.
1429
+
1430
+
[RESTRIÇÃO] Campo de preenchimento obrigatório quando `status` for igual a `REJECTED` ou `CANCELED`
1431
+
required:
1432
+
- rejectedBy
1433
+
- reason
1434
+
properties:
1435
+
rejectedBy:
1436
+
type: string
1437
+
description: |
1438
+
Informar usuário responsável pela rejeição da proposta, onde:
1439
+
PROPONENTE - Indica que o pedido de portabilidade de crédito foi rejeitado pela proponente, seja porque a
1440
+
proponente rejeitou a liquidação que excedeu em 15% o valor do contrato original, entre outras possibilidades.
1441
+
USUARIO - Indica que o cliente cancelou o pedido de portabilidade de crédito.
1442
+
CREDORA- Indica que a Instituição Credora cancelou o contrato por retenção do cliente ou outros motivos
1443
+
conforme motivo de recusa.
1444
+
example: PROPONENTE
1445
+
enum:
1446
+
- PROPONENTE
1447
+
- USUARIO
1448
+
- CREDORA
1449
+
reason:
1450
+
type: object
1451
+
description: Motivo de recusa do pedido de portabilidade de crédito.
1452
+
required:
1453
+
- type
1454
+
properties:
1455
+
type:
1456
+
type: string
1457
+
description: |
1458
+
Motivo de recusa do pedido de portabilidade, onde:
1459
+
CANCELADO_PELO_CLIENTE - Cliente desiste do pedido da portabilidade;
1460
+
SALDO_DEVEDOR_ATUALIZADO_SUBSTANCIALMENTE_DIVERGENTE - Saldo devedor atualizado divergente (superior a 15%) do informado inicialmente;
1461
+
POLITICA_DE_CREDITO - Proponente desiste da oferta ao cliente por políticas internas;
1462
+
RETENCAO_DO_CLIENTE - Cliente aceitou contraproposta da instituição credora (dentro do prazo);
1463
+
CONTRATO_JA_LIQUIDADO - Contrato liquidado pelo cliente;
1464
+
DIVERGENCIA_DE_PAGAMENTO_EFETUADO - Proponente realizou a liquidação com valor divergente;
1465
+
DECURSO_DO_PRAZO_PARA_PAGAMENTO - Proponente realizou a liquidação fora do prazo;
1466
+
PORTABILIDADE_CANCELADA_POR_FALTA_DE_LIQUIDACAO - Proponente não realizou a liquidação da Portabilidade;
1467
+
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;
1468
+
CLIENTE_COM_ACAO_JUDICIAL - Possui ação judicial;
1469
+
MODALIDADE_DA_OPERACAO_INCOMPATIVEL - Modalidade divergente da indicada pela instituição proponente;
1470
+
OUTROS - Motivo da rejeição não se encaixa nas opções disponíveis.
Informação sobre a disponibilidade ou não de um contrato para a portabilidade de crédito.
1489
+
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.
1490
+
1491
+
[RESTRIÇÃO] Campo de preenchimento obrigatório quando campo type for igual a OUTROS.
1492
+
maxLength: 144
1493
+
pattern: '^(?!\s)[\w\W\s]*[^\s]$'
1494
+
example: Informações Adicionais
1495
+
receipt:
1496
+
type: object
1497
+
description: |
1498
+
Objeto contendo o recibo de quitação do contrato original de empréstimo após finalizado o
1499
+
pedido de portabilidade de crédito com sucesso junto a Instituição Credora.
1500
+
1501
+
[RESTRIÇÃO] Campo de preenchimento obrigatório quando `status` for igual a `PORTABILITY_COMPLETED`
1502
+
required:
1503
+
- settlementDateTime
1504
+
- settlementAmount
1505
+
- transactionId
1506
+
properties:
1507
+
settlementDateTime:
1508
+
type: string
1509
+
description: Data e hora em que a instituição credora realizou a quitação do contrato de empréstimo.
description: Valor pago para liquidação do contrato de empréstimo.
1517
+
maxLength: 20
1518
+
minLength: 4
1519
+
pattern: '^\d{1,15}\.\d{2,4}$'
1520
+
example: '1000.0400'
1521
+
transactionId:
1522
+
type: string
1523
+
description: 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).
0 commit comments