-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathaether.json
More file actions
11546 lines (11546 loc) · 433 KB
/
aether.json
File metadata and controls
11546 lines (11546 loc) · 433 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.0.1",
"info": {
"title": "Aether",
"description": "The bundle is a combination of account and payment products. This is a single API call that calls the underlying APIs to issue accounts and payment instruments to account holders. Each tenant partner is given bundle IDs that can be used by them to issue bundles to account holders.",
"version": "1.0"
},
"servers": [
{
"url": "http://localhost:8889",
"description": "Generated server url"
}
],
"tags": [
{
"name": "Repair Service",
"description": "Aether Repair APIs"
},
{
"name": "Bundle status v3",
"description": "APIs related to the Bundle Status and its configuration - v3 version"
}
],
"paths": {
"/api/v3/tenants/{tenantID}/bundles/{bundleIssuanceId}/bundleStatus/{bundleStatusModelCode}": {
"put": {
"tags": [
"Bundle status v3"
],
"summary": "Manually update a bundle status. This endpoint is a request to manually update the status of a specific bundle. Using this endpoint, you can only update the manual and derived manual bundle statuses. Statuses that can be manually applied on the bundle are called manual bundle statuses. Statuses that are derived due to a manual action on any entity, like an account or account holder, are called derived manual bundle statuses. For example, if your fraud and risk monitoring team suspects that a customer's account has been compromised, you could use this endpoint to temporarily disable the customer's ability to make transactions by applying a relevant bundle status.",
"description": "Manually update a bundle status. This endpoint is a request to manually update the status of a specific bundle. Using this endpoint, you can only update the manual and derived manual bundle statuses. Statuses that can be manually applied on the bundle are called manual bundle statuses. Statuses that are derived due to a manual action on any entity, like an account or account holder, are called derived manual bundle statuses. For example, if your fraud and risk monitoring team suspects that a customer's account has been compromised, you could use this endpoint to temporarily disable the customer's ability to make transactions by applying a relevant bundle status.",
"operationId": "getBundleStatusConfig",
"parameters": [
{
"name": "tenantID",
"in": "path",
"description": "This is the unique identification code (ID) of the issuing financial institution (IFI).",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"example": 123123
},
{
"name": "bundleIssuanceId",
"in": "path",
"description": "This is the unique identification code (ID) of the bundle.",
"required": true,
"schema": {
"type": "string"
},
"example": "734f94e0-5f11-4240-8c30-64c5eb3dc323"
},
{
"name": "bundleStatusModelCode",
"in": "path",
"description": "This is the unique identification code of the bundle status model. Statuses that can be manually applied on the bundle are called manual bundle statuses. Statuses that are derived by the system and applied on bundles based on predefined rules, are called auto bundle statuses. Statuses that are derived due to a manual action on any entity, like an account or account holder, are called derived manual bundle statuses.",
"required": true,
"schema": {
"type": "string"
},
"example": "manual"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManualBundleStatusTagRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManualBundleStatusUpdateResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ApiError"
}
]
},
"examples": {
"Manual bundle status example_code is already applied to given issuance id": {
"summary": "AE4086 : Manual Bundle Status example_code is already applied to given issuance id",
"description": "Manual bundle status example_code is already applied to given issuance id",
"value": {
"code": "AE4086",
"message": "Manual Bundle Status example_code is already applied to given issuance id"
}
},
"Bundle issuance not found": {
"summary": "AE4010 : Provided bundle issuance ID is invalid or not found",
"description": "Bundle issuance not found",
"value": {
"code": "AE4010",
"message": "Issuance not found"
}
},
"Invalid bundle status model": {
"summary": "AE4107 : Provided bundle status model is invalid",
"description": "Invalid bundle status model",
"value": {
"code": "AE4107",
"message": "Invalid bundle status model"
}
},
"Bundle Status Credit Bundle Validation": {
"summary": "AE4106 : Bundle Status can be applied only on credit bundles",
"description": "Bundle Status Credit Bundle Validation",
"value": {
"code": "AE4106",
"message": "Bundle Status can be applied only on credit bundles"
}
},
"Manual Bundle Status Update Not Allowed": {
"summary": "AE4128 : Manual bundle status code update is not allowed for rule based models",
"description": "Manual Bundle Status Update Not Allowed",
"value": {
"code": "AE4128",
"message": "Manual bundle status code update is not allowed for rule based models"
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ApiError"
}
]
},
"examples": {
"Unauthorized": {
"summary": "401: Unauthorized",
"description": "Unauthorized",
"value": {
"code": "401 UNAUTHORISED",
"message": "Unauthorized"
}
},
"Unauthorized Exception:Invalid Auth Token, vboID mismatch": {
"summary": "AE4096 - Unauthorized Exception:Invalid Auth Token, vboID mismatch",
"description": "Unauthorized Exception:Invalid Auth Token, vboID mismatch",
"value": {
"code": "AE4096",
"message": "Unauthorized Exception:Invalid Auth Token, vboID mismatch"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ApiError"
}
]
},
"examples": {
"Changing existing permanent status not allowed": {
"summary": "AE4063 : Changing existing permanent status not allowed",
"description": "Changing existing permanent status not allowed",
"value": {
"code": "AE4063",
"message": "Changing existing permanent status not allowed"
}
},
"Cannot update status to lower priority": {
"summary": "AE4084 : Cannot update status to lower priority",
"description": "Cannot update status to lower priority",
"value": {
"code": "AE4084",
"message": "Cannot update status to lower priority"
}
},
"Invalid configuration of manualBundleStatusUpdateRequest": {
"summary": "AE4085 : classificationUnit with same priority already exists",
"description": "Invalid configuration of manualBundleStatusUpdateRequest",
"value": {
"code": "AE4085",
"message": "classificationUnit with same priority already exists"
}
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ApiError"
}
]
},
"examples": {
"Manual bundle status not found": {
"summary": "AE4065 : Manual bundle status not found",
"description": "Manual bundle status not found",
"value": {
"code": "AE4065",
"message": "Manual bundle status not found"
}
},
"Provided bundleStatus is invalid": {
"summary": "AE4062 : Provided bundleStatus is invalid",
"description": "Provided bundleStatus is invalid",
"value": {
"code": "AE4062",
"message": "Classification unit not found"
}
},
"COAId Not Found": {
"summary": "AE4089 : coaID not found",
"description": "COAId Not Found",
"value": {
"code": "AE4089",
"message": "coaID not found"
}
},
"Issuance Not Found": {
"summary": "AE4010 : Issuance not found",
"description": "Issuance Not Found",
"value": {
"code": "AE4010",
"message": "Issuance not found"
}
}
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ApiError"
}
]
},
"examples": {
"Manual bundle status update failed": {
"summary": "AE4071 : Manual bundle status update failed",
"description": "Manual bundle status update failed",
"value": {
"code": "AE4071",
"message": "Manual bundle status code update failed"
}
},
"Error occurred while tagging account entity": {
"summary": "AE4048 : Error occurred while tagging account entity",
"description": "Error occurred while tagging account entity",
"value": {
"code": "AE4048",
"message": "An error occurred while tagging account entity"
}
},
"Error occurred while tagging account holder entity": {
"summary": "AE4049 : Error occurred while tagging account holder entity",
"description": "Error occurred while tagging account holder entity",
"value": {
"code": "AE4049",
"message": "An error occurred while tagging account holder entity"
}
},
"Error occurred while tagging card entity": {
"summary": "AE4050 : Error occurred while tagging card entity",
"description": "Error occurred while tagging card entity",
"value": {
"code": "AE4050",
"message": "An error occurred while tagging card entity"
}
},
"Update tag bundle entity failed": {
"summary": "AE4080 : Error occurred while updating bundle entity tag",
"description": "Update tag bundle entity failed",
"value": {
"code": "AE4080",
"message": "An error occurred while updating tag bundle entity"
}
},
"Error while creating URI object": {
"summary": "AE4064 : Error while creating URI object",
"description": "Error while creating URI object",
"value": {
"code": "AE4064",
"message": "Error while creating URI object"
}
},
"Error while fetching bundle status policy": {
"summary": "AE4008 : Error while fetching bundle status policy",
"description": "Error while fetching bundle status policy",
"value": {
"code": "AE4008",
"message": "Error while fetching bundle status policy"
}
},
"Update tag notification entity failed": {
"summary": "AE4118 : Error while updating tag notification entity",
"description": "Update tag notification entity failed",
"value": {
"code": "AE4118",
"message": "Error while updating tag notification entity"
}
},
"Failed to update tags in mercury": {
"summary": "AE4117 : Failed to update tags in mercury",
"description": "Failed to update tags in mercury",
"value": {
"code": "AE4117",
"message": "Failed to update tags in mercury"
}
},
"Object unit associations not found": {
"summary": "AE4075 : Object unit associations not found",
"description": "Object unit associations not found",
"value": {
"code": "AE4075",
"message": "Object unit associations not found"
}
}
}
}
}
}
},
"callbacks": {
"association_CREATED": {
"": {
"put": {
"description": "This event occurs whenever the status of a bundle is updated manually. It confirms that the new bundle status has been applied successfully.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectUnitAssociationsEventObject"
}
}
},
"required": true
},
"responses": {}
}
}
},
"LEDGER_POSTING_CREATED": {
"": {
"put": {
"description": "This event occurs whenever the override is applied manually on the bundle statuses. It confirms that the new bundle status has been applied successfully.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LedgerPostingCreatedEventObject"
}
}
},
"required": true
},
"responses": {}
}
}
}
},
"x-zeta-sandbox": "@in.zeta.springframework.boot.commons.authorization.sandboxAccessControl.SandboxAuthorizedSync(tenantID=$$tenants$$, privileges=[], action=bundleStatus.update, object=$$bundles$$@bundleIssuance.zeta.app)"
}
}
},
"components": {
"schemas": {
"ApiError": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "This is a code to identify the error.",
"example": "UNAUTHORIZED"
},
"message": {
"type": "string",
"description": "This is a brief description of the error.",
"example": "Auth token has expired."
},
"version": {
"type": "string",
"description": "Version of the client",
"example": "1.2.0",
"deprecated": true
},
"details": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "This is the list of additional details associated with the error.",
"example": {}
},
"description": "This is the list of additional details associated with the error.",
"example": {}
},
"innerError": {
"$ref": "#/components/schemas/ApiError"
},
"debugId": {
"type": "string",
"description": "This is the unique debug identifier (ID).",
"example": "e9bd286c-2577-432a-z6a8-a69a1f21a711"
},
"reference": {
"type": "string",
"description": "This is the link to the error reference doc."
}
}
},
"ManualBundleStatusUpdateResponse": {
"type": "object",
"properties": {
"bundleIssuanceID": {
"type": "string",
"description": "This is the unique identification code of the bundle.",
"example": "734f94e0-5f11-4240-8c30-64c5eb3dc323"
},
"bundleStatus": {
"type": "string",
"description": "This is the unique identification code (ID) of the status applied on the bundle.",
"example": "A"
},
"isPermanent": {
"type": "boolean",
"description": "This indicates whether the status applied on a bundle is permanent or not. If the value is set to true, the bundle status is permanent. If the value is set to false, the bundle status is not permanent.",
"example": false
},
"priority": {
"type": "integer",
"description": "This is the priority of the status applied on a bundle.",
"format": "int32",
"example": 0
},
"effectiveFrom": {
"type": "string",
"description": "This is the system date from when the bundle status is effective. If the grace days are greater than zero, then the effectiveFrom is calculated as system date + grace days + 1. It is effective from midnight. If the grace days are equal to zero, then the effectiveFrom is the current system date.",
"example": "2023-02-23T11:53:54Z"
},
"remarks": {
"type": "string",
"description": "This provides additional information related to the bundle status.",
"example": "Payment not received"
},
"reasonCode": {
"type": "string",
"description": "This is the reason for the current bundle status.",
"example": "RDS_12"
},
"reasonCodeDescription": {
"type": "string",
"description": "This is a description of the reason code.",
"example": "Payment not received"
},
"createdAt": {
"type": "string",
"description": "This is the date and time when the bundle status was configured in the system.",
"example": "2023-02-23T11:52:24.177Z"
},
"updatedAt": {
"type": "string",
"description": "This is the date and time when the bundle status details were last updated.",
"example": "2023-02-24T09:43:59.618Z"
},
"updatedBy": {
"type": "string",
"description": "This is the entity that updated the bundle status.",
"example": "J-MzlouBFXFTlF62eYA0DQ==@authProfile.rbl-admin.in/1"
}
}
},
"ManualBundleStatusTagRequest": {
"required": [
"bundleStatus"
],
"type": "object",
"properties": {
"bundleStatus": {
"type": "string",
"description": "This is the unique identification code (ID) of the status that is to be applied on the bundle.",
"example": "A"
},
"remarks": {
"type": "string",
"description": "This provides additional information related to the bundle status.",
"example": "Payment not received"
},
"reasonCode": {
"type": "string",
"description": "This is the reason for the bundle status change.",
"example": "RDS_12"
}
}
},
"ClassificationUnit": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "This is the unique identification code (ID) of the classification unit.",
"format": "int64",
"example": 12
},
"tenantId": {
"type": "integer",
"description": "This is the unique identification code (ID) of the issuing financial institution (IFI).",
"format": "int64",
"example": 123123
},
"code": {
"type": "string",
"description": "This is the short code that can be used in user interfaces and tag paths.",
"example": "Q1"
},
"name": {
"type": "string",
"description": "This is the name of the classification unit.",
"example": "2-CYCLE"
},
"objectType": {
"type": "string",
"description": "This is the type of the object on which classification is being performed.",
"example": "in.zeta.aether.bundle"
},
"description": {
"type": "string",
"description": "This is a brief description of the classification unit.",
"example": "2-CYCLE"
},
"classificationModelId": {
"type": "integer",
"description": "This is the unique identification code (ID) of the classification model to which the classification unit is associated.",
"format": "int64",
"example": 273
},
"icon": {
"type": "string",
"description": "This is the uniform resource identifier (URI) to an icon file of 128x128 pixel that can be used for this model in the user interface.",
"example": "https://img.icons8.com/?size=512&id=1349&format=png"
},
"infoUri": {
"type": "string",
"description": "This is the uniform resource identifier (URI) that can be used to provide additional information about classification unit.",
"example": "https://info.com"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "This contains any additional information that is specific to the classification unit.",
"example": "{\n \"priority\": \"0\",\n \"graceDays\": \"0\",\n \"isPermanent\": \"false\"\n \"maxOverrideDays\": \"5\",\n \"isRestrictionOverrideAllowed\": \"true\"\n }"
},
"description": "This contains any additional information that is specific to the classification unit.",
"example": "{\n \"priority\": \"0\",\n \"graceDays\": \"0\",\n \"isPermanent\": \"false\"\n \"maxOverrideDays\": \"5\",\n \"isRestrictionOverrideAllowed\": \"true\"\n }"
},
"restrictedActionCodes": {
"uniqueItems": true,
"type": "array",
"description": "This contains the set of restriction action codes that must be applied to the object having this classification unit.",
"example": [
"REISSUE_CARD",
"RENEW_CARD",
"REWARDS_REDEEM_CREATE",
"CARD_CASH_PLACE_HOLD",
"CARD_REPLACEMENT",
"BILLING_CYCLE_UPDATE",
"LIMIT_INCREASE",
"EMI_CONVERSION",
"CARD_PURCHASE_PLACE_HOLD",
"REPLACE_CARD"
],
"items": {
"type": "string",
"description": "This contains the set of restriction action codes that must be applied to the object having this classification unit.",
"example": "[\"REISSUE_CARD\",\"RENEW_CARD\",\"REWARDS_REDEEM_CREATE\",\"CARD_CASH_PLACE_HOLD\",\"CARD_REPLACEMENT\",\"BILLING_CYCLE_UPDATE\",\"LIMIT_INCREASE\",\"EMI_CONVERSION\",\"CARD_PURCHASE_PLACE_HOLD\",\"REPLACE_CARD\"]"
}
},
"updatedBy": {
"type": "string",
"description": "This indicates the entity that updated the classification unit.",
"example": "wBsThfqwokjsdfS==@authProfile.zeta.in/1"
},
"createdAt": {
"type": "string",
"description": "This is the date and time when the classification unit is created.",
"format": "date-time",
"example": "2023-01-19T12:52:02.207434Z"
},
"updatedAt": {
"type": "string",
"description": "This is the date and time when the classification unit was last updated.",
"format": "date-time",
"example": "2023-04-14T11:12:46.423509Z"
}
},
"description": "This is a group of objects in the model. A model is a collection of logically grouped classification units."
},
"ObjectUnitAssociationsEventObject": {
"type": "object",
"properties": {
"objectType": {
"type": "string",
"description": "This is the type of object on which the classification is performed.",
"example": "in.zeta.aether.bundle"
},
"objectId": {
"type": "string",
"description": "This is the unique identification code (ID) of the object on which the classification is performed.",
"example": "0d69c36c-ffb8-43c4-9515-892aa078d891"
},
"associationAttributes": {
"type": "object",
"additionalProperties": {
"type": "string",
"description": "This contains additional details which may be passed while evaluating the classification unit for the object ID.",
"example": "{\n \"remarks\": \"Manually updated bundle remark\",\n \"updatedBy\": \"T66QoZGr9Zs0ni_-g68I9w==@authProfile.600309-admin.India/2\",\n }"
},
"description": "This contains additional details which may be passed while evaluating the classification unit for the object ID.",
"example": "{\n \"remarks\": \"Manually updated bundle remark\",\n \"updatedBy\": \"T66QoZGr9Zs0ni_-g68I9w==@authProfile.600309-admin.India/2\",\n }"
},
"classificationUnit": {
"$ref": "#/components/schemas/ClassificationUnit"
}
}
},
"LedgerPostingCreatedEventObject": {
"type": "object",
"properties": {
"ifiID": {
"type": "string",
"description": "This is the unique identification code (ID) of the issuing financial institution (IFI).",
"example": "123123"
},
"coaID": {
"type": "string",
"description": "This is the unique identification code (ID) of the Chart of Accounts (CoA) linked with the account.",
"example": "12345666789"
},
"postingCodeURI": {
"type": "string",
"description": "This is the URI for the posting code.",
"example": "postingCode://code/update-ledger-tags"
},
"coaNode": {
"type": "string",
"description": "This is the unique identification code (ID) of the COA node.",
"example": "COA_NODE"
},
"accountHolderID": {
"type": "string",
"description": "This is the unique identification code (ID) of the account holder.",
"example": "2d62beff-4c6a-4e3e-bcbf-c4badd0de155"
},
"ledgerID": {
"type": "string",
"description": "This is the unique identification code (ID) of the ledger.",
"example": "123456667"
},
"ledgerType": {
"type": "string",
"description": "This is the type of the ledger.",
"example": "ACCOUNT_HOLDER"
},
"accountingType": {
"type": "string",
"description": "This is the type of accounting.",
"example": "ASSET"
},
"recordType": {
"type": "string",
"description": "This is the type of the record.",
"example": "META_DETAIL_CHANGE"
},
"postingID": {
"type": "string",
"description": "This is the unique identification code (ID) of the posting.",
"example": "905726"
},
"transactionID": {
"type": "string",
"description": "This is the unique identification code (ID) of the transaction.",
"example": "20240826095400377_617_5eb5ad7e-e8ba-437d-a726-1cfcc2ced208"
},
"txnID": {
"type": "string",
"description": "This is the unique identification code (ID) of the transaction.",
"example": "20240826095400377_617_5eb5ad7e-e8ba-437d-a726-1cfcc2ced208"
},
"previousTransactionID": {
"type": "string",
"description": "This is the unique identification code (ID) of the previous transaction.",
"example": "20240826095125023_615_e96fe0d7-04ad-4f53-905b-99a92f52483c"
},
"currency": {
"type": "string",
"description": "This is the currency of the credit card.",
"example": "INR"
},
"amount": {
"type": "string",
"description": "This is the amount involved in the transaction.",
"example": "0"
},
"previousBalance": {
"type": "string",
"description": "This is the previous balance before the transaction.",
"example": "0"
},
"newBalance": {
"type": "string",
"description": "This is the new balance after the transaction.",
"example": "0"
},
"remarks": {
"type": "string",
"description": "These are the remarks for the transaction.",
"example": "Update Ledger Tags Request"
},
"adminUserID": {
"type": "string",
"description": "This is the unique identification code (ID) of the admin user.",
"example": "0"
},
"isForced": {
"type": "string",
"description": "This indicates if the transaction is forced.",
"example": "false"
},
"ledgerAttributes": {
"type": "string",
"description": "These are the ledger attributes.",
"example": "{\"account.pd-id\":\"5211462850069555324\",\"account.provider\":\"ruby\",\"ruby.annual-fee.treatment\":\"REGULAR\",\"account.pf-id\":\"6789384166337997564\",\"aura.coa-id\":\"7489279058693606989\",\"dontAssessInterest\":\"false\",\"issuance.location\":\"TN\",\"account.openDate\":\"2023-09-02\",\"creditLimit\":\"500000\",\"currency\":\"USD\",\"dontPostInterest\":\"false\",\"aura.parent-node-id\":\"6789384166337997564\"}"
},
"postingAttributes": {
"type": "string",
"description": "These are the posting attributes.",
"example": "{\"ledger.changed\":\"{\\\"before\\\":{\\\"tags\\\":[\\\"tag://manualBundleStatus/testBlockCode?bundleID\\\\u003d96c8c91e-d0c5-42e3-89ee-37a1714c30c4\\\\u0026createdAt\\\\u003d2024-08-26T09:51:22.765Z\\\\u0026effectiveFrom\\\\u003d2024-08-26T09:51:22Z\\\\u0026effectiveFromBookDate\\\\u003d2023-09-01T00%253A00%253A00-07%253A00\\\\u0026graceDays\\\\u003d0\\\\u0026isPermanent\\\\u003dfalse\\\\u0026remarks\\\\u003dManually%20updated%20bundle%20remarks\\\\u0026tagTypeCode\\\\u003dclassification\\\"]},\\\"after\\\":{\\\"tags\\\":[\\\"tag://manualBundleStatus/testBlockCode?bundleID\\\\u003d96c8c91e-d0c5-42e3-89ee-37a1714c30c4\\\\u0026createdAt\\\\u003d2024-08-26T09:51:25.283Z\\\\u0026effectiveFrom\\\\u003d2024-08-27T18:30:00Z\\\\u0026effectiveFromBookDate\\\\u003d2023-09-03T00:00:00-07:00\\\\u0026graceDays\\\\u003d0\\\\u0026isPermanent\\\\u003dfalse\\\\u0026overrideDays\\\\u003d2\\\\u0026overrideStartDate\\\\u003d2024-08-26T09:53:59.098Z\\\\u0026reasonCode\\\\u003dnull\\\\u0026reasonCodeDescription\\\\u003dnull\\\\u0026remarks\\\\u003dManually%20updated%20bundle%20remarks\\\\u0026tagTypeCode\\\\u003dclassification\\\"]}}\",\"isForced\":\"false\"}"
},
"originalTransactionPostingsEventData": {
"type": "string",
"description": "This is the original transaction postings event data.",
"example": "[]"
},
"authorization": {
"type": "string",
"description": "This is the authorization information.",
"example": "{\"type\":\"meta-record\",\"ledgerID\":1386562417203640300,\"postingCode\":\"update-ledger-tags\",\"authID\":\"04dddee4-96a0-49de-adbd-dd9d3a8f6a78\",\"payload\":{\"tags\":[\"tag://manualBundleStatus/testBlockCode?bundleID=96c8c91e-d0c5-42e3-89ee-37a1714c30c4&createdAt=2024-08-26T09:51:25.283Z&effectiveFrom=2024-08-27T18:30:00Z&effectiveFromBookDate=2023-09-03T00:00:00-07:00&graceDays=0&isPermanent=false&overrideDays=2&overrideStartDate=2024-08-26T09:53:59.098Z&reasonCode=null&reasonCodeDescription=null&remarks=Manually%20updated%20bundle%20remarks&tagTypeCode=classification\"]},\"validUntil\":1724666100377}"
},
"postingCategoryAttributions": {
"type": "string",
"description": "These are the posting category attributions.",
"example": "{}"
},
"redeemedCoupons": {
"type": "string",
"description": "These are the redeemed coupons.",
"example": "[]"
},
"additionalData": {
"type": "string",
"description": "This is the additional data.",
"example": "[]"
},
"vectorURIs": {
"type": "string",
"description": "These are the vector URIs.",
"example": "[\"vector://account-no/6158233377563428\",\"vector://account-id/1808d7d0-9642-4490-939f-9969e3565762\"]"
},
"createdAt": {
"type": "string",
"description": "This is the date and time when the entity is created.",
"example": "2022-06-11T23:36:47.856+05:30"
},
"transactionTime": {
"type": "string",
"description": "This is the transaction time.",
"example": "Mon Aug 26 09:54:00 UTC 2024"
},
"bookTime": {
"type": "string",
"description": "This is the book time.",
"example": "Mon Sep 02 18:30:00 UTC 2023"
},
"phase": {
"type": "string",
"description": "This is the phase of the transaction.",
"example": "ACTIVE"
},
"valueTime": {
"type": "string",
"description": "This is the value time.",
"example": "Sat Sep 02 07:00:00 UTC 2023"
},
"statementTime": {
"type": "string",
"description": "This is the statement time.",
"example": "Sat Sep 02 07:00:00 UTC 2023"
},
"timezone": {
"type": "string",
"description": "This is the timezone.",
"example": "America/Los_Angeles"
},
"coaCode": {
"type": "string",
"description": "This is the COA code.",
"example": "COAUS003005"
},
"formattedTransactionTime": {
"type": "string",
"description": "This is the formatted transaction time.",
"example": "2024-08-26T02:54:00.377-07:00"
},
"formattedBookTime": {
"type": "string",
"description": "This is the formatted book time.",
"example": "2023-09-02T00:00:00-07:00"
},
"formattedValueTime": {
"type": "string",
"description": "This is the formatted value time.",
"example": "2023-09-02T00:00:00-07:00"
},
"formattedStatementTime": {
"type": "string",
"description": "This is the formatted statement time.",
"example": "2023-09-02T00:00:00-07:00"
}
}
},
"UpdateTagDetails": {
"required": [
"tagURI"
],
"type": "object",
"properties": {
"tagURI": {
"type": "array",
"description": "This is the list of tag URIs.",
"example": [
"tag://approver/abcd@gmail.com",
"tag://test/123"
],
"items": {
"type": "string",
"description": "This is the list of tag URIs.",
"example": "[\"tag://approver/abcd@gmail.com\",\"tag://test/123\"]"
}
}
}
},
"BundleStatusPolicyModelResponse": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "This is the name of bundle status model",
"example": "manual bundle status model - 1"
},
"modelCode": {
"type": "string",
"description": "This is the unique code referring to bundle status model",
"example": "manualBundleStatus"
},
"modelType": {
"type": "string",
"description": "This describes the type of bundle status model",
"enum": [
"manual",
"auto"
]
},
"isDerived": {
"type": "boolean",
"description": "This is the derived flag for bundle status model"
},
"sourceEntityType": {
"type": "string",
"description": "This is the source entity which triggers derived bundle status",
"example": "ACCOUNT_HOLDER"
},
"sourceStatusModelCode": {
"type": "string",
"description": "This is the source entity status which classifies bundle status unit",
"example": "DECEASED"
}
},
"description": "This is the list of bundle status models linked with policy"
},
"BundleStatusPolicyResponse": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "This is the unique code referring to bundle status policy",
"example": "CREDIT_BUNDLE_STATUS_POLICY1"
},
"name": {
"type": "string",
"description": "This is the name of bundle status policy",
"example": "supreme credit bundle status policy"
},
"description": {
"type": "string",
"description": "This is the description of bundle status policy",
"example": "bundle status policy with specialised features"
},
"bundleStatusModels": {
"type": "array",
"description": "This is the list of bundle status models linked with policy",
"items": {
"$ref": "#/components/schemas/BundleStatusPolicyModelResponse"
}
},
"createdAt": {
"type": "integer",
"description": "This is the epoch time at which bundle status policy is created",
"format": "int64",
"example": 1702243739476
},
"updatedAt": {
"type": "integer",
"description": "This is the epoch time at which bundle status policy is updated",
"format": "int64",
"example": 1702243739476
}
}
},
"BundleStatusPolicyModelRequest": {
"required": [
"modelCode"
],
"type": "object",
"properties": {
"modelCode": {
"type": "string",
"description": "This is the unique code referring to bundle status model",
"example": "manualBundleStatus"
}
},
"description": "This is the list of bundle status models linked with policy"
},
"BundleStatusPolicyRequest": {
"required": [
"bundleStatusModels",
"description",
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "This is the name of bundle status policy",
"example": "supreme credit bundle status policy"
},
"description": {
"type": "string",
"description": "This is the description of bundle status policy",
"example": "bundle status policy with specialised features"
},
"bundleStatusModels": {
"type": "array",
"description": "This is the list of bundle status models linked with policy",
"items": {