forked from bacen/pix-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
5110 lines (4912 loc) · 207 KB
/
openapi.yaml
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 Pix
version: "2.6.2"
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0
contact:
name: Suporte PIX BCB
email: suporte.pix@bcb.gov.br
url: https://www.bcb.gov.br/estabilidadefinanceira/pix
description: |-
A API Pix padroniza serviços oferecidos pelo PSP recebedor no contexto do arranjo Pix,
como criação de cobrança, verificação de Pix recebidos, devolução e consultas.
Os serviços expostos pelo PSP recebedor permitem ao usuário recebedor estabelecer integração
de sua automação com os serviços Pix do PSP.
# Evolução da API Pix
A API Pix busca respeitar __[SemVer](https://semver.org/lang/pt-BR/)__. Nesse sentido,
mudanças compatíveis não devem gerar nova versão _major_.
A versão da API é composta por 4 elementos: _major_, _minor_, _patch_ e _release candidate_.
A versão `v[x]`que consta no path da URL é o elemento _major_ da versão da API.
A evolução da versão se dá seguinte forma:
- Major: alterações incompatíveis, com quebra de contrato (v1.0.0 → v2.0.0)
- Minor: alterações compatíveis, sem quebra de contrato (v1.1.0 → v1.2.0)
- Patch: bugfixes, esclarecimentos às especificações, sem alterações funcionais (v1.1.1 → v1.1.2)
- Release candidate: versões de pré-lançamento de qualquer patch futuro, minor ou major (v1.0.0-rc.1 → v1.0.0-rc.22)
Alterações sem quebra de contrato e esclarecimentos às especificações podem ocorrer a qualquer momento.
Clientes devem estar preparados para lidar com essas mudanças sem quebrar.
As seguintes mudanças são esperadas e consideradas retrocompatíveis:
- Adição de novos recursos na API Pix.
- Adição de novos parâmetros opcionais a cobranças.
- Adição de novos campos em respostas da API Pix.
- Alteração da ordem de campos.
- Adição de novos elementos em enumerações
# Tratamento de erros
A API Pix retorna códigos de status HTTP para indicar sucesso ou falhas das
requisições.
Códigos `2xx` indicam sucesso. Códigos `4xx` indicam falhas causadas pelas
informações enviadas pelo cliente ou pelo estado atual das entidades. Códigos `5xx`
indicam problemas no serviço no lado da API Pix.
As respostas de erro incluem no corpo detalhes do erro seguindo o
_schema_ da [RFC 7807](https://tools.ietf.org/html/rfc7807).
O campo `type` identifica o tipo de erro e na API Pix segue o padrão:
`https://pix.bcb.gov.br/api/v2/error/<TipoErro>`
O padrão acima listado, referente ao campo `type`, não consiste, necessariamente, em uma
URL que apresentará uma página web válida, ou um endpoint válido, embora possa, futuramente,
ser exatamente o caso. O objetivo primário é apenas e tão somente identificar o tipo de erro.
Abaixo estão listados os tipos de erro e possíveis violações da API Pix.
## Gerais
Esta seção reúne erros que poderiam ser retornados por quaisquer endpoints listados na API Pix.
### `RequisicaoInvalida`
* __Significado__: Requisição inválida.
* __HTTP Status Code__: [400 Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1).
### `AcessoNegado`
* __Significado__: Requisição de participante autenticado que viola alguma regra de autorização.
* __HTTP Status Code__: [403 Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3).
### `NaoEncontrado`
* __Significado__: Entidade não encontrada.
* __HTTP Status Code__: [404 Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4).
### `PermanentementeRemovido`
* __Significado__: Indica que a entidade existia, mas foi permanentemente removida.
* __HTTP Status Code__: [410 Gone](https://tools.ietf.org/html/rfc7231#section-6.5.9).
### `ErroInternoDoServidor`
* __Significado__: Condição inesperada ao processar requisição.
* __HTTP Status Code__: [500 Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1).
### `ServicoIndisponivel`
* __Significado__: Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento.
* __HTTP Status Code__: [503 Service Unavailable](https://tools.ietf.org/html/rfc7231#section-6.6.4).
### `IndisponibilidadePorTempoEsgotado`
* __Significado__: Indica que o serviço demorou além do esperado para retornar.
* __HTTP Status Code__: [504 Gateway Timeout](https://tools.ietf.org/html/rfc7231#section-6.6.5).
## Tag CobPayload
Esta seção reúne erros retornados pelos endpoints organizados sob a tag `CobPayload`.
Estes erros indicam problemas na tentativa de recuperação, via _location_, do Payload JSON que representa a cobrança.
### `CobPayloadNaoEncontrado`
* __Significado__: a cobrança em questão não foi encontrada para a location requisitada.
* __HTTP Status Code__: [404](https://tools.ietf.org/html/rfc7231#section-6.5.4) ou [410](https://tools.ietf.org/html/rfc7231#section-6.5.9).
* __endpoints__: `GET /{pixUrlAccessToken}`, `GET /cobv/{pixUrlAccessToken}`.
Se a presente location exibia uma cobrança, mas não a exibirá mais de maneira permanentemente,
pode-se aplicar o HTTP status code [410](https://tools.ietf.org/html/rfc7231#section-6.5.9). Se a presente location não
está exibindo nenhuma cobrança, pode-se utilizar o HTTP status code [404](https://tools.ietf.org/html/rfc7231#section-6.5.4).
Uma cobrança pode estar "expirada" (`calendario.expiracao`), "vencida", "Concluida",
entre outros estados em que não poderia ser efetivamente paga. Nesses casos, é uma liberalidade
do PSP recebedor retornar o presente código de erro ou optar por servir o payload de qualquer maneira,
objetivando fornecer uma informação adicional ao usuário pagador final a respeito da cobrança.
### `CobPayloadOperacaoInvalida`
* __Significado__: a cobrança existe, mas a requisição é inválida.
* __HTTP Status Code__: [400](https://tools.ietf.org/html/rfc7231#section-6.5.1).
* __endpoints__: `GET /cobv/{pixUrlAccessToken}`.
__Violações__:
- `codMun` não respeita o _schema_.
- `codMun` não é um código válido segundo a __[tabela de municípios do IBGE](https://www.ibge.gov.br/explica/codigos-dos-municipios.php)__.
- `DPP` não respeita o _schema_.
- `DPP` anterior ao momento presente.
- `DPP` superior à validade da cobrança em função dos parâmetros `calendario.dataDeVencimento`
e `calendario.validadeAposVencimento`. Exemplo: `dataDeVencimento` => 2020-12-25,
`validadeAposVencimento` => 10, `DPP` => 2021-01-05. Neste exemplo, o parâmetro `DPP` é
inválido considerando o contexto apresentado porque é uma data em que a cobrança
não poderá ser paga. A cobrança, neste exemplo, não será considerada válida
a partir da data 2021-01-05.
## Tag Cob
Esta seção reúne erros retornados pelos endpoints organizados sob a tag `Cob`.
Esses erros indicam problemas no gerenciamento de uma cobrança para pagamento imediato.
### `CobNaoEncontrado`
* __Significado__: Cobrança não encontrada para o txid informado.
* __HTTP Status Code__: [404](https://tools.ietf.org/html/rfc7231#section-6.5.4).
* __endpoints__: `[GET|PATCH] /cob/{txid}`.
### `CobOperacaoInvalida`
* __Significado__: a requisição que busca alterar ou criar uma cobrança para pagamento imediato
não respeita o _schema_ ou está semanticamente errada.
* __HTTP Status Code__: [400](https://tools.ietf.org/html/rfc7231#section-6.5.1).
* __endpoints__: `[POST|PUT|PATCH] /cob/{txid}`.
__Violações__ para os endpoints `PUT|PATCH /cob/{txid}`:
- O campo `cob.calendario.expiracao` é igual ou menor que `zero`.
- O campo `cob.valor.original` não respeita o _schema_.
- O campo `cob.valor.original` é `zero`.
- O objeto `cob.devedor` não respeita o _schema_.
- O campo `cob.chave` não respeita o _schema_.
- O campo `cob.chave` corresponde a uma conta que não pertence a este usuário recebedor.
- O campo `solicitacaoPagador` não respeita o _schema_.
- O objeto `infoAdicionais` não respeita o _schema_.
- O `location` referenciado por `loc.id` inexiste.
- O `location` referenciado por `loc.id` já está sendo utilizado por outra cobrança.
- O `location` referenciado por `cob.loc.id` apresenta tipo "cobv" (deveria ser "cob").
__Violações__ específicas para o endpoint `PUT /cob/{txid}`:
- A cobrança já existe, não está no status ATIVA, e a presente requisição busca alterá-la.
__Violações__ específicas para o endpoint `PATCH /cob/{txid}`:
- A cobrança não está ATIVA, e a presente requisição busca alterá-la.
- A cobrança está ATIVA, e a presente requisição propõe alterar
seu status para _REMOVIDA_PELO_USUARIO_RECEBEDOR_ juntamente com outras alterações
(não faz sentido remover uma cobrança ao mesmo tempo em que se realizam
alterações que não serão aproveitadas).
- o campo `cob.status` não respeita o _schema_.
### `CobConsultaInvalida`
* __Significado__: os parâmetros de consulta à lista de cobranças para pagamento imediato
não respeitam o _schema_ ou não fazem sentido semanticamente.
* __HTTP Status Code__: [400](https://tools.ietf.org/html/rfc7231#section-6.5.1).
* __endpoints__: `GET /cob` e `GET /cob/{txid}`.
__Violações__ específicas para o endpoint `GET /cob`:
- algum dos parâmetros informados para a consulta não respeita o _schema_.
- o _timestamp_ representado pelo parâmetro `fim` é anterior ao timestamp
representado pelo parâmetro `inicio`.
- ambos os parâmetros `cpf` e `cnpj` estão preenchidos.
- o parâmetro `paginacao.paginaAtual` é negativo.
- o parâmetro `paginacao.itensPorPagina` é negativo.
__Violações__ específicas para o endpoint `GET /cob/{txid}`:
- o parâmetro `revisao` corresponde a uma revisão inexistente para a cobrança
apontada pelo parâmetro `txid`.
## Tag CobV
Esta seção reúne erros retornados pelos endpoints organizados sob a tag `CobV`.
Esses erros indicam problemas no gerenciamento de uma cobrança com vencimento.
### `CobVNaoEncontrada`
* __Significado__: Cobrança com vencimento não encontrada para o txid informado.
* __HTTP Status Code__: [404](https://tools.ietf.org/html/rfc7231#section-6.5.4).
* __endpoints__: `[GET|PATCH] /cobv/{txid}`.
### `CobVOperacaoInvalida`
* __Significado__: a requisição que busca alterar ou criar uma cobrança com vencimento
não respeita o _schema_ ou está semanticamente errada.
* __HTTP Status Code__: [400](https://tools.ietf.org/html/rfc7231#section-6.5.1).
* __endpoints__: `[PUT|PATCH] /cobv/{txid}`.
__Violações__ para os endpoints `PUT|PATCH /cobv/{txid}`:
- Este `txid` está associado a um lote e no referido lote, o status desta cobrança está atribuído como
"EM_PROCESSAMENTO" ou "NEGADA".
- O campo `cobv.calendario.dataDeVencimento` é anterior à data de criação da cobrança.
- O campo `cobv.calendario.validadeAposVencimento` é menor do que zero.
- O objeto `cobv.devedor` não respeita o _schema_.
- O objeto `cobv.devedor` não respeita o _schema_.
- O campo `cobv.chave` não respeita o _schema_.
- O campo `cobv.chave` corresponde a uma conta que não pertence a este usuário recebedor.
- O campo `solicitacaoPagador` não respeita o _schema_.
- O objeto `infoAdicionais` não respeita o _schema_.
- O location referenciado por `cobv.loc.id` inexiste.
- O location referenciado por `cobv.loc.id` já está sendo utilizado por outra cobrança.
- O location referenciado por `cobv.loc.id` apresenta tipo "cob" (deveria ser "cobv").
- O campo `cobv.valor.original` não respeita o _schema_.
- O campo `cobv.valor.original` apresenta o valor `zero`.
- O objeto `cobv.valor.multa` não respeita o _schema_.
- O objeto `cobv.valor.juros` não respeita o _schema_.
- O objeto `cobv.valor.abatimento` não respeita o _schema_.
- O objeto `cobv.valor.desconto` não respeita o _schema_.
- O objeto `cobv.valor.abatimento` representa um valor maior ou igual ao valor da
cobrança original ou maior ou igual a 100%.
- O objeto `cobv.valor.desconto` apresenta algum elemento de desconto que representa um valor maior ou
igual ao valor da cobrança original ou maior ou igual a 100%.
- O objeto `cobv.valor.desconto` apresenta algum elemento cuja data seja posterior à data de vencimento
representada por `calendario.dataDeVencimento`.
- O objeto `cobv.valor.desconto` apresenta modalidade no valor `1` ou `2`,
porém `cobv.valor.desconto.valorPerc` encontra-se preenchido
- O objeto `cobv.valor.desconto` apresenta modalidade no valor `1` ou `2`, porém
o array `cobv.valor.desconto.descontoDataFixa` está vazio ou nulo.
- O objeto `cobv.valor.desconto` apresenta modalidade nos valores de `3` a `6`, porém
o elemento `cobv.valor.desconto.valorPerc` não está preenchido.
- O objeto `cobv.valor.desconto` apresenta modalidade nos valores de `3` a `6`, porém
o elemento `cobv.valor.desconto.descontoDataFixa` está preenchido ou não nulo.
__Violações__ específicas para o endpoint `PUT /cobv/{txid}`:
- A cobrança já existe, não está ATIVA, e a presente requisição busca alterá-la
__Violações__ específicas para o endpoint `PATCH /cobv/{txid}`:
- A cobrança não está ATIVA, e a presente requisição busca alterá-la
- A cobrança está ATIVA, e a presente requisição propõe alterar
seu status para _REMOVIDA_PELO_USUARIO_RECEBEDOR_ juntamente com outras alterações
(não faz sentido remover uma cobrança ao mesmo tempo em que se realizam
alterações que não serão aproveitadas).
- o campo `cob.status` não respeita o _schema_.
### `CobVConsultaInvalida`
* __Significado__: os parâmetros de consulta à lista de cobranças com vencimento não respeitam o schema
ou não fazem sentido semanticamente.
* __HTTP Status Code__: [400](https://tools.ietf.org/html/rfc7231#section-6.5.1).
* __endpoints__: `GET /cobv` e `GET /cobv/{txid}`.
__Violações__ específicas para o endpoint `GET /cobv`:
- algum dos parâmetros informados para a consulta não respeita o _schema_.
- o _timestamp_ representado pelo parâmetro `fim` é anterior ao timestamp
representado pelo parâmetro `inicio`.
- ambos os parâmetros `cpf` e `cnpj` estão preenchidos.
- o parâmetro `paginacao.paginaAtual` é negativo.
- o parâmetro `paginacao.itensPorPagina` é negativo.
__Violações__ específicas para o endpoint `GET /cobv/{txid}`:
- o parâmetro `revisao` corresponde a uma revisão inexistente para a cobrança
apontada pelo parâmetro `txid`.
## Tag LoteCobV
Esta seção reúne erros referentes a endpoints que tratam do gerenciamento de lotes de cobrança.
### `LoteCobVNaoEncontrado`
* __Significado__: Lote não encontrado para o `id` informado.
* __HTTP Status Code__: [404](https://tools.ietf.org/html/rfc7231#section-6.5.4).
* __endpoints__: `[GET|PATCH] /lotecobv/{id}`.
### `LoteCobVOperacaoInvalida`
* __Significado__: a requisição que busca alterar ou criar um lote de cobranças com vencimento
não respeita o _schema_ ou está semanticamente errada.
* __HTTP Status Code__: [400](https://tools.ietf.org/html/rfc7231#section-6.5.1).
* __endpoints__: `[PUT|PATCH] /lotecobv/{id}`.
__Violações__ para os endpoints `PUT|PATCH /lotecobv/{id}`:
- O campo `loteCobV.descricao` não respeita o _schema_.
- O objeto `loteCobV.cobsV` não respeita o _schema_.
__Violações__ para o endpoint `PUT /lotecobv/{id}`:
- a presente requisição tenta criar um conjunto de cobranças dentre as quais pelo menos
uma cobrança já encontra-se criada.
- a presente requisição busca alterar um lote já existente, entretanto contém um array de
solicitações de alteração de cobranças que não referencia exatamente as mesmas cobranças
referenciadas pela requisição original que criou o lote.
Uma vez criado um lote, não se pode remover ou adicionar solicitações de
criação ou alteração de cobranças a este lote.
__Violações__ para o endpoint `PATCH /lotecobv/{id}`:
- a presente requisição busca alterar um lote já existente e contém, no `array`
de cobranças representado por `cobsv`, uma cobrança não existente no array de cobranças
atribuído pela requisição original que criou o lote.
Uma vez criado um lote, não se pode remover ou adicionar cobranças a este lote.
__Violações__ para os endpoints `GET /lotecobv/{id}`:
- __observação__: para cada elemento do array `cobsv`, retornado por este endpoint, caso a requisição de criação de cobrança esteja em
status "NEGADA", o atributo `problema` deste elemento deve ser preenchido respeitando
o [schema](https://tools.ietf.org/html/rfc7807) referenciado pela API Pix.
- o preenchimento do atributo `problema`, conforme descrito acima, segue o mesmo regramento dos
erros especificados para os endpoints `[PUT/PATCH /cobv/{txid}]`, de maneira a possibilitar, ao
usuário recebedor, entender qual foi a violação cometida ao se tentar criar
a cobrança referenciada por este elemento do array `cobsv`.
### `LoteCobVConsultaInvalida`
* __Significado__: os parâmetros de consulta à lista de lotes de cobrança com vencimento
não respeitam o _schema_ ou não fazem sentido semanticamente.
* __HTTP Status Code__: [400](https://tools.ietf.org/html/rfc7231#section-6.5.1).
* __endpoints__: `GET /lotecobv` e `GET /lotecobv/{id}`.
__Violações__ específicas para o endpoint `GET /lotecobv`:
- algum dos parâmetros informados para a consulta não respeitam o _schema_.
- o _timestamp_ representado pelo parâmetro `fim` é anterior ao timestamp
representado pelo parâmetro `inicio`.
- o parâmetro `paginacao.paginaAtual` é negativo.
- o parâmetro `paginacao.itensPorPagina` é negativo.
## Tag PayloadLocation
Esta seção reúne erros referentes a endpoints que tratam do gerenciamento de _locations_.
### `PayloadLocationNaoEncontrado`
* __Significado__: _Location_ não encontrada para o `id` informado.
* __HTTP Status Code__: [404](https://tools.ietf.org/html/rfc7231#section-6.5.4).
* __endpoints__: `[GET|PATCH] /loc/{id}`, `DELETE /loc/{id}/txid`.
### `PayloadLocationOperacaoInvalida`
* __Significado__: a presente requisição busca criar uma location sem respeitar o _schema_ estabelecido.
* __HTTP Status Code__: [400](https://tools.ietf.org/html/rfc7231#section-6.5.1).
* __endpoints__: `POST /loc`.
__Violações__ para o endpoint `POST /loc`:
- o campo `tipoCob` não respeita o _schema_.
### `PayloadLocationConsultaInvalida`
* __Significado__: os parâmetros de consulta à lista de _locations_ não respeitam
o _schema_ ou não fazem sentido semanticamente.
* __HTTP Status Code__: [400](https://tools.ietf.org/html/rfc7231#section-6.5.1).
* __endpoints__: `GET /loc` e `GET /loc/{id}`.
__Violações__ específicas para o endpoint `GET /loc`:
- algum dos parâmetros informados para a consulta não respeitam o _schema_.
- o _timestamp_ representado pelo parâmetro `fim` é anterior ao timestamp
representado pelo parâmetro `inicio`.
- o parâmetro `paginacao.paginaAtual` é negativo.
- o parâmetro `paginacao.itensPorPagina` é negativo.
## Tag Pix
Reúne erros em endpoints de gestão de Pix recebidos e solicitação de devoluções.
### `PixNaoEncontrado`
* __Significado__: pix não encontrada para o `e2eid` informado.
* __HTTP Status Code__: [404](https://tools.ietf.org/html/rfc7231#section-6.5.4).
* __endpoints__: `GET /pix/{e2eid}`
### `PixDevolucaoNaoEncontrada`
* __Significado__: devolução representada por {id} não encontrada para o `e2eid` informado.
* __HTTP Status Code__: [404](https://tools.ietf.org/html/rfc7231#section-6.5.4).
* __endpoints__: `GET /pix/{e2eid}/devolucao/{id}`
### `PixConsultaInvalida`
* __Significado__: os parâmetros de consulta à lista de pix recebidos não respeitam o schema
ou não fazem sentido semanticamente.
* __HTTP Status Code__: [400](https://tools.ietf.org/html/rfc7231#section-6.5.1).
* __endpoints__: `GET /pix`.
__Violações__ específicas para o endpoint `GET /pix`:
- algum dos parâmetros informados para a consulta não respeita o _schema_.
- o _timestamp_ representado pelo parâmetro `fim` é anterior ao timestamp
representado pelo parâmetro `inicio`.
- ambos os parâmetros `cpf` e `cnpj` estão preenchidos.
- o parâmetro `paginacao.paginaAtual` é negativo.
- o parâmetro `paginacao.itensPorPagina` é negativo.
### `PixDevolucaoInvalida`
* __Significado__: a presente requisição de devolução não respeita o _schema_ ou não faz sentido semanticamente.
* __HTTP Status Code__: [400](https://tools.ietf.org/html/rfc7231#section-6.5.1).
* __endpoints__: `PUT /pix/{e2eid}/devolucao/{id}`.
__Violações__ específicas para o endpoint `PUT /pix/{e2eid}/devolucao/{id}`:
- O campo `devolucao.valor` não respeita o _schema_.
- A presente requisição de devolução, em conjunto com as demais prévias devoluções,
se aplicável, excederia o valor do pix originário.
- A presente requisição de devolução apresenta um `{id}` já utilizado por outra requisição de
devolução para o `{e2eid}` em questão.
- A presente requisição de devolução viola a janela de tempo permitida para solicitações de devoluções
de um pix (hoje estabelecida como 90 dias desde a data de liquidação original do pix).
## Tag Webhook
Reúne erros dos endpoints que tratam do gerenciamento dos Webhooks da API Pix.
### `WebhookOperacaoInvalida`
* __Significado__: a presente requisição busca criar um webhook sem respeitar o _schema_ ou,
ainda, apresenta semântica inválida.
* __HTTP Status Code__: [400](https://tools.ietf.org/html/rfc7231#section-6.5.1).
* __endpoints__: `PUT /webhook/{chave}`.
__Violações__ para o endpoint `PUT /webhook/{chave}`:
- o parâmetro {chave} não corresponde a uma chave DICT válida.
- o parâmetro {chave} não corresponde a uma chave DICT pertencente a este usuário recebedor.
- Campo webhook.webhookUrl não respeita o _schema_.
### `WebhookNaoEncontrado`
* __Significado__: o webhook denotado por {chave} não encontra-se estabelecido.
* __HTTP Status Code__: [404](https://tools.ietf.org/html/rfc7231#section-6.5.4).
* __endpoints__: `GET /webhook/{chave}`, `DELETE /webhook/{chave}`
### `WebhookConsultaInvalida`
* __Significado__: os parâmetros de consulta à lista de webhooks ativados não respeitam o schema
ou não fazem sentido semanticamente.
* __HTTP Status Code__: [400](https://tools.ietf.org/html/rfc7231#section-6.5.1).
* __endpoints__: `GET /webhook`.
__Violações__ específicas para o endpoint `GET /webhook`:
- algum dos parâmetros informados para a consulta não respeita o _schema_.
- o _timestamp_ representado pelo parâmetro `fim` é anterior ao timestamp
representado pelo parâmetro `inicio`.
- o parâmetro `paginacao.paginaAtual` é negativo.
- o parâmetro `paginacao.itensPorPagina` é negativo.
servers:
- url: https://pix.example.com/api/
description: Servidor de Produção
- url: https://pix-h.example.com/api/
description: Servidor de Homologação
tags:
- name: CobPayload
x-displayName: Reúne endpoints (locations) que retornam o Payload JSON que representa uma Cobrança
description: |-
Reúne endpoints (locations) utilizados pelo software do PSP pagador para recuperar o payload JSON que representa uma cobrança.
Os endpoints listados nesta Tag apresentam requisitos de autenticação e autorização diferenciados em relação aos outros endpoints listados na presente API.
São endpoints __abertos__ para que qualquer cliente da internet possa se conectar. Cada _location_ é uma _[url de capacidade](https://www.w3.org/TR/capability-urls/)_, funcionalidade implementada via o fragmento `{pixUrlAccessToken}`.
Para mais informações, consultar o [Manual de Padrões para iniciação do Pix](https://www.bcb.gov.br/estabilidadefinanceira/pix).
- name: Cob
x-displayName: Gerenciamento de cobranças para pagamento imediato
description: |-
Reúne endpoints destinados a lidar com gerenciamento de cobranças imediatas.
- name: CobV
x-displayName: Gerenciamento de cobranças com vencimento
description: |-
Reúne endpoints destinados a lidar com gerenciamento de cobranças com vencimento.
- name: LoteCobV
x-displayName: Gerenciamento de cobranças com vencimento em lote
description: |-
Reúne endpoints destinados a lidar com gerenciamento de cobranças com vencimento em lote.
- name: PayloadLocation
x-displayName: Configuração de locations para payloads
description: |-
Reúne endpoints destinados a lidar com configuração e remoção de locations para uso dos payloads
- name: Pix
x-displayName: Gerenciamento de Pix recebidos
description: |-
reúne endpoints destinados a lidar com gerenciamento de Pix recebidos.
- name: Webhook
x-displayName: Gerenciamento de notificações
description: |-
Reúne endpoints para gerenciamento de notificações por parte do PSP recebedor ao usuário recebedor.
paths:
/cob/{txid}:
parameters:
- name: txid
in: path
required: true
schema:
$ref: "#/components/schemas/TxId"
put:
tags:
- "Cob"
summary: "Criar cobrança imediata."
security:
- OAuth2: [cob.write]
description: |-
Endpoint para criar uma cobrança imediata.
requestBody:
$ref: "#/components/requestBodies/CobBody"
responses:
"201":
description: "Cobrança imediata criada"
content:
"application/json":
schema:
$ref: "#/components/schemas/CobGerada"
examples:
retorno1:
$ref: "#/components/examples/cobResponse1"
retorno2:
$ref: "#/components/examples/cobResponse5"
retorno3:
$ref: "#/components/examples/cobResponse6"
retorno4:
$ref: "#/components/examples/cobResponse7"
"400":
description: "Requisição com formato inválido."
content:
application/problem+json:
schema:
$ref: "#/components/schemas/Problema"
examples:
exemplo1:
$ref: "#/components/examples/RequisicaoInvalidaCobExample1"
"403":
$ref: "#/components/responses/AcessoNegado"
"404":
$ref: "#/components/responses/NaoEncontrado"
"503":
$ref: "#/components/responses/ServicoIndisponivel"
patch:
tags:
- "Cob"
summary: "Revisar cobrança imediata."
security:
- OAuth2: [cob.write]
requestBody:
$ref: "#/components/requestBodies/CobBodyRevisada"
responses:
"200":
description: "Cobrança imediata revisada. A revisão deve ser incrementada em 1."
content:
"application/json":
schema:
$ref: "#/components/schemas/CobGerada"
examples:
retorno1:
$ref: "#/components/examples/cobResponse3"
"400":
description: "Requisição com formato inválido."
content:
application/problem+json:
schema:
$ref: "#/components/schemas/Problema"
examples:
exemplo1:
$ref: "#/components/examples/OperacaoInvalidaCobExample1"
"403":
$ref: "#/components/responses/AcessoNegado"
"404":
$ref: "#/components/responses/NaoEncontrado"
"503":
$ref: "#/components/responses/ServicoIndisponivel"
get:
parameters:
- name: "revisao"
in: "query"
required: false
schema:
$ref: "#/components/schemas/Revisao"
tags:
- "Cob"
summary: "Consultar cobrança imediata."
security:
- OAuth2: [cob.read]
description: |-
Endpoint para consultar uma cobrança através de um determinado txid.
responses:
"200":
description: "Dados da cobrança imediata."
content:
"application/json":
schema:
$ref: "#/components/schemas/CobCompleta"
examples:
retorno1:
$ref: "#/components/examples/cobResponse1"
retorno2:
$ref: "#/components/examples/cobResponse2"
retorno3:
$ref: "#/components/examples/cobResponse5"
retorno4:
$ref: "#/components/examples/cobResponse6"
retorno5:
$ref: "#/components/examples/cobResponse7"
"403":
$ref: "#/components/responses/AcessoNegado"
"404":
$ref: "#/components/responses/NaoEncontrado"
"503":
$ref: "#/components/responses/ServicoIndisponivel"
"/cob":
post:
tags:
- "Cob"
summary: "Criar cobrança imediata."
security:
- OAuth2: [cob.write]
description: |-
Endpoint para criar uma cobrança imediata, neste caso, o txid deve ser definido pelo PSP.
requestBody:
$ref: "#/components/requestBodies/CobBody"
responses:
"201":
description: "Cobrança imediata criada"
content:
"application/json":
schema:
$ref: "#/components/schemas/CobGerada"
examples:
retorno1:
$ref: "#/components/examples/cobResponse1"
retorno2:
$ref: "#/components/examples/cobResponse5"
retorno3:
$ref: "#/components/examples/cobResponse6"
retorno4:
$ref: "#/components/examples/cobResponse7"
"400":
description: "Requisição com formato inválido."
content:
application/problem+json:
schema:
$ref: "#/components/schemas/Problema"
examples:
exemplo1:
$ref: "#/components/examples/RequisicaoInvalidaCobExample1"
"403":
$ref: "#/components/responses/AcessoNegado"
"503":
$ref: "#/components/responses/ServicoIndisponivel"
get:
parameters:
- in: "query"
name: "inicio"
required: true
schema:
$ref: "#/components/schemas/Inicio"
- in: "query"
name: "fim"
required: true
schema:
$ref: "#/components/schemas/Fim"
- name: "cpf"
in: "query"
schema:
type: "string"
title: "CPF"
pattern: "/^\\d{11}$/"
description: "Filtro pelo CPF do devedor. Não pode ser utilizado ao mesmo tempo que o CNPJ."
- name: "cnpj"
in: "query"
schema:
type: "string"
title: "CNPJ"
pattern: "/^\\d{14}$/"
description: "Filtro pelo CNPJ do devedor. Não pode ser utilizado ao mesmo tempo que o CPF."
- name: "locationPresente"
in: "query"
schema:
type: "boolean"
- name: "status"
in: "query"
schema:
type: "string"
title: "Status do registro da cobrança"
description: "Filtro pelo status da cobrança."
- $ref: "#/components/parameters/paginaAtual"
- $ref: "#/components/parameters/itensPorPagina"
tags:
- "Cob"
summary: "Consultar lista de cobranças imediatas."
security:
- OAuth2: [cob.read]
description: |-
Endpoint para consultar cobranças imediatas através de parâmetros como início, fim, cpf, cnpj e status.
responses:
"200":
description: "Lista de cobranças imediatas."
content:
"application/json":
schema:
$ref: "#/components/schemas/CobsConsultadas"
examples:
getCobs1:
$ref: "#/components/examples/getCobs1"
getCobs2:
$ref: "#/components/examples/getCobs2"
"403":
$ref: "#/components/responses/AcessoNegado"
"503":
$ref: "#/components/responses/ServicoIndisponivel"
"/cobv/{txid}":
parameters:
- name: "txid"
in: "path"
required: true
schema:
$ref: "#/components/schemas/TxId"
put:
tags:
- "CobV"
summary: "Criar cobrança com vencimento."
security:
- OAuth2: [cobv.write]
description: |-
Endpoint para criar uma cobrança com vencimento.
requestBody:
$ref: "#/components/requestBodies/CobVBody"
responses:
"201":
description: "Cobrança com vencimento criada"
content:
"application/json":
schema:
$ref: "#/components/schemas/CobVGerada"
examples:
retorno1:
$ref: "#/components/examples/cobResponse4"
"400":
description: "Requisição com formato inválido."
content:
application/problem+json:
schema:
$ref: "#/components/schemas/Problema"
examples:
exemplo1:
$ref: "#/components/examples/RequisicaoInvalidaCobVExample1"
"403":
$ref: "#/components/responses/AcessoNegado"
"404":
$ref: "#/components/responses/NaoEncontrado"
"503":
$ref: "#/components/responses/ServicoIndisponivel"
patch:
tags:
- "CobV"
summary: "Revisar cobrança com vencimento."
security:
- OAuth2: [cobv.write]
requestBody:
$ref: "#/components/requestBodies/CobVBodyRevisada"
responses:
"200":
description: "Cobrança com vencimento revisada. A revisão deve ser incrementada em 1."
content:
"application/json":
schema:
$ref: "#/components/schemas/CobVGerada"
examples:
retorno1:
$ref: "#/components/examples/cobResponse4"
"400":
description: "Requisição com formato inválido."
content:
application/problem+json:
schema:
$ref: "#/components/schemas/Problema"
examples:
exemplo1:
$ref: "#/components/examples/OperacaoInvalidaCobVExample1"
"403":
$ref: "#/components/responses/AcessoNegado"
"404":
$ref: "#/components/responses/NaoEncontrado"
"503":
$ref: "#/components/responses/ServicoIndisponivel"
get:
parameters:
- name: "revisao"
in: "query"
required: false
schema:
$ref: "#/components/schemas/Revisao"
tags:
- "CobV"
summary: "Consultar cobrança com vencimento."
security:
- OAuth2: [cobv.read]
description: |-
Endpoint para consultar uma cobrança com vencimento através de um determinado txid.
responses:
"200":
description: "Dados da cobrança com vencimento."
content:
"application/json":
schema:
$ref: "#/components/schemas/CobVCompleta"
examples:
retorno1:
$ref: "#/components/examples/cobResponse4"
"403":
$ref: "#/components/responses/AcessoNegado"
"404":
$ref: "#/components/responses/NaoEncontrado"
"503":
$ref: "#/components/responses/ServicoIndisponivel"
"/cobv":
get:
parameters:
- in: "query"
name: "inicio"
required: true
schema:
$ref: "#/components/schemas/Inicio"
- in: "query"
name: "fim"
required: true
schema:
$ref: "#/components/schemas/Fim"
- name: "cpf"
in: "query"
schema:
type: "string"
title: "CPF"
pattern: "/^\\d{11}$/"
description: "Filtro pelo CPF do devedor. Não pode ser utilizado ao mesmo tempo que o CNPJ."
- name: "cnpj"
in: "query"
schema:
type: "string"
title: "CNPJ"
pattern: "/^\\d{14}$/"
description: "Filtro pelo CNPJ do devedor. Não pode ser utilizado ao mesmo tempo que o CPF."
- name: "locationPresente"
in: "query"
schema:
type: "boolean"
- name: "status"
in: "query"
schema:
type: "string"
title: "Status do registro da cobrança"
description: "Filtro pelo status da cobrança."
- name: "loteCobVId"
in: "query"
schema:
type: "integer"
format: "int32"
title: "Id do lote de cobrança com vencimento"
description: "Id do lote de cobrança com vencimento."
- $ref: "#/components/parameters/paginaAtual"
- $ref: "#/components/parameters/itensPorPagina"
tags:
- "CobV"
summary: "Consultar lista de cobranças com vencimento."
security:
- OAuth2: [cobv.read]
description: |-
Endpoint para consultar cobranças com vencimento através de parâmetros como início, fim, cpf, cnpj e status.
responses:
"200":
description: "Lista de cobranças com vencimento."
content:
"application/json":
schema:
$ref: "#/components/schemas/CobsVConsultadas"
examples:
getCobs1:
$ref: "#/components/examples/getCobsV1"
"403":
$ref: "#/components/responses/AcessoNegado"
"503":
$ref: "#/components/responses/ServicoIndisponivel"
"/lotecobv/{id}":
parameters:
- name: "id"
in: "path"
required: true
schema:
type: "string"
title: "Id do lote de cobranças com vencimento"
put:
tags:
- "LoteCobV"
summary: "Criar/Alterar lote de cobranças com vencimento."
security:
- OAuth2: [lotecobv.write]
description: |-
Endpoint utilizado para criar ou alterar um lote de cobranças com vencimento.
Para o caso de uso de alteração de cobranças, o array a ser atribuído na requisicão
deve ser composto pelas exatas requisições de criação de cobranças que
constaram no array atribuído na requisição originária.
Não se pode utilizar este endpoint para _alterar_ um lote de cobranças com vencimento
agregando ou removendo cobranças já existentes dentro do conjunto de cobranças
criadas na requisição originária do lote.
Em outras palavras, se originalmente criou-se um lote, por exemplo, com as cobranças
[`a`, `b` e `c`], não se pode _alterar_ esse conjunto de cobranças original que o
lote representa para [`a`, `b`, `c`, `d`], ou para [`a`, `b`].
Por outro lado, pode-se alterar, _em lote_ as cobranças [`a`, `b`, `c`],
conforme originalmente constam na requisição originária do lote.
Uma solicitação de __criação__ de cobrança com status "EM_PROCESSAMENTO" ou "NEGADA"
está associada a uma cobrança não _existe_ de fato, portanto não será
listada em `GET /cobv` ou `GET /cobv/{txid}`.
Uma cobrança, uma vez criada via `PUT /cobv/{txid}`,
não pode ser associada a um lote posteriormente.
Uma cobrança, uma vez criada via `PUT /lotecobv/{id}`,
não pode ser associada a um novo lote posteriormente.
requestBody:
$ref: "#/components/requestBodies/LoteCobVBody"
responses:
"202":
description: "Lote de cobranças com vencimento solicitado para criação."
"400":
description: "Requisição com formato inválido."
content:
application/problem+json:
schema:
$ref: "#/components/schemas/Problema"
examples:
exemplo1:
$ref: "#/components/examples/RequisicaoInvalidaLoteCobVExample1"
"403":
$ref: "#/components/responses/AcessoNegado"
"404":
$ref: "#/components/responses/NaoEncontrado"
"503":
$ref: "#/components/responses/ServicoIndisponivel"
patch:
tags:
- "LoteCobV"
summary: "Utilizado para revisar cobranças específicas dentro de um lote de cobranças com vencimento."
security:
- OAuth2: [lotecobv.write]
description: |-
Endpoint utilizado para revisar cobranças específicas dentro de um lote de cobranças com vencimento.
A diferença deste endpoint para o endpoint PUT correlato é que este endpoint admite um array
`cobsv` com menos solicitações de criação ou alteração de cobranças do que o array atribuído na requisição originária do lote.
Não se pode, entretanto, utilizar esse endpoint para agregar ou remover solicitações de
alteração ou criação de cobranças conforme constam na requisição originária do lote.
requestBody:
$ref: "#/components/requestBodies/LoteCobVBodyRevisado"
responses:
"202":
description: "Solicitação de revisão do Lote de cobranças encaminhada para processamento."
"400":
description: "Requisição com formato inválido."
content:
application/problem+json:
schema:
$ref: "#/components/schemas/Problema"
examples:
exemplo1:
$ref: "#/components/examples/OperacaoInvalidaCobVExample1"
"403":
$ref: "#/components/responses/AcessoNegado"
"404":
$ref: "#/components/responses/NaoEncontrado"
"503":
$ref: "#/components/responses/ServicoIndisponivel"
get:
tags:
- "LoteCobV"
summary: "Consultar um lote específico de cobranças com vencimento."
security:
- OAuth2: [lotecobv.read]
description: |-
Endpoint para consultar um lote de cobranças com vencimento.
responses:
"200":
description: "Lote de cobranças com vencimento."
content:
"application/json":
schema: