-
Notifications
You must be signed in to change notification settings - Fork 8
Expand file tree
/
Copy pathapi-prepaid.yml
More file actions
2205 lines (2069 loc) · 70.3 KB
/
Copy pathapi-prepaid.yml
File metadata and controls
2205 lines (2069 loc) · 70.3 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
swagger: '2.0'
info:
description: |
Prepago Multicaja - API Alpha
** Este es una API en alpha y por lo tanto sufrirá muchos cambios **
Mientras está en modo alpha, no mantendremos versiones anteriores
version: '0.10'
title: API Multicaja (Alpha)
host: 'api.multicaja.cl'
basePath: /v0.10-alpha/
consumes:
- application/json
produces:
- application/json
tags:
- name: prepaid
description: Métodos públicos de la API de prepago
- name: prepaid-signup
description: Registro de usuarios de prepago
paths:
/prepaid/{user_id}/signup:
post:
tags:
- prepaid-signup
summary: Inicia un proceso de registro para obtener la tarjeta de prepago
description: |
Inicia un proceso de registro. Retorna `prepaid_user`, el que indica qué pasos se deben realizar.
Llamadas permitidas cuando el cliente está registrándose:
```
# API-Prepaid
POST /prepaid/signup
GET /prepaid/signup/{signup_id}
# API-Users
GET /users/{user_id}
POST /users/{user_id}/update_personal_data
POST /users/{user_id}/validate_rut
POST /users/{user_id}/validate_email
PUT /users/{user_id}/mail
POST /users/{user_id}/validate_cellphone
PUT /users/{user_id}/sms
POST /users/{user_id}/sign_contract
POST /users/{user_id}/update_password # debe ser la última llamada
```
parameters:
- in: path
name: user_id
description: ID del Cliente
required: true
type: integer
responses:
'200':
description: |
OK - Usuario registrado en prepago.
schema:
$ref: '#/definitions/prepaid_user'
'400':
description: Error en parámetros, se lanza a cuando un parámetro es requerido y no se ha enviado
schema:
$ref: '#/definitions/error_obj'
'404':
description: Cliente no existe o no tiene prepago
schema:
$ref: '#/definitions/error_obj'
'500':
description: Error indeterminado, se lanza cuando ocurre un error imprevisto de sistema
schema:
$ref: '#/definitions/error_obj'
/prepaid/{user_id}/finish_signup:
post:
tags:
- prepaid_finish_signup
summary: Termina un proceso de registro para obtener la tarjeta de prepago
description: |
Termina un proceso de registro. Retorna `prepaid_user`.
parameters:
- in: path
name: user_id
description: ID del Cliente
required: true
type: integer
responses:
'200':
description: |
OK - Usuario prepago.
schema:
$ref: '#/definitions/prepaid_user'
'400':
description: Error en parámetros, se lanza a cuando un parámetro es requerido y no se ha enviado
schema:
$ref: '#/definitions/error_obj'
'422':
description: Carga no exitosa, revise error
schema:
$ref: '#/definitions/error_obj'
'500':
description: Error indeterminado, se lanza cuando ocurre un error imprevisto de sistema
schema:
$ref: '#/definitions/error_obj'
/prepaid/{user_id}/signup/tac:
get:
tags:
- prepaid-signup
summary: Terminos y Condiciones
description: |
Informacion de los terminos y condiciones vigentes para Prepago
parameters:
- in: path
name: user_id
description: ID del Cliente
required: true
type: integer
responses:
'200':
description: |
OK
schema:
$ref: '#/definitions/prepaid_tac'
'404':
description: Cliente no existe o no tiene prepago
schema:
$ref: '#/definitions/error_obj'
'500':
description: Error indeterminado, se lanza cuando ocurre un error imprevisto de sistema
schema:
$ref: '#/definitions/error_obj'
post:
tags:
- prepaid-signup
summary: Aceptar Terminos y Condiciones
description: |
Aceptar los beneficios y los terminos y condiciones del producto Prepago
parameters:
- in: path
name: user_id
description: ID del Cliente
required: true
type: integer
- in: body
name: new_tac
description: Detalle
required: true
schema:
$ref: '#/definitions/prepaid_tac_new'
responses:
'200':
description: |
OK
'400':
description: Error en parámetros, se lanza a cuando un parámetro es requerido y no se ha enviado
schema:
$ref: '#/definitions/error_obj'
'404':
description: Cliente no existe o no tiene prepago
schema:
$ref: '#/definitions/error_obj'
'422':
description: Error de validación de negocio, revise error
schema:
$ref: '#/definitions/error_obj'
'500':
description: Error indeterminado, se lanza cuando ocurre un error imprevisto de sistema
schema:
$ref: '#/definitions/error_obj'
/prepaid/topup:
post:
tags:
- prepaid
summary: Carga una tarjeta
consumes:
- application/json
description: |
Carga una tarjeta
### Notas
* Valida que el usuario esté habilitado para cargar. Esto significa que el usuario debe estar validado hasta nivel 1 o nivel 2.
* Valida que la carga no exceda los límites
* Abona a la Cuenta de Traspaso Personal (CTP) y gatilla un proceso asíncrono que debita la CTP para abonar a la Tarjeta de Prepago.
### Responderá `400` en los siguientes casos:
* 101004: Si un parámetro es requerido y no se ha enviado.
* 101007: Si un parámetro no cumple formato.
### Responderá `401` en los siguientes casos:
* 401: Si faltó incluir la key de suscripción en el header, o si la key es incorrecta.
### Responderá `404` en los siguientes casos:
* 102001: Si el cliente no está registrado en Tenpo.
* 102003: Si el cliente no tiene prepago.
### Responderá `422` en los siguientes casos:
* 102002: Si el cliente está bloqueado o borrado.
* 102004: Si el cliente está bloqueado o borrado de prepago.
* 102015: Si el cliente está en una lista negra, por lo tanto no puede realizar la carga.
* 106000: Si la tarjeta está expirada o tiene un bloqueo duro.
* 106001: La procesadora rechazó la carga, verificar mensaje.
* 106002: Si la tarjeta no existe.
* 106011: Si la tarjeta está bloqueada.
* 108000: Error al validar transacción.
* 108001: El usuario en nivel 1 solo puede realizar 1 carga.
* 108201: La carga supera el monto máximo de carga web.
* 108202: La carga supera el monto máximo de carga pos.
* 108203: La carga es menor al mínimo de carga.
* 108204: La carga supera el monto máximo de cargas mensuales.
* 108901: La carga supera el monto máximo de carga permitida.
* 108902: El importe es menor al mínimo permitido.
* 108903: Excedido límite diario en cajeros.
* 108205 y 108206: La carga supera el monto máximo de primera carga.
* 130005: Si es que se recibio una reversa para la carga previamente.
* 140003: Si la cuenta está cerrada.
* 140004: Si la cuenta está bloqueada.
* 140005: Si la cuenta está inactiva.
* 108909: Si el saldo es mayor al saldo permitido.
### Responderá `500` en los siguientes casos:
* Error imprevisto de sistema
parameters:
- in: header
name: Ocp-Apim-Subscription-Key
description: Key de subscripción requerido (es entregado por Tenpo)
required: true
type: string
- in: body
name: new_topup
description: Detalle de la carga a realizar
required: true
schema:
$ref: '#/definitions/prepaid_topup_new'
responses:
'201':
description: |
OK - Carga se realizará en los próximos segundos
headers:
Content-Type:
type: string
Transfer-Encoding:
type: string
Date:
type: string
schema:
$ref: '#/definitions/prepaid_topup'
'400':
description: Error en parámetros, se lanza a cuando un parámetro es requerido y no se ha enviado ó no cumple formato
headers:
Content-Type:
type: string
Transfer-Encoding:
type: string
Date:
type: string
tracer-id:
description: Id Interno
type: string
schema:
$ref: '#/definitions/error_obj'
'401':
description: Error de key, se lanza a cuando el key de suscripción no fue incluido en el header o está incorrecto
headers:
Content-Type:
type: string
Content-Length:
type: integer
Date:
type: string
WWW-Authenticate:
description: Metodo de autenticación
type: string
schema:
$ref: '#/definitions/error_obj_401'
'404':
description: Cliente no existe o no tiene prepago
headers:
Content-Type:
type: string
Transfer-Encoding:
type: string
Date:
type: string
tracer-id:
description: Id Interno
type: string
schema:
$ref: '#/definitions/error_obj'
'422':
description: Carga no exitosa, revise error
headers:
Content-Type:
type: string
Transfer-Encoding:
type: string
Date:
type: string
tracer-id:
description: Id Interno
type: string
schema:
$ref: '#/definitions/error_obj'
'500':
description: Error indeterminado, se lanza cuando ocurre un error imprevisto de sistema
headers:
Content-Type:
type: string
Transfer-Encoding:
type: string
Date:
type: string
tracer-id:
description: Id Interno
type: string
schema:
$ref: '#/definitions/error_obj'
/prepaid/topup/reverse:
post:
tags:
- prepaid
summary: Reversa una carga
consumes:
- application/json
description: |
Reversa una carga que a) coincida en todos los campos de prepaid_topup_new y b) se haya recibido en las últimas 24 horas.
### Responderá `201` en los siguientes casos:
* Si la carga se recibió, en cuyo caso iniciara el proceso de reversa.
### Responderá `202` en los siguientes casos:
* 130001: Si la carga nunca se recibió, en cuyo caso se dejara registro de la reversa en caso de recibir la carga mas adelante.
* 130003: Si la reversa fue recibida previamente para su procesamiento.
### Responderá `400` en los siguientes casos:
* 101004: Si un parámetro es requerido y no se ha enviado.
* 101007: Si un parámetro no cumple formato.
### Responderá `401` en los siguientes casos:
* 401: Si faltó incluir la key de suscripción en el header, o si la key es incorrecta.
### Responderá `404` en los siguientes casos:
* 102001: Si el cliente no está registrado en Tenpo.
* 102003: Si el cliente no tiene prepago.
### Responderá `410` en los siguientes casos:
* 130004: Si es que la carga fue recibida y no está reversada, pero el plazo para reversarla ya expiró.
### Responderá `422` en los siguientes casos:
* 130002: Si es que la carga fue recibida y la información de la reversa no concuerda.
parameters:
- in: header
name: Ocp-Apim-Subscription-Key
description: Key de subscripción requerido (es entregado por Tenpo)
required: true
type: string
- in: header
name: user-timezone
description: La zona horaria del cliente (default America/Santiago)
required: false
type: string
- in: body
name: new_topup
description: Detalle de la carga a realizar
required: true
schema:
$ref: '#/definitions/prepaid_topup_new'
responses:
'201':
description: OK - Proceso de reversa iniciado
headers:
Content-Length:
type: string
Date:
type: string
'202':
description: OK - Reversa recibida previamente
headers:
Content-Type:
type: string
Transfer-Encoding:
type: string
Date:
type: string
tracer-id:
description: Id Interno
type: string
schema:
$ref: '#/definitions/error_obj'
'400':
description: Error en parámetros, se lanza a cuando un parámetro es requerido y no se ha enviado
headers:
Content-Type:
type: string
Transfer-Encoding:
type: string
Date:
type: string
tracer-id:
description: Id Interno
type: string
schema:
$ref: '#/definitions/error_obj'
'401':
description: Error de key, se lanza a cuando el key de suscripción no fue incluido en el header o está incorrecto
headers:
Content-Type:
type: string
Content-Length:
type: integer
Date:
type: string
WWW-Authenticate:
description: Metodo de autenticación
type: string
schema:
$ref: '#/definitions/error_obj_401'
'404':
description: Cliente no existe o no tiene prepago
headers:
Content-Type:
type: string
Transfer-Encoding:
type: string
Date:
type: string
tracer-id:
description: Id Interno
type: string
schema:
$ref: '#/definitions/error_obj'
'410':
description: Plazo para reversar expirado
headers:
Content-Type:
type: string
Transfer-Encoding:
type: string
Date:
type: string
tracer-id:
description: Id Interno
type: string
schema:
$ref: '#/definitions/error_obj'
'422':
description: Información de reversa no concuerda con la carga
headers:
Content-Type:
type: string
Transfer-Encoding:
type: string
Date:
type: string
tracer-id:
description: Id Interno
type: string
schema:
$ref: '#/definitions/error_obj'
'500':
description: Error indeterminado, se lanza cuando ocurre un error imprevisto de sistema
headers:
Content-Type:
type: string
Transfer-Encoding:
type: string
Date:
type: string
tracer-id:
description: Id Interno
type: string
schema:
$ref: '#/definitions/error_obj'
/prepaid/withdrawal:
post:
tags:
- prepaid
summary: Retira dinero de una tarjeta
consumes:
- application/json
description: |
Debita una tarjeta
### Notas
* Valida que el usuario esté habilitado para retirar.
* Valida que el retiro no exceda los límites
* Debita la Tarjeta de Prepago y abona a la Cuenta de Traspaso Personal (CTP), luego debita la CTP y abona a la cuenta de destino.
### Responderá `400` en los siguientes casos:
* 101004: Si un parámetro es requerido y no se ha enviado.
* 101007: Si un parámetro no cumple formato.
### Responderá `401` en los siguientes casos:
* 401: Si faltó incluir la key de suscripción en el header, o si la key es incorrecta.
### Responderá `404` en los siguientes casos:
* 102001: Si el cliente no está registrado en Tenpo.
* 102003: Si el cliente no tiene prepago.
### Responderá `422` en los siguientes casos:
* 102002: Si el cliente está bloqueado o borrado.
* 102004: Si el cliente está bloqueado o borrado de prepago.
* 102053: Si la clave ingresada no coincide.
* 102015: Si el cliente está en una lista negra, por lo tanto no puede realizar la carga.
* 103001: Si la cuenta bancaria seleccionada no está asociada al cliente.
* 106000: Si la tarjeta está expirada o tiene un bloqueo duro.
* 106001: La procesadora rechazó el retiro, verificar mensaje.
* 106002: Si la tarjeta no existe.
* 106011: Si la tarjeta está bloqueada.
* 108000: Error al validar transacción.
* 108301: El retiro supera el monto máximo de un retiro web.
* 108302: El retiro supera el monto máximo de un retiro pos.
* 108303: El monto de retiro es menor al monto mínimo de retiros.
* 108304: El retiro supera el monto máximo de retiros mensuales.
* 108901: El retiro supera el monto máximo de un retiro.
* 108902: El importe es menor al mínimo permitido.
* 108903: Excedido límite diario en cajeros.
* 140003: Si la cuenta está cerrada.
* 140004: Si la cuenta está bloqueada.
* 140005: Si la cuenta está inactiva.
* 108909: Si el saldo es mayor al saldo permitido.
### Responderá `500` en los siguientes casos:
* Error imprevisto de sistema
parameters:
- in: header
name: Ocp-Apim-Subscription-Key
description: Key de subscripción requerido (es entregado por Tenpo)
required: true
type: string
- in: body
name: new_withdrawal
description: Detalle del retiro a realizar
required: true
schema:
$ref: '#/definitions/prepaid_withdrawal_new'
responses:
'201':
description: |
OK - Retiro realizado
headers:
Content-Type:
type: string
Transfer-Encoding:
type: string
Date:
type: string
schema:
$ref: '#/definitions/prepaid_withdrawal'
'400':
description: Error en parámetros, se lanza a cuando un parámetro es requerido y no se ha enviado ó no cumple formato
headers:
Content-Type:
type: string
Transfer-Encoding:
type: string
Date:
type: string
tracer-id:
description: Id Interno
type: string
schema:
$ref: '#/definitions/error_obj'
'401':
description: Error de key, se lanza a cuando el key de suscripción no fue incluido en el header o está incorrecto
headers:
Content-Type:
type: string
Content-Length:
type: integer
Date:
type: string
WWW-Authenticate:
description: Metodo de autenticación
type: string
schema:
$ref: '#/definitions/error_obj_401'
'404':
description: Cliente no existe o no tiene prepago
headers:
Content-Type:
type: string
Transfer-Encoding:
type: string
Date:
type: string
tracer-id:
description: Id Interno
type: string
schema:
$ref: '#/definitions/error_obj'
'422':
description: Retiro no exitoso, revise error
headers:
Content-Type:
type: string
Transfer-Encoding:
type: string
Date:
type: string
tracer-id:
description: Id Interno
type: string
schema:
$ref: '#/definitions/error_obj'
'500':
description: Error indeterminado, se lanza cuando ocurre un error imprevisto de sistema
headers:
Content-Type:
type: string
Transfer-Encoding:
type: string
Date:
type: string
tracer-id:
description: Id Interno
type: string
schema:
$ref: '#/definitions/error_obj'
/prepaid/withdrawal/reverse:
post:
tags:
- prepaid
summary: Reversa un retiro
consumes:
- application/json
description: |
Reversa un retiro que a) coincida en todos los campos de prepaid_withdrawal_new y b) se haya recibido en las últimas 24 horas.
### Responderá `201` (éxito) en los siguientes casos:
* Si el retiro se recibió, en cuyo caso iniciara el proceso de reversa.
### Responderá `202` en los siguientes casos:
* 130001: Si el retiro nunca se recibió, en cuyo caso se dejara registro de la reversa en caso de recibir el retiro mas adelante.
* 130003: Si la reversa fue recibida previamente para su procesamiento.
### Responderá `400` en los siguientes casos:
* 101004: Si un parámetro es requerido y no se ha enviado.
* 101007: Si un parámetro no cumple formato.
### Responderá `401` en los siguientes casos:
* 401: Si faltó incluir la key de suscripción en el header, o si la key es incorrecta.
### Responderá `404` en los siguientes casos:
* 102001: Si el cliente no está registrado en Tenpo.
* 102003: Si el cliente no tiene prepago.
### Responderá `410` en los siguientes casos:
* 130004: Si es que el retiro fue recibido y no está reversado, pero el plazo para reversarlo ya expiró.
### Responderá `422` en los siguientes casos:
* 130002: Si es que el retiro fue recibido la información de la reversa no concuerda.
parameters:
- in: header
name: Ocp-Apim-Subscription-Key
description: Key de subscripción requerido (es entregado por Tenpo)
required: true
type: string
- in: header
name: user-timezone
description: La zona horaria del cliente (default America/Santiago)
required: false
type: string
- in: body
name: new_withdrawal
description: Detalle de la carga a realizar
required: true
schema:
$ref: '#/definitions/prepaid_withdrawal_new'
responses:
'201':
description: OK - Proceso de reversa iniciado
headers:
Content-Length:
type: string
Date:
type: string
'202':
description: OK - Reversa recibida previamente
headers:
Content-Type:
type: string
Transfer-Encoding:
type: string
Date:
type: string
tracer-id:
description: Id Interno
type: string
schema:
$ref: '#/definitions/error_obj'
'400':
description: Error en parámetros, se lanza a cuando un parámetro es requerido y no se ha enviado
headers:
Content-Type:
type: string
Transfer-Encoding:
type: string
Date:
type: string
tracer-id:
description: Id Interno
type: string
schema:
$ref: '#/definitions/error_obj'
'401':
description: Error de key, se lanza a cuando el key de suscripción no fue incluido en el header o está incorrecto
headers:
Content-Type:
type: string
Content-Length:
type: integer
Date:
type: string
WWW-Authenticate:
description: Metodo de autenticación
type: string
schema:
$ref: '#/definitions/error_obj_401'
'404':
description: Cliente no existe o no tiene prepago
headers:
Content-Type:
type: string
Transfer-Encoding:
type: string
Date:
type: string
tracer-id:
description: Id Interno
type: string
schema:
$ref: '#/definitions/error_obj'
'410':
description: Plazo para reversar expirado
headers:
Content-Type:
type: string
Transfer-Encoding:
type: string
Date:
type: string
tracer-id:
description: Id Interno
type: string
schema:
$ref: '#/definitions/error_obj'
'422':
description: Información de reversa no concuerda con el retiro
headers:
Content-Type:
type: string
Transfer-Encoding:
type: string
Date:
type: string
tracer-id:
description: Id Interno
type: string
schema:
$ref: '#/definitions/error_obj'
'500':
description: Error indeterminado, se lanza cuando ocurre un error imprevisto de sistema
headers:
Content-Type:
type: string
Transfer-Encoding:
type: string
Date:
type: string
tracer-id:
description: Id Interno
type: string
schema:
$ref: '#/definitions/error_obj'
/prepaid/{user_id}/topup:
get:
tags:
- prepaid
summary: Lista las cargas de un cliente
description: |
Retorna un listado con todas las cargas que ha realizado el cliente, junto a su estatus
parameters:
- in: path
name: user_id
description: ID del Cliente
required: true
type: integer
- in: query
name: page
description: Página
type: integer
responses:
'200':
description: |
OK - Búsqueda exitosa
schema:
type: array
items:
$ref: '#/definitions/prepaid_topup'
'400':
description: Error en parámetros, se lanza a cuando un parámetro es requerido y no se ha enviado
schema:
$ref: '#/definitions/error_obj'
'404':
description: Cliente no existe o no tiene prepago
schema:
$ref: '#/definitions/error_obj'
'500':
description: Error indeterminado, se lanza cuando ocurre un error imprevisto de sistema
schema:
$ref: '#/definitions/error_obj'
/prepaid/processor/notification:
post:
summary: Notificación (Callback)
tags:
- prepaid
description: |
**Mensaje invocado por el procesador/emisor**
Notifica una transacción ocurrida en una tarjeta de prepago
Para invocar este servicio se debe incluir el API Key en el header __`X-API-KEY`__
### Responderá `401` en los siguientes casos:
* API Key faltante o invalido.
### Responderá `400` en los siguientes casos:
* 101004: Si faltan parametros en el header o body. Ver información del error para mas detalle.
### Responderá `422` en los siguientes casos:
* 101007: Si el atributo `base64_data` no es un Base64 valido.
parameters:
- in: body
name: transaction
description: Transacción
required: true
schema:
$ref: '#/definitions/raw_transaction_new'
responses:
'202':
description: OK
'401':
description: Unauthorized
'400':
description: Error en parámetros, se lanza a cuando un parámetro es requerido y no se ha enviado
schema:
$ref: '#/definitions/error_obj'
'422':
description: El mensaje `raw_transaction_new` tiene un error
schema:
$ref: '#/definitions/error_obj'
'500':
description: Error indeterminado, se lanza cuando ocurre un error imprevisto de sistema
schema:
$ref: '#/definitions/error_obj'
/prepaid/{user_id}/balance:
get:
tags:
- prepaid
summary: Retorna el saldo de un cliente prepago
description: |
Retorna el saldo del cliente prepago
### Responderá `404` con código de error en los siguientes casos:
* 102001: Si el cliente no existe
* 102003: Si el cliente no está registrado en prepago
### Responderá `422` con código de error en los siguientes casos:
* 102002: Cliente bloqueado o borrado
* 102004: Cliente prepago bloqueado o borrado
* 106007: Si cliente no tiene saldo o tiene saldo expirado y además tiene una carga pendiente
* 106008: Si cliente no tiene saldo o tiene saldo expirado y además tiene una carga en proceso
* 109002: Saldo no disponible (significa que no tenia saldo en cache o su saldo estaba expirado y fallo al consultar el nuevo saldo a tecnocom)
parameters:
- in: path
name: user_id
description: ID del Cliente
required: true
type: integer
responses:
'200':
description: |
OK - Saldo obtenido
schema:
$ref: '#/definitions/prepaid_balance'
'400':
description: Error en parámetros, se lanza a cuando un parámetro es requerido y no se ha enviado
schema:
$ref: '#/definitions/error_obj'
'404':
description: Cliente no existe o no tiene prepago
schema:
$ref: '#/definitions/error_obj'
'422':
description: Valicación de cliente o saldo
schema:
$ref: '#/definitions/error_obj'
'500':
description: Error indeterminado, se lanza cuando ocurre un error imprevisto de sistema
schema:
$ref: '#/definitions/error_obj'
/prepaid/{user_id}/simulation/topup:
post:
tags:
- prepaid
summary: Calculadora de carga
description: |
Calculadora simulación de carga
En caso de que una simulación tenga un error especifico, el mismo viene definido en los campos `code` y `message`
### Responderá `404` en los siguientes casos:
* 102001: Si el cliente no existe
* 102003: Si el cliente no está registrado en prepago
### Responderá `422` en los siguientes casos:
* 108000: Error generico en CDT
* 108203: Error en CDT (LA_CARGA_ES_MENOR_AL_MINIMO_DE_CARGA)
* 108204: Error en CDT (LA_CARGA_SUPERA_EL_MONTO_MAXIMO_DE_CARGAS_MENSUALES)
* 108206: Error en CDT (LA_CARGA_SUPERA_EL_MONTO_MAXIMO_DE_PRIMERA_CARGA)
* 109000: Saldo supera el monto maximo
parameters:
- in: path
name: user_id
description: ID del Cliente
required: true
type: integer
- in: body
name: simulation_topup_new
description: Requerimiento de calculo
required: true
schema:
$ref: '#/definitions/simulation_topup_new'
responses:
'200':
description: OK - Respuesta exitosa.
schema:
$ref: '#/definitions/simulation_group'
'400':
description: Error en parámetros, se lanza a cuando un parámetro es requerido y no se ha enviado
schema:
$ref: '#/definitions/error_obj'
'404':
description: Cliente no existe o no tiene prepago
schema:
$ref: '#/definitions/error_obj'
'422':
description: Error en validación
schema:
$ref: '#/definitions/error_obj'
'500':
description: Error indeterminado, se lanza cuando ocurre un error imprevisto de sistema
schema:
$ref: '#/definitions/error_obj'
/prepaid/{user_id}/simulation/withdrawal:
post:
tags:
- prepaid
summary: Calculadora de retiro
description: |
Calculadora de retiro
### Responderá `404` en los siguientes casos:
* 102001: Si el cliente no existe
* 102003: Si el cliente no está registrado en prepago
### Responderá `422` en los siguientes casos:
* 108000: Error generico en CDT
* 108301: Error en CDT (EL_RETIRO_SUPERA_EL_MONTO_MAXIMO_DE_UN_RETIRO_WEB)
* 108302: Error en CDT (EL_RETIRO_SUPERA_EL_MONTO_MAXIMO_DE_UN_RETIRO_POS)
* 108303: Error en CDT (EL_MONTO_DE_RETIRO_ES_MENOR_AL_MONTO_MINIMO_DE_RETIROS)
* 108304: Error en CDT (EL_RETIRO_SUPERA_EL_MONTO_MAXIMO_DE_RETIROS_MENSUALES)
* 109001: Saldo insuficiente
parameters:
- in: path
name: user_id
description: ID del Cliente
required: true
type: integer
- in: body
name: simulation_withdraw_new
description: Requerimiento de calculo
required: true
schema: