-
-
Notifications
You must be signed in to change notification settings - Fork 14
Expand file tree
/
Copy pathopenapi.yaml
More file actions
4718 lines (4603 loc) · 154 KB
/
openapi.yaml
File metadata and controls
4718 lines (4603 loc) · 154 KB
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.1.0
info:
title: API AbacatePay
description: API para gerenciamento de cobranças e pagamentos usando o AbacatePay.
version: 1.0.0
servers:
- url: 'https://api.abacatepay.com/v2'
description: Único servidor para os ambientes de produção e sandbox.
paths:
/customers/create:
post:
summary: Criar um cliente
description: >
Permite que você crie um cliente para a sua loja.
**Campo obrigatório**: Apenas o `email` é obrigatório para criar um
cliente.
**Recomendado**: Embora os demais campos sejam opcionais, é altamente
recomendado fornecer `name`, `cellphone`, `taxId` e `zipCode` quando
disponíveis, pois essas informações melhoram a experiência do cliente no
checkout e facilitam a identificação.
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
description: >
Os dados do seu cliente.
**Obrigatório**: Apenas `email` é obrigatório.
**Opcional mas recomendado**: `name`, `cellphone`, `taxId`,
`zipCode` e `metadata` são opcionais, mas recomendados para
melhor experiência do cliente.
required:
- email
additionalProperties: false
example:
email: daniel_lima@abacatepay.com
properties:
email:
type: string
description: E-mail do cliente (obrigatório)
example: daniel_lima@abacatepay.com
name:
type: string
description: Nome completo do seu cliente (opcional)
example: Daniel Lima
x-mint:
hidden: true
cellphone:
type: string
description: Celular do cliente (opcional)
example: (11) 4002-8922
x-mint:
hidden: true
taxId:
type: string
description: CPF ou CNPJ válido do cliente (opcional)
example: 123.456.789-01
x-mint:
hidden: true
zipCode:
type: string
description: CEP do cliente (opcional)
example: 01310-100
x-mint:
hidden: true
metadata:
type: object
description: >-
Metadados adicionais do cliente. Campo livre para a sua
aplicação (opcional)
additionalProperties: true
example:
source: landing-page
campaign: black-friday-2025
x-mint:
hidden: true
responses:
'200':
description: Cliente criado com sucesso.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Customer'
error:
type: string
nullable: true
example: null
success:
$ref: '#/components/schemas/Success'
'401':
description: Não autorizado. Falha na autenticação.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: >-
Mensagem de erro descrevendo o motivo da falha na
autenticação.
example: Token de autenticação inválido ou ausente.
/customers/list:
get:
summary: Listar clientes
description: >
Retorna todos os clientes que você cadastrou com suporte a paginação.
Você pode usar essa rota para visualizar todos os seus clientes e suas
informações.
**Alternativa**: Você também pode visualizar e gerenciar seus clientes
pelo [Dashboard da AbacatePay](https://app.abacatepay.com/clientes).
security:
- bearerAuth: []
parameters:
- name: after
in: query
description: Cursor para buscar itens após este ponto
required: false
schema:
type: string
- name: before
in: query
description: Cursor para buscar itens antes deste ponto
required: false
schema:
type: string
- name: limit
in: query
description: Quantidade de itens por página (1-100)
required: false
schema:
type: integer
minimum: 1
maximum: 100
default: 100
example: 100
- name: id
in: query
description: Filtrar por identificador único do cliente
required: false
schema:
type: string
example: cust_aebxkhDZNaMmJeKsy0AHS0FQ
- name: email
in: query
description: Filtrar por e-mail do cliente
required: false
schema:
type: string
example: daniel_lima@abacatepay.com
- name: taxId
in: query
description: Filtrar por CPF ou CNPJ do cliente
required: false
schema:
type: string
example: 123.456.789-01
responses:
'200':
description: Lista de clientes retornada com sucesso.
content:
application/json:
schema:
type: object
properties:
data:
type: array
description: Lista de clientes.
items:
$ref: '#/components/schemas/Customer'
success:
$ref: '#/components/schemas/Success'
error:
type: string
example: null
nullable: true
pagination:
$ref: '#/components/schemas/PaginationCursor'
'401':
description: Não autorizado. Falha na autenticação.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: >-
Mensagem de erro descrevendo o motivo da falha na
autenticação.
example: Token de autenticação inválido ou ausente.
/customers/get:
get:
summary: Buscar um cliente
description: >
Retorna os dados de um cliente específico baseado em filtros.
Você pode usar essa rota para buscar um cliente por ID ou outros
critérios.
security:
- bearerAuth: []
parameters:
- name: id
in: query
description: Identificador único público do cliente
required: false
schema:
type: string
example: cust_aebxkhDZNaMmJeKsy0AHS0FQ
responses:
'200':
description: Cliente encontrado com sucesso.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Customer'
error:
type: string
example: null
nullable: true
success:
$ref: '#/components/schemas/Success'
'401':
description: Não autorizado. Falha na autenticação.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: >-
Mensagem de erro descrevendo o motivo da falha na
autenticação.
example: Token de autenticação inválido ou ausente.
'404':
description: Cliente não encontrado.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: >-
Mensagem de erro indicando que o cliente não foi
encontrado.
example: Cliente não encontrado.
/customers/delete:
post:
summary: Deletar um cliente
description: |
Remove um cliente da sua loja.
Esta operação é irreversível. Use com cuidado.
security:
- bearerAuth: []
parameters:
- name: id
in: query
required: true
description: Identificador único público do cliente a ser deletado
schema:
type: string
example: cust_aebxkhDZNaMmJeKsy0AHS0FQ
responses:
'200':
description: Cliente deletado com sucesso.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Customer'
error:
type: string
example: null
nullable: true
success:
$ref: '#/components/schemas/Success'
'401':
description: Não autorizado. Falha na autenticação.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: >-
Mensagem de erro descrevendo o motivo da falha na
autenticação.
example: Token de autenticação inválido ou ausente.
'404':
description: Cliente não encontrado.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: >-
Mensagem de erro indicando que o cliente não foi
encontrado.
example: Cliente não encontrado.
/coupons/create:
post:
summary: Criar um cupom
description: >
Permite que você crie um novo cupom que pode ser usado por seus clientes
para aplicar descontos.
**Alternativa**: Você também pode criar e gerenciar seus cupons pelo
[Dashboard da AbacatePay](https://app.abacatepay.com/cupons).
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Coupon'
responses:
'200':
description: Cupom criado com sucesso.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/CouponResponse'
error:
type: string
nullable: true
example: null
success:
$ref: '#/components/schemas/Success'
'401':
description: Não autorizado. Falha na autenticação.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: >-
Mensagem de erro descrevendo o motivo da falha na
autenticação.
example: Token de autenticação inválido ou ausente.
/coupons/list:
get:
summary: Listar cupons
description: >
Retorna todos os cupons que você criou com suporte a paginação.
Você pode usar essa rota para visualizar todos os seus cupons, incluindo
seus status (ativos, inativos ou expirados), descontos aplicados e
quantas vezes foram utilizados.
**Alternativa**: Você também pode visualizar e gerenciar seus cupons
pelo [Dashboard da AbacatePay](https://app.abacatepay.com/cupons).
security:
- bearerAuth: []
parameters:
- name: after
in: query
description: Cursor para buscar itens após este ponto
required: false
schema:
type: string
- name: before
in: query
description: Cursor para buscar itens antes deste ponto
required: false
schema:
type: string
- name: limit
in: query
description: Quantidade de itens por página (1-100)
required: false
schema:
type: integer
minimum: 1
maximum: 100
default: 100
example: 100
- name: id
in: query
description: Filtrar por identificador único do cupom
required: false
schema:
type: string
example: DEYVIN_20
- name: status
in: query
description: Filtrar por status do cupom
required: false
schema:
type: string
enum:
- ACTIVE
- INACTIVE
- EXPIRED
responses:
'200':
description: Lista de cupons retornada com sucesso.
content:
application/json:
schema:
type: object
properties:
data:
type: array
description: Lista de cupons.
items:
$ref: '#/components/schemas/CouponResponse'
success:
$ref: '#/components/schemas/Success'
error:
type: string
nullable: true
example: null
pagination:
$ref: '#/components/schemas/PaginationCursor'
'401':
description: Não autorizado. Falha na autenticação.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: >-
Mensagem de erro descrevendo o motivo da falha na
autenticação.
example: Token de autenticação inválido ou ausente.
/coupons/get:
get:
summary: Buscar um cupom
description: >
Retorna os dados de um cupom específico baseado em filtros.
Você pode usar essa rota para buscar um cupom por ID ou outros
critérios.
security:
- bearerAuth: []
parameters:
- name: id
in: query
description: Identificador único do cupom
required: false
schema:
type: string
example: MY_COUPON
responses:
'200':
description: Cupom encontrado com sucesso.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/CouponResponse'
error:
type: string
nullable: true
example: null
success:
$ref: '#/components/schemas/Success'
'401':
description: Não autorizado. Falha na autenticação.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: >-
Mensagem de erro descrevendo o motivo da falha na
autenticação.
example: Token de autenticação inválido ou ausente.
'404':
description: Cupom não encontrado.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Mensagem de erro indicando que o cupom não foi encontrado.
example: Cupom não encontrado.
/coupons/delete:
post:
summary: Deletar um cupom
description: |
Remove um cupom da sua loja.
Esta operação é irreversível. Use com cuidado.
security:
- bearerAuth: []
parameters:
- name: id
in: query
required: true
description: Identificador único do cupom a ser deletado
schema:
type: string
example: MY_COUPON
responses:
'200':
description: Cupom deletado com sucesso.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/CouponResponse'
error:
type: string
nullable: true
example: null
success:
$ref: '#/components/schemas/Success'
'401':
description: Não autorizado. Falha na autenticação.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: >-
Mensagem de erro descrevendo o motivo da falha na
autenticação.
example: Token de autenticação inválido ou ausente.
'404':
description: Cupom não encontrado.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Mensagem de erro indicando que o cupom não foi encontrado.
example: Cupom não encontrado.
/coupons/toggle:
post:
summary: Alternar status de um cupom
description: |
Alterna o status de um cupom entre ativo e inativo.
Use essa rota para ativar ou desativar um cupom sem precisar deletá-lo.
security:
- bearerAuth: []
parameters:
- name: id
in: query
required: true
description: Identificador único do cupom
schema:
type: string
example: MY_COUPON
responses:
'200':
description: Status do cupom alternado com sucesso.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/CouponResponse'
error:
type: string
nullable: true
example: null
success:
$ref: '#/components/schemas/Success'
'401':
description: Não autorizado. Falha na autenticação.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: >-
Mensagem de erro descrevendo o motivo da falha na
autenticação.
example: Token de autenticação inválido ou ausente.
'404':
description: Cupom não encontrado.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Mensagem de erro indicando que o cupom não foi encontrado.
example: Cupom não encontrado.
/products/create:
post:
summary: Criar um produto
description: >
Permite que você crie um novo produto que pode ser usado em cobranças.
Produtos podem ser avulsos (pagamento único) ou de assinatura; use o
campo opcional `cycle` para definir a recorrência (`WEEKLY`, `MONTHLY`,
`SEMIANNUALLY`, `ANNUALLY`). Quando `cycle` é omitido ou `null`, o
produto é avulso.
**Alternativa**: Você também pode criar e gerenciar seus produtos pelo
[Dashboard da AbacatePay](https://app.abacatepay.com/produtos).
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
description: Dados necessários para criar um produto.
required:
- externalId
- name
- price
- currency
additionalProperties: false
example:
externalId: prod-123
name: Produto Exemplo
price: 10000
currency: BRL
properties:
externalId:
type: string
description: Identificador único do produto no seu sistema.
example: prod-123
name:
type: string
description: Nome do produto.
example: Produto Exemplo
price:
type: number
description: Preço do produto em centavos.
minimum: 1
example: 10000
currency:
type: string
description: Moeda do produto.
default: BRL
example: BRL
description:
type: string
description: Descrição opcional do produto.
example: Descrição do produto
x-mint:
hidden: true
imageUrl:
type: string
format: uri
nullable: true
description: URL da imagem do produto. Opcional.
example: null
cycle:
type: string
nullable: true
description: >
Opcional. Indica se o produto é uma assinatura. Quando omitido
ou `null`, o produto é avulso (pagamento único).
Valores possíveis: `WEEKLY`, `MONTHLY`, `SEMIANNUALLY`,
`ANNUALLY`.
enum:
- WEEKLY
- MONTHLY
- SEMIANNUALLY
- ANNUALLY
example: null
responses:
'200':
description: Produto criado com sucesso.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Product'
error:
type: string
nullable: true
example: null
success:
$ref: '#/components/schemas/Success'
'401':
description: Não autorizado. Falha na autenticação.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: >-
Mensagem de erro descrevendo o motivo da falha na
autenticação.
example: Token de autenticação inválido ou ausente.
/products/list:
get:
summary: Listar produtos
description: >
Retorna todos os produtos que você criou com suporte a paginação.
Você pode usar essa rota para visualizar todos os seus produtos,
incluindo status, preços, ciclo de assinatura (quando aplicável) e
demais informações.
**Alternativa**: Você também pode visualizar e gerenciar seus produtos
pelo [Dashboard da AbacatePay](https://app.abacatepay.com/produtos).
security:
- bearerAuth: []
parameters:
- name: after
in: query
description: Cursor para buscar itens após este ponto
required: false
schema:
type: string
- name: before
in: query
description: Cursor para buscar itens antes deste ponto
required: false
schema:
type: string
- name: limit
in: query
description: Quantidade de itens por página (1-100)
required: false
schema:
type: integer
minimum: 1
maximum: 100
default: 100
example: 100
- name: id
in: query
description: Filtrar por identificador único do produto
required: false
schema:
type: string
example: prod_abc123xyz
- name: externalId
in: query
description: Filtrar por identificador do produto no seu sistema
required: false
schema:
type: string
example: prod-123
- name: status
in: query
description: Filtrar por status do produto
required: false
schema:
type: string
enum:
- ACTIVE
- INACTIVE
responses:
'200':
description: Lista de produtos retornada com sucesso.
content:
application/json:
schema:
type: object
properties:
data:
type: array
description: Lista de produtos.
items:
$ref: '#/components/schemas/Product'
success:
$ref: '#/components/schemas/Success'
error:
type: string
nullable: true
example: null
pagination:
$ref: '#/components/schemas/PaginationCursor'
'401':
description: Não autorizado. Falha na autenticação.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: >-
Mensagem de erro descrevendo o motivo da falha na
autenticação.
example: Token de autenticação inválido ou ausente.
/products/get:
get:
summary: Buscar um produto
description: >
Retorna os dados de um produto específico baseado em filtros, incluindo
o campo `cycle` (assinatura ou avulso).
Você pode usar essa rota para buscar um produto por ID ou externalId.
security:
- bearerAuth: []
parameters:
- name: id
in: query
description: Identificador único público do produto
required: false
schema:
type: string
example: prod_abc123xyz
- name: externalId
in: query
description: Identificador único do produto no seu sistema
required: false
schema:
type: string
example: prod-123
responses:
'200':
description: Produto encontrado com sucesso.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Product'
error:
type: string
nullable: true
example: null
success:
$ref: '#/components/schemas/Success'
'401':
description: Não autorizado. Falha na autenticação.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: >-
Mensagem de erro descrevendo o motivo da falha na
autenticação.
example: Token de autenticação inválido ou ausente.
'404':
description: Produto não encontrado.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: >-
Mensagem de erro indicando que o produto não foi
encontrado.
example: Produto não encontrado.
/products/delete:
post:
summary: Deletar um produto
description: |
Remove um produto da sua loja (avulso ou de assinatura).
Esta operação é irreversível. Use com cuidado.
security:
- bearerAuth: []
parameters:
- name: id
in: query
required: true
description: Identificador único público do produto a ser deletado
schema:
type: string
example: prod_abc123xyz
responses:
'200':
description: Produto deletado com sucesso.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Product'
error:
type: string
nullable: true
example: null
success:
$ref: '#/components/schemas/Success'
'401':
description: Não autorizado. Falha na autenticação.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: >-
Mensagem de erro descrevendo o motivo da falha na
autenticação.
example: Token de autenticação inválido ou ausente.
'404':
description: Produto não encontrado.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: >-
Mensagem de erro indicando que o produto não foi
encontrado.
example: Produto não encontrado.
/checkouts/create:
post:
summary: Criar um Checkout
description: Cria um Checkout para o cliente realizar o pagamento.
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- items
additionalProperties: false
example:
items:
- id: prod-1234
quantity: 2
methods: ["PIX", "CARD"]
properties:
items:
type: array
description: >
Lista de itens incluídos na cobrança.
Este é o único campo obrigatório — o valor total é calculado
a partir destes itens.
minItems: 1