forked from OpenBanking-Brasil/draft-openapi
-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy path2.4.0.yml
1610 lines (1587 loc) · 66.6 KB
/
2.4.0.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
title: API Financings - Open Finance Brasil
description: |
API de informações de operações de financiamentos do Open Finance Brasil –Fase 2.
API que retorna informações de operações de crédito do tipo financiamento, mantidas nas instituições transmissoras por seus clientes, incluindo dados como denominação, modalidade, número do contrato, tarifas, prazo, prestações, pagamentos (ao menos para os últimos 12 meses), amortizações, garantias, encargos e taxas de juros remuneratórios.\
Não possui segregação entre pessoa natural e pessoa jurídica.\
Requer consentimento do cliente para todos os `endpoints`.
# Orientações
A `Role` do diretório de participantes relacionada à presente API é a `DADOS`.\
Para todos os `endpoints` desta API é previsto o envio de um `token` através do header `Authorization`.\
Este token deverá estar relacionado ao consentimento (`consentId`) mantido na instituição transmissora dos dados, o qual permitirá a pesquisa e retorno, na API em questão, dos
dados relacionados ao `consentId` específico relacionado.\
Os dados serão devolvidos na consulta desde que o `consentId` relacionado corresponda a um consentimento válido e com o status `AUTHORISED`.\
É também necessário que o recurso em questão (conta, contrato, etc) esteja disponível na instituição transmissora (ou seja, sem boqueios de qualquer natureza e com todas as autorizações/consentimentos já autorizados).\
Além disso as `permissions` necessárias deverão ter sido solicitadas quando da criação do consentimento relacionado (`consentId`).\
Relacionamos a seguir as `permissions` necessárias para a consulta de dados em cada `endpoint` da presente API.
### Observação
- No endpoint `/contracts/{contratId}/payments` a paginação ocorrerá sob os dados contidos no campo `releases` do tipo lista.
## Permissions necessárias para a API Financings
Para cada um dos paths desta API, além dos escopos (`scopes`) indicados existem `permissions` que deverão ser observadas:
### `/contracts`
- permissions:
- GET: **FINANCINGS_READ**
### `/contracts/{contractId}`
- permissions:
- GET **FINANCINGS_READ**
### `/contracts/{contractId}/warranties`
- permissions:
- GET: **FINANCINGS_WARRANTIES_READ**
### `/contracts/{contractId}/scheduled-instalments`
- permissions:
- GET: **FINANCINGS_SCHEDULED_INSTALMENTS_READ**
### `/contracts/{contractId}/payments`
- permissions:
- GET: **FINANCINGS_PAYMENTS_READ**
version: 2.4.0
license:
name: Apache 2.0
url: 'https://www.apache.org/licenses/LICENSE-2.0'
contact:
name: Governança do Open Finance Brasil – Especificações
email: gt-interfaces@openbankingbr.org
url: 'https://openbanking-brasil.github.io/areadesenvolvedor/'
servers:
- url: 'https://api.banco.com.br/open-banking/financings/v2'
description: Servidor de Produção
- url: 'https://apih.banco.com.br/open-banking/financings/v2'
description: Servidor de Homologação
tags:
- name: Financings
paths:
/contracts:
get:
tags:
- Financings
summary: Obtém os dados dos contratos de financiamentos
description: Método para obter a lista de contratos de empréstimo mantidos pelo cliente na instituição transmissora e para os quais ele tenha fornecido consentimento
operationId: financingsGetContracts
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/xFapiAuthDate'
- $ref: '#/components/parameters/xFapiCustomerIpAddress'
- $ref: '#/components/parameters/xFapiInteractionId'
- $ref: '#/components/parameters/xCustomerUserAgent'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/pageSize'
- $ref: '#/components/parameters/pagination-key'
responses:
'200':
$ref: '#/components/responses/OKResponseFinancingsContractList'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'423':
$ref: '#/components/responses/Locked'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'504':
$ref: '#/components/responses/GatewayTimeout'
'529':
$ref: '#/components/responses/SiteIsOverloaded'
default:
$ref: '#/components/responses/Default'
security:
- OpenId:
- openid
OAuth2Security:
- 'consent:consentId'
- financings
'/contracts/{contractId}':
get:
tags:
- Financings
summary: Obtém os dados do contrato de financiamento identificado por contractId
description: Método para obter os dados do contrato de financiamento identificado por contractId mantido pelo cliente na instituição transmissora
operationId: financingsGetContractsContractId
parameters:
- $ref: '#/components/parameters/contractId'
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/xFapiAuthDate'
- $ref: '#/components/parameters/xFapiCustomerIpAddress'
- $ref: '#/components/parameters/xFapiInteractionId'
- $ref: '#/components/parameters/xCustomerUserAgent'
responses:
'200':
$ref: '#/components/responses/OKResponseFinancingsContract'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'423':
$ref: '#/components/responses/Locked'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'504':
$ref: '#/components/responses/GatewayTimeout'
'529':
$ref: '#/components/responses/SiteIsOverloaded'
default:
$ref: '#/components/responses/Default'
security:
- OpenId:
- openid
OAuth2Security:
- 'consent:consentId'
- financings
'/contracts/{contractId}/warranties':
get:
tags:
- Financings
summary: Obtém a lista de garantias vinculadas ao contrato de financiamento identificado por contractId
description: Método para obter a lista de garantias vinculadas ao contrato de empréstimo identificado por contractId mantido pelo cliente na instituição transmissora. Para os produtos que não possuam garantias deve-se retornar HTTP Status 200 com o objeto “data” vazio, sem nenhum atributo interno.
operationId: financingsGetContractsContractIdWarranties
parameters:
- $ref: '#/components/parameters/contractId'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/pageSize'
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/xFapiAuthDate'
- $ref: '#/components/parameters/xFapiCustomerIpAddress'
- $ref: '#/components/parameters/xFapiInteractionId'
- $ref: '#/components/parameters/xCustomerUserAgent'
- $ref: '#/components/parameters/pagination-key'
responses:
'200':
$ref: '#/components/responses/OKResponseFinancingsWarranties'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'423':
$ref: '#/components/responses/Locked'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'504':
$ref: '#/components/responses/GatewayTimeout'
'529':
$ref: '#/components/responses/SiteIsOverloaded'
default:
$ref: '#/components/responses/Default'
security:
- OpenId:
- openid
OAuth2Security:
- 'consent:consentId'
- financings
'/contracts/{contractId}/scheduled-instalments':
get:
tags:
- Financings
summary: Obtém os dados do cronograma de parcelas do contrato de financiamento identificado por contractId
description: Método para obter os dados do cronograma de parcelas do contrato de financiamento identificado por contractId mantido pelo cliente na instituição transmissora
operationId: financingsGetContractsContractIdScheduledInstalments
parameters:
- $ref: '#/components/parameters/contractId'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/pageSize'
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/xFapiAuthDate'
- $ref: '#/components/parameters/xFapiCustomerIpAddress'
- $ref: '#/components/parameters/xFapiInteractionId'
- $ref: '#/components/parameters/xCustomerUserAgent'
- $ref: '#/components/parameters/pagination-key'
responses:
'200':
$ref: '#/components/responses/OKResponseFinancingsInstalments'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'423':
$ref: '#/components/responses/Locked'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'504':
$ref: '#/components/responses/GatewayTimeout'
'529':
$ref: '#/components/responses/SiteIsOverloaded'
default:
$ref: '#/components/responses/Default'
security:
- OpenId:
- openid
OAuth2Security:
- 'consent:consentId'
- financings
'/contracts/{contractId}/payments':
get:
tags:
- Financings
summary: Obtém os dados de pagamentos do contrato de financiamento identificado por contractId
description: Método para obter os dados de pagamentos do contrato de financiamento identificado por contractId mantido pelo cliente na instituição transmissora
operationId: financingsGetContractsContractIdPayments
parameters:
- $ref: '#/components/parameters/contractId'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/pageSize'
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/xFapiAuthDate'
- $ref: '#/components/parameters/xFapiCustomerIpAddress'
- $ref: '#/components/parameters/xFapiInteractionId'
- $ref: '#/components/parameters/xCustomerUserAgent'
- $ref: '#/components/parameters/pagination-key'
responses:
'200':
$ref: '#/components/responses/OKResponseFinancingsPayments'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'423':
$ref: '#/components/responses/Locked'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'504':
$ref: '#/components/responses/GatewayTimeout'
'529':
$ref: '#/components/responses/SiteIsOverloaded'
default:
$ref: '#/components/responses/Default'
security:
- OpenId:
- openid
OAuth2Security:
- 'consent:consentId'
- financings
components:
schemas:
ResponseErrorWithAbleAdditionalProperties:
type: object
required:
- errors
properties:
errors:
type: array
minItems: 1
maxItems: 13
items:
type: object
required:
- code
- title
- detail
properties:
code:
description: Código de erro específico do endpoint
type: string
pattern: '[\w\W\s]*'
maxLength: 255
title:
description: Título legível por humanos deste erro específico
type: string
pattern: '[\w\W\s]*'
maxLength: 255
detail:
description: Descrição legível por humanos deste erro específico
type: string
pattern: '[\w\W\s]*'
maxLength: 2048
meta:
$ref: '#/components/schemas/MetaError'
ResponseFinancingsContractList:
type: object
required:
- data
- links
- meta
properties:
data:
type: array
minItems: 0
items:
$ref: '#/components/schemas/FinancingsListContract'
links:
$ref: '#/components/schemas/Links'
meta:
$ref: '#/components/schemas/Meta'
ResponseFinancingsContract:
type: object
required:
- data
- links
- meta
properties:
data:
$ref: '#/components/schemas/FinancingsContract'
links:
$ref: '#/components/schemas/Links'
meta:
$ref: '#/components/schemas/Meta'
ResponseFinancingsInstalments:
type: object
required:
- data
- links
- meta
properties:
data:
$ref: '#/components/schemas/FinancingsInstalments'
links:
$ref: '#/components/schemas/Links'
meta:
$ref: '#/components/schemas/Meta'
ResponseFinancingsPayments:
type: object
required:
- data
- links
- meta
properties:
data:
$ref: '#/components/schemas/FinancingsPayments'
links:
$ref: '#/components/schemas/Links'
meta:
$ref: '#/components/schemas/Meta'
ResponseFinancingsWarranties:
type: object
required:
- data
- links
- meta
properties:
data:
type: array
minItems: 0
items:
$ref: '#/components/schemas/FinancingsWarranties'
links:
$ref: '#/components/schemas/Links'
meta:
$ref: '#/components/schemas/Meta'
EnumContractFinanceChargeType:
type: string
description: Tipo de encargo pactuado no contrato.
enum:
- JUROS_REMUNERATORIOS_POR_ATRASO
- MULTA_ATRASO_PAGAMENTO
- JUROS_MORA_ATRASO
- IOF_CONTRATACAO
- IOF_POR_ATRASO
- SEM_ENCARGO
- OUTROS
example: JUROS_REMUNERATORIOS_POR_ATRASO
EnumProductType:
type: string
description: |
"Tipo da modalidade de crédito contratada, conforme circular 4.015 e descrição do DOC3040 do SCR). (Vide Enum)
Financiamentos, Financiamentos rurais e Financiamentos imobiliários"
enum:
- FINANCIAMENTOS
- FINANCIAMENTOS_RURAIS
- FINANCIAMENTOS_IMOBILIARIOS
example: FINANCIAMENTOS
EnumProductSubType:
type: string
description: |
"Sub tipo da modalidades de crédito contratadas, conforme circular 4.015 e descrição do DOC3040 do SCR). (Vide Enum)
Aquisição de bens veículos automotores, Aquisição de bens de outros bens, Microcrédito, Custeio, Investimento, Industrialização, Comercialização, Financiamento habitacional SFH e Financiamento habitacional exceto SFH"
enum:
- AQUISICAO_BENS_VEICULOS_AUTOMOTORES
- AQUISICAO_BENS_OUTROS_BENS
- MICROCREDITO
- CUSTEIO
- INVESTIMENTO
- INDUSTRIALIZACAO
- COMERCIALIZACAO
- FINANCIAMENTO_HABITACIONAL_SFH
- FINANCIAMENTO_HABITACIONAL_EXCETO_SFH
example: AQUISICAO_BENS_VEICULOS_AUTOMOTORES
FinancingsContractInterestRate:
type: object
description: Objeto que traz o conjunto de informações necessárias para demonstrar a composição das taxas de juros remuneratórios da Modalidade de crédito
required:
- taxType
- interestRateType
- taxPeriodicity
- calculation
- referentialRateIndexerType
properties:
taxType:
type: string
description: |
"Tipo de Taxa (vide Enum)
- NOMINAL (taxa nominal é uma taxa de juros em que a unidade referencial não coincide com a unidade de tempo da capitalização. Ela é sempre fornecida em termos anuais, e seus períodos de capitalização podem ser diários, mensais, trimestrais ou semestrais. p.ex. Uma taxa de 12% ao ano com capitalização mensal)
- EFETIVA (É a taxa de juros em que a unidade referencial coincide com a unidade de tempo da capitalização. Como as unidades de medida de tempo da taxa de juros e dos períodos de capitalização são iguais, usa-se exemplos simples como 1% ao mês, 60% ao ano)"
enum:
- NOMINAL
- EFETIVA
example: EFETIVA
interestRateType:
type: string
description: |
"Tipo de Juros (vide Enum)
- SIMPLES (aplicada/cobrada sempre sobre o capital inicial, que é o valor emprestado/investido. Não há cobrança de juros sobre juros acumulados no(s) período(s) anterior(es). Exemplo: em um empréstimo de R$1.000, com taxa de juros simples de 8% a.a., com duração de 2 anos, o total de juros será R$80 no primeiro ano e R$ 80 no segundo ano. Ao final do contrato, o tomador irá devolver o principal e os juros simples de cada ano: R$1.000+R$80+R$80=R$1.160)
- COMPOSTO (para cada período do contrato (diário, mensal, anual etc.), há um “novo capital” para a cobrança da taxa de juros contratada. Esse “novo capital” é a soma do capital e do juro cobrado no período anterior. Exemplo: em um empréstimo de R$1.000, com taxa de juros composta de 8% a.a., com duração de 2 anos, o total de juros será R$80 no primeiro ano. No segundo ano, os juros vão ser somados ao capital (R$1.000 + R$ 80 = R$ 1.080), resultando em juros de R$ 86 (8%de R$ 1.080))"
enum:
- SIMPLES
- COMPOSTO
example: SIMPLES
taxPeriodicity:
type: string
description: |
"Periodicidade da taxa . (Vide Enum)
a.m - ao mês
a.a. - ao ano"
enum:
- AM
- AA
example: AA
calculation:
type: string
description: Base de cálculo
enum:
- 21/252
- 30/360
- 30/365
example: 21/252
referentialRateIndexerType:
type: string
description: |
"Tipos de taxas referenciais ou indexadores, conforme Anexo 5: Taxa referencial ou Indexador (Indx), do Documento 3040"
enum:
- SEM_TIPO_INDEXADOR
- PRE_FIXADO
- POS_FIXADO
- FLUTUANTES
- INDICES_PRECOS
- CREDITO_RURAL
- OUTROS_INDEXADORES
example: PRE_FIXADO
referentialRateIndexerSubType:
type: string
description: |
"Sub tipos de taxas referenciais ou indexadores, conforme Anexo 5: Taxa referencial ou Indexador (Indx), do Documento 3040"
enum:
- SEM_SUB_TIPO_INDEXADOR
- PRE_FIXADO
- TR_TBF
- TJLP
- LIBOR
- TLP
- OUTRAS_TAXAS_POS_FIXADAS
- CDI
- SELIC
- OUTRAS_TAXAS_FLUTUANTES
- IGPM
- IPCA
- IPCC
- OUTROS_INDICES_PRECO
- TCR_PRE
- TCR_POS
- TRFC_PRE
- TRFC_POS
- OUTROS_INDEXADORES
example: TJLP
referentialRateIndexerAdditionalInfo:
type: string
maxLength: 140
pattern: '^(?!\s)[\w\W\s]*[^\s]$'
example: Informações adicionais
description: |
Campo livre para complementar a informação relativa ao Tipo de taxa referencial ou indexador.
[Restrição] Obrigatório para complementar a informação relativa ao Tipo de taxa referencial ou indexador, quando selecionada o tipo ou subtipo OUTRO.
preFixedRate:
type: string
format: double
maxLength: 9
minLength: 8
pattern: '^\d{1,2}\.\d{6}$'
example: '0.600000'
description: |
Taxa pré fixada aplicada sob o contrato da modalidade crédito. p.ex. 0.014500.
O preenchimento deve respeitar as 6 casas decimais, mesmo que venham preenchidas com zeros(representação de porcentagem p.ex: 0.150000. Este valor representa 15%. O valor 1 representa 100%).
postFixedRate:
type: string
format: double
maxLength: 9
minLength: 8
pattern: '^\d{1,2}\.\d{6}$'
example: '0.550000'
description: |
Taxa pós fixada aplicada sob o contrato da modalidade crédito. p.ex. 0.014500.
O preenchimento deve respeitar as 6 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.150000. Este valor representa 15%. O valor 1 representa 100%).
additionalInfo:
type: string
maxLength: 1200
pattern: '^(?!\s)[\w\W\s]*[^\s]$'
example: Informações adicionais
description: |
Texto com informações adicionais sobre a composição das taxas de juros pactuadas.
[Restrição] Caso a instituição possua a informação para compartilhamento, esta deverá ser informada.
FinancingsBalloonPayment:
type: object
description: Lista que traz as datas de vencimento e valor das parcelas não regulares do contrato da modalidade de crédito consultada.
required:
- dueDate
- amount
properties:
dueDate:
type: string
format: date
pattern: '^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$'
description: 'Data de vencimento da parcela não regular a vencer do contrato da modalidade de crédito consultada, conforme especificação RFC-3339. p.ex. 2014-03-19'
maxLength: 10
example: '2020-01-10'
amount:
$ref: '#/components/schemas/FinancingsBalloonPaymentAmount'
FinancingsBalloonPaymentAmount:
type: object
required:
- amount
- currency
description: Valor monetário da parcela não regular a vencer
properties:
amount:
type: string
format: double
pattern: '^\d{1,15}\.\d{2,4}$'
maxLength: 20
minLength: 4
example: '1000.0400'
description: Valor monetário da parcela não regular a vencer. Expresso em valor monetário com no mínimo 2 casas e no máximo 4 casas decimais.
currency:
type: string
pattern: '^[A-Z]{3}$'
maxLength: 3
description: 'Moeda referente ao valor monetário, seguindo o modelo ISO-4217.'
example: BRL
FinancingsChargeOverParcel:
type: object
required:
- chargeType
- chargeAmount
properties:
chargeType:
$ref: '#/components/schemas/EnumContractFinanceChargeType'
chargeAmount:
type: string
format: double
pattern: '^-?\d{1,15}\.\d{2,4}$'
maxLength: 21
minLength: 4
example: '1000.0400'
description: Valor do pagamento do encargo pago fora da parcela. Expresso em valor monetário com no mínimo 2 casas e no máximo 4 casas decimais.
chargeAdditionalInfo:
type: string
pattern: '^(?!\s)[\w\W\s]*[^\s]$'
maxLength: 140
example: Informações adicionais
description: |
Campo livre para preenchimento das informações adicionais referente ao encargo.
[Restrição] Obrigatório quando chargeType for igual 'OUTROS'.
FinancingsContract:
type: object
description: Conjunto de informações referentes à identificação da operação de crédito de financiamentos
required:
- contractNumber
- ipocCode
- productName
- productType
- productSubType
- contractDate
- contractAmount
- instalmentPeriodicity
- CET
- amortizationScheduled
- interestRates
- contractedFees
- contractedFinanceCharges
properties:
contractNumber:
type: string
maxLength: 100
pattern: '^[\w\W]{1,100}$'
example: '1324926521496'
description: Número do contrato dado pela instituição contratante.
ipocCode:
type: string
maxLength: 67
minLength: 22
pattern: '^[\w\W]{22,67}$'
description: |
"Número padronizado do contrato - IPOC (Identificação Padronizada da Operação de Crédito). Segundo DOC 3040, composta por:
- **CNPJ da instituição:** 8 (oito) posições iniciais;
- **Modalidade da operação:** 4 (quatro) posições;
- **Tipo do cliente:** 1 (uma) posição( 1 = pessoa natural - CPF, 2= pessoa jurídica – CNPJ, 3 = pessoa física no exterior, 4 = pessoa jurídica no exterior, 5 = pessoa natural sem CPF e 6 = pessoa jurídica sem CNPJ);
- **Código do cliente:** O número de posições varia conforme o tipo do cliente:
1. Para clientes pessoa física com CPF (tipo de cliente = 1), informar as 11 (onze) posições do CPF;
2. Para clientes pessoa jurídica com CNPJ (tipo de cliente = 2), informar as 8 (oito) posições iniciais do CNPJ;
3. Para os demais clientes (tipos de cliente 3, 4, 5 e 6), informar 14 (catorze) posições com complemento de zeros à esquerda se a identificação tiver tamanho inferior;
- **Código do contrato:** 1 (uma) até 40 (quarenta) posições, sem complemento de caracteres."
example: '92792126019929279212650822221989319252576'
productName:
type: string
maxLength: 140
pattern: '^(?!\s)[\w\W\s]*[^\s]$'
example: Crédito Pessoal Consignado
description: |
Denominação/Identificação do nome da Modalidade da Operação de Crédito divulgado ao cliente
productType:
$ref: '#/components/schemas/EnumProductType'
productSubType:
$ref: '#/components/schemas/EnumProductSubType'
contractDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$'
example: '2018-01-05'
description: Data de contratação da operação de crédito. Especificação RFC-3339
disbursementDates:
type: array
minItems: 1
description: |
Lista que traz as Datas de Desembolso do valor contratado.
items:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$'
example: '2018-01-15'
description: |
Data do Desembolso do valor contratado. Especificação RFC-3339.
No caso de uma liberação de recursos feita em D0 mas com referência retroativa feita em D -1, contabilmente a data correta seria D -1.
settlementDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$'
example: '2018-01-15'
description: |
Data de liquidação da operação.
contractAmount:
type: string
format: double
pattern: '^\d{1,15}\.\d{2,4}$'
maxLength: 20
minLength: 4
example: '1000.0400'
description: Valor contratado da operação. Expresso em valor monetário com no mínimo 2 casas e no máximo 4 casas decimais. Nos casos em que não houver este valor explícito no contrato do produto, enviar como 0.00.
currency:
type: string
pattern: '^(\w{3}){1}$'
maxLength: 3
description: |
Moeda referente ao valor da garantia, segundo modelo ISO-4217. p.ex. 'BRL'
Todos os valores monetários informados estão representados com a moeda vigente do Brasil
example: BRL
dueDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$'
example: '2028-01-15'
description: |
Data de vencimento Final da operação. Especificação RFC-3339.
instalmentPeriodicity:
type: string
description: |
"Informação relativa à periodicidade regular das parcelas. (Vide Enum)
sem periodicidade regular, semanal, quinzenal, mensal, bimestral, trimestral, semestral, anual"
enum:
- SEM_PERIODICIDADE_REGULAR
- SEMANAL
- QUINZENAL
- MENSAL
- BIMESTRAL
- TRIMESTRAL
- SEMESTRAL
- ANUAL
- OUTROS
example: SEMANAL
instalmentPeriodicityAdditionalInfo:
type: string
pattern: '^(?!\s)[\w\W\s]*[^\s]$'
maxLength: 50
example: Informações adicionais sobre periodicidade
description: |
Campo para complementar a informação relativa à periodicidade de pagamento regular.
[Restrição] Obrigatório quando o campo instalmentPeriodicity for igual a OUTROS.
firstInstalmentDueDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$'
example: '2018-02-15'
description: |
Data de vencimento primeira parcela do principal.
CET:
type: string
format: double
maxLength: 13
minLength: 8
pattern: '^\d{1,6}\.\d{6}$'
example: '0.290000'
description: |
CET – Custo Efetivo Total deve ser expresso na forma de taxa percentual anual e incorpora todos os encargos e despesas incidentes nas operações de crédito (taxa de juro, mas também tarifas, tributos, seguros e outras despesas cobradas).
O preenchimento deve respeitar as 6 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.150000.
Este valor representa 15%. O valor 1 representa 100%).
Para o público PF (pessoa física) o campo é de envio obrigatório para contratos firmados a partir de 2008, conforme Resolução CMN 3.517. Para o público PJ (pessoa jurídica) o campo é de envio obrigatório para contratos firmados a partir de 2011, conforme Resolução CMN 3.909. Excepcionalmente nos casos de operações de crédito rural, o envio do campo CET será obrigatório a partir de 2019, conforme Resolução CMN 4.699. O campo poderá ser preenchido com 0.00 em cenários nos quais a casa não tenha a informação de CET (Custo efetivo total) apenas para as exceções listadas abaixo:
- Em contratos anteriores a 2008 (para o público PF);
- Em contratos anteriores a 2011 (para o público PJ);
- Em contratos anteriores a 2019 para os casos de operações de crédito rural (ambos os públicos PF e PJ);
- Público PJ de médio ou grande porte.
amortizationScheduled:
type: string
description: |
Sistema de amortização (Vide Enum):
- SAC (Sistema de Amortização Constante) - É aquele em que o valor da amortização permanece igual até o final. Os juros cobrados sobre o parcelamento não entram nesta conta.
- PRICE (Sistema Francês de Amortização) - As parcelas são fixas do início ao fim do contrato. Ou seja, todas as parcelas terão o mesmo valor, desde a primeira até a última. Nos primeiros pagamentos, a maior parte do valor da prestação corresponde aos juros. Ao longo do tempo, a taxa de juros vai decrescendo. Como o valor da prestação é fixo, com o passar das parcelas, o valor de amortização vai aumentando.
- SAM (Sistema de Amortização Misto) - Cada prestação (pagamento) é a média aritmética das prestações respectivas no Sistemas Price e no Sistema de Amortização Constante (SAC).
- SEM SISTEMA DE AMORTIZAÇÃO
enum:
- SAC
- PRICE
- SAM
- SEM_SISTEMA_AMORTIZACAO
- OUTROS
example: SAC
amortizationScheduledAdditionalInfo:
type: string
pattern: '^(?!\s)[\w\W\s]*[^\s]$'
maxLength: 200
example: Informações complementares relativa à amortização do tipo 'OUTROS'
description: |
Campo para complementar a informação relativa à amortização.
[Restrição] Obrigatório quando o campo amortizationScheduled for igual a OUTROS.
interestRates:
type: array
minItems: 0
description: |
Objeto que traz o conjunto de informações necessárias para demonstrar a composição das taxas de juros remuneratórios da Modalidade de crédito.
Caso o contrato não possua taxas de juros, deve ser compartilhada uma lista vazia. Caso o contrato possua uma taxa de juros com valor 0, deve ser compartilhado um objeto com o valor 0 de forma explícita.
items:
$ref: '#/components/schemas/FinancingsContractInterestRate'
contractedFees:
type: array
minItems: 0
description: |
Lista que traz as informações das tarifas pactuadas no contrato.
items:
$ref: '#/components/schemas/FinancingsContractFee'
contractedFinanceCharges:
type: array
minItems: 0
description: Lista que traz os encargos pactuados no contrato
items:
$ref: '#/components/schemas/FinancingsFinanceCharge'
FinancingsContractFee:
type: object
description: Objeto que traz o conjunto de informações necessárias para demonstrar a composição das taxas de juros remuneratórios da Modalidade de crédito
required:
- feeName
- feeCode
- feeChargeType
- feeCharge
properties:
feeName:
type: string
maxLength: 140
pattern: '^(?!\s)[\w\W\s]*[^\s]$'
description: Denominação da Tarifa pactuada
example: Excesso em Conta
feeCode:
type: string
maxLength: 140
pattern: '^(?!\s)[\w\W\s]*[^\s]$'
description: Sigla identificadora da tarifa pactuada
example: EXCESSO_CONTA
feeChargeType:
type: string
description: Tipo de cobrança para a tarifa pactuada no contrato.
enum:
- UNICA
- POR_PARCELA
example: UNICA
feeCharge:
type: string
description: |
"Forma de cobrança relativa a tarifa pactuada no contrato. (Vide Enum)
- Mínimo
- Máximo
- Fixo
- Percentual"
enum:
- MINIMO
- MAXIMO
- FIXO
- PERCENTUAL
example: MINIMO
feeAmount:
type: string
format: double
pattern: '^\d{1,15}\.\d{2,4}$'
maxLength: 20
minLength: 4
example: '1000.0400'
description: |
Valor monetário da tarifa pactuada no contrato.
[Restrição] Preenchimento obrigatório quando a forma de cobrança for diferente de Percentual.
feeRate:
type: string
format: double
maxLength: 8
minLength: 8
pattern: '^\d{1}\.\d{6}$'
description: |
É o valor da tarifa em percentual pactuada no contrato.
[Restrição] Preenchimento obrigatório quando a forma de cobrança for Percentual.
example: '0.200000'
FinancingsFeeOverParcel:
type: object
required:
- feeName
- feeCode
- feeAmount
properties:
feeName:
type: string
maxLength: 140
pattern: '^(?!\s)[\w\W\s]*[^\s]$'
example: Reavaliação periódica do bem
description: |
Denominação da Tarifa pactuada.
feeCode:
type: string
maxLength: 140
pattern: '^(?!\s)[\w\W\s]*[^\s]$'
example: aval_bem
description: |
Sigla identificadora da tarifa pactuada.
feeAmount:
type: string
format: double
pattern: '^\d{1,15}\.\d{2,4}$'
maxLength: 20
minLength: 4
example: '1000.0400'
description: |
Valor monetário da tarifa pactuada no contrato.
Expresso em valor monetário com no mínimo 2 casas e no máximo 4 casas decimais.
FinancingsFinanceCharge:
type: object
description: Conjunto de informações referentes à identificação da operação de crédito
required:
- chargeType
properties:
chargeType:
$ref: '#/components/schemas/EnumContractFinanceChargeType'
chargeAdditionalInfo:
type: string
maxLength: 50
description: |
Campo para informações adicionais.
[Restrição] Obrigatório se selecionada a opção 'OUTROS' em Tipo de encargo pactuado no contrato.
pattern: '^(?!\s)[\w\W\s]*[^\s]$'
example: Informações adicionais sobre encargos.
chargeRate:
type: string
format: double
pattern: '^\d{1}\.\d{6}$'
maxLength: 8
minLength: 8
description: |
Representa o valor do encargo em percentual pactuado no contrato.
O preenchimento deve respeitar as 6 casas decimais, mesmo que venham preenchidas com zeros(representação de porcentagem p.ex: 0.150000.
Este valor representa 15%. O valor 1 representa 100%).
example: '0.071200'
FinancingsInstalments:
type: object
description: Conjunto de informações referentes às parcelas / prestações da operação de crédito de financiamentos contratada
required:
- typeContractRemaining
- typeNumberOfInstalments
- paidInstalments
properties:
typeNumberOfInstalments:
type: string
description: Tipo de prazo total do contrato referente à modalidade de crédito informada.
enum:
- DIA
- SEMANA
- MES
- ANO
- SEM_PRAZO_TOTAL
example: MES
totalNumberOfInstalments:
type: number
example: 130632
maximum: 999999
description: |
Prazo Total segundo o tipo (dia, semana, mês, ano) referente à Modalidade de Crédito informada.
[Restrição] Obrigatoriamente deve ser preenchido caso o typeNumberOfInstalments seja diferente de SEM_PRAZO_TOTAL.
typeContractRemaining:
type: string
enum:
- DIA
- SEMANA
- MES
- ANO