-
Notifications
You must be signed in to change notification settings - Fork 2
/
swagger.yaml
2693 lines (2685 loc) · 72.8 KB
/
swagger.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:
version: '1.0.0'
title: 'Asira Borrower'
description: ''
# Added by API Auto Mocking Plugin
servers:
- description: SwaggerHub API Auto Mocking
url: https://virtserver.swaggerhub.com/Ayannah/Asira_Borrower/1.0.0
- description: Indonesia Asira dev
url: http://asira.ayannah.com/api-borrower
tags:
- name: Client
description: client only endpoints
paths:
/clientauth:
get:
summary: initial client login using base64 encoded client key and secret
parameters:
- $ref: '#/components/parameters/clienttoken'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/jwtResponse'
'401':
description: Unauthorized
'422':
description: Unauthorized
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ErrorResponse'
/client/serviceinfo:
get:
tags:
- Client
summary: to check if asira is ready for use. asira will check its own stacks if its ready or not
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ServerReadyResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ErrorResponse'
/client/otp_request:
post:
tags:
- Client
summary: verify borrower using otp
parameters:
- $ref: '#/components/parameters/authtoken'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PayloadRequestOTPRegisterBorrower'
responses:
'200':
description: OTP Sent
'401':
description: Unauthorized
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Unauthorized'
'403':
description: Forbidden
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Forbidden'
'422':
description: Unprocessable Entity
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ErrorResponse'
/client/check_unique:
get:
tags:
- Client
summary: Check variable value if its already used
parameters:
- $ref: '#/components/parameters/authtoken'
- in: query
name: email
schema:
type: string
example: mail@domain.com
- in: query
name: phone
schema:
type: string
example: "081234567890"
- in: query
name: idcard_number
schema:
type: string
example: "601234256253674326536"
- in: query
name: taxid_number
schema:
type: string
example: "129847891274"
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
example: true
message:
type: string
example: OK
'401':
description: Unauthorized
'422':
description: Unprocessable Entity
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ErrorResponse'
/client/borrower_login:
post:
tags:
- Client - Login
summary: login for borrower role. can use phone or email for the key
parameters:
- $ref: '#/components/parameters/authtoken'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BorrowerLoginRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/jwtResponse'
'400':
description: Bad Request
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ErrorResponse'
'401':
description: Unauthorized
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ErrorResponse'
/client/agent_login:
post:
tags:
- Client - Login
summary: login for agent role. can use phone or email for the key
parameters:
- $ref: '#/components/parameters/authtoken'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AgentLoginRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/jwtResponse'
'400':
description: Bad Request
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ErrorResponse'
'401':
description: Unauthorized
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ErrorResponse'
/agent/banks:
get:
tags:
- Agent - Bank
summary: get current banks linked to agent
parameters:
- $ref: '#/components/parameters/authtoken'
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PagedModel'
- properties:
data:
type: array
items:
allOf:
- $ref: '#/components/schemas/bankListDetails'
/agent/borrowers:
get:
tags:
- Agent - Borrowers
summary: get borrowers by id banks
parameters:
- $ref: '#/components/parameters/authtoken'
- in: query
name: bank_id
schema:
type: integer
example: 2
description: show borrowers by bank id
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PagedModel'
- properties:
data:
type: array
items:
allOf:
- $ref: '#/components/schemas/ModelAgentBorrower'
/agent/borrower/[borrower_id]:
get:
tags:
- Agent - Borrowers
summary: get borrowers by id borrower
parameters:
- $ref: '#/components/parameters/authtoken'
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ModelAgentBorrower'
patch:
tags:
- Agent - Borrowers
summary: edit borrowers by id borrower
parameters:
- $ref: '#/components/parameters/authtoken'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchAgentBorrowerRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ModelAgentBorrower'
'404':
description: Not Found
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/NotFoundResponse'
'422':
description: Unauthorized
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ErrorResponse'
'403':
description: Unauthorized
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ErrorResponse'
/agent/profile:
get:
tags:
- Agent
summary: get current agent profile data
parameters:
- $ref: '#/components/parameters/authtoken'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/getAgentProfileResponse'
patch:
tags:
- Agent
summary: update current agent profile data
parameters:
- $ref: '#/components/parameters/authtoken'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/patchProfileAgent'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/getAgentProfileResponse'
'401':
description: Unauthorized
# content:
# application/json:
# schema:
# type: object
# allOf:
# - $ref: '#/components/schemas/loanList'
/agent/loan:
get:
tags:
- Agent - Loan
summary: get current agent's borrower history. default is ordered by recent.
parameters:
- $ref: '#/components/parameters/authtoken'
- in: query
name: rows
schema:
type: integer
example: 2
description: how many data shown in one page
- in: query
name: page
schema:
type: string
example: 1
description: current open page
- in: query
name: orderby
schema:
type: string
description: order by
- in: query
name: sort
schema:
type: string
example: "asc"
description: sort ascending or descending
- in: query
name: status
schema:
type: string
example: "processing | approved | rejected"
description: search by loan status
- in: query
name: bank
schema:
type: integer
example: 1
description: search by loan status
- in: query
name: name
schema:
type: string
example: "fullname"
description: search fullname for borrower info stored in loan
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PagedModel'
- properties:
data:
type: array
items:
allOf:
- $ref: '#/components/schemas/BaseLoan'
- properties:
installment_details:
type: object
allOf:
- $ref: '#/components/schemas/BaseInstallment'
'401':
description: Unauthorized
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Unauthorized'
'403':
description: Forbidden
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Forbidden'
'500':
description: Internal Server Error
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ErrorResponse'
post:
tags:
- Agent - Loan
summary: request loan application from agent
parameters:
- $ref: '#/components/parameters/authtoken'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PayloadApplyLoanAgent'
responses:
'201':
description: Created
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/BaseLoan'
'401':
description: Unauthorized
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Unauthorized'
'403':
description: Forbidden
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Forbidden'
'422':
description: Unprocessable Entity
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ErrorResponse'
/agent/loan/[loan_id]/details:
get:
tags:
- Agent - Loan
summary: get loan detail by id
parameters:
- $ref: '#/components/parameters/authtoken'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseLoan'
- properties:
installment_details:
type: object
allOf:
- $ref: '#/components/schemas/BaseInstallment'
'401':
description: Unauthorized
'404':
description: Not Found
'500':
description: Internal Server Error
/agent/loan/[loan_id]/otp:
get:
tags:
- Agent - Loan
summary: otp request to verify loan
parameters:
- $ref: '#/components/parameters/authtoken'
responses:
'200':
description: OK
'401':
description: Unauthorized
'404':
description: Not Found
'422':
description: Unprocessable Entity
'500':
description: Internal Server Error
/agent/loan/[loan_id]/verify:
post:
tags:
- Agent - Loan
summary: verify loan with otp code
parameters:
- $ref: '#/components/parameters/authtoken'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BaseOTPVerify'
responses:
'200':
description: OK
'401':
description: Unauthorized
'404':
description: Not Found
'422':
description: Unprocessable Entity
'500':
description: Internal Server Error
/client/register_borrower:
post:
tags:
- Client
summary: Register borrower account
parameters:
- $ref: '#/components/parameters/authtoken'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/registerRequestNew'
description: >-
<p>requesting to borrower register endpoint.</p>
responses:
'201':
description: Created
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ModelBorrower'
'401':
description: Unauthorized
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Unauthorized'
'422':
description: Unprocessable Entity
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ErrorResponse'
/agent/checks_borrower:
post:
tags:
- Agent - Borrowers
summary: check is agent's borrower exist or not
parameters:
- $ref: '#/components/parameters/authtoken'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BaseCheckUnique'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
example: true
message:
type: string
example: OK
'401':
description: Unauthorized
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Unauthorized'
'403':
description: Forbidden
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Forbidden'
'422':
description: Unprocessable Entity
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ErrorResponse'
'500':
description: Unprocessable Entity
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ErrorResponse'
/agent/bank_services:
get:
tags:
- Agent - Bank
summary: get bank services info for current Agent (JWT)
parameters:
- $ref: '#/components/parameters/authtoken'
- in: query
name: bank_id
schema:
type: integer
example: 2
description: bank id for query
- in: query
name: service_id
schema:
type: integer
example: 2
description: bank id for query
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/bankServiceList'
'401':
description: Unauthorized
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ErrorResponse'
/agent/bank_products:
get:
tags:
- Agent - Bank
summary: get bank products info for current Agent (JWT) - based on banks that agent owned
parameters:
- $ref: '#/components/parameters/authtoken'
- in: query
name: service_id
schema:
type: integer
example: 1
description: bank id for query
- in: query
name: product_id
schema:
type: integer
example: 1
description: bank id for query
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/bankProductList'
'401':
description: Unauthorized
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ErrorResponse'
/agent/otp_verify/[borrower_id]:
post:
tags:
- Agent - Borrowers
summary: verify sms OTP to agent phone number for verify registered agent's borrower
parameters:
- $ref: '#/components/parameters/authtoken'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PayloadVerifyOTPRegisterBorrowerAgent'
responses:
'200':
description: OK
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ErrorResponse'
'404':
description: Not Found
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/NotFoundResponse'
'422':
description: Unprocessable Entity
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/NotFoundResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ErrorResponse'
/agent/otp_request/[borrower_id]:
post:
tags:
- Agent - Borrowers
summary: Send sms OTP to agent phone number for verify registered agent's borrower
parameters:
- $ref: '#/components/parameters/authtoken'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BasePayloadOTP'
responses:
'200':
description: OTP Sent
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/NotFoundResponse'
'404':
description: Not Found
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/NotFoundResponse'
'422':
description: Unprocessable Entity
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ErrorResponse'
/agent/register_borrower:
post:
tags:
- Agent - Borrowers
summary: Register borrower account from agent
parameters:
- $ref: '#/components/parameters/authtoken'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterAgentRequest'
description: >-
<p>requesting to agent's borrower register endpoint.</p>
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ModelBorrower'
'401':
description: Unauthorized
'422':
description: Unauthorized
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ErrorResponse'
/client/reset_password:
post:
tags:
- Client
summary: Check variable value if its already used
parameters:
- $ref: '#/components/parameters/authtoken'
requestBody:
content:
application/json:
schema:
type : object
properties:
email:
type : string
example : password
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Link reset password telah dikirim ke email, silahkan cek email anda
status:
type: boolean
example: true
'404':
description: Unauthorized
'422':
description: Unauthorized
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ErrorResponse'
/client/change_password:
post:
tags:
- Client
summary: change password
parameters:
- $ref: '#/components/parameters/authtoken'
requestBody:
content:
application/json:
schema:
type : object
properties:
password :
type : string
example : password
uuid :
type : string
example : 1a50b5da-a3a4-4e49-ba87-4c34195748a9
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: OK
'401':
description: Unauthorized
'422':
description: Unauthorized
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal Server Error