@tammsyr/admin-api-client 1.2.6 → 1.2.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. package/README.md +0 -1
  2. package/dist/AccountTypes.d.ts +27 -0
  3. package/dist/AccountTypes.d.ts.map +1 -0
  4. package/dist/AccountTypes.js +57 -0
  5. package/dist/AccountTypes.js.map +1 -0
  6. package/dist/ActivityLogs.d.ts.map +1 -1
  7. package/dist/Agents.d.ts +1 -21
  8. package/dist/Agents.d.ts.map +1 -1
  9. package/dist/Agents.js +0 -34
  10. package/dist/Agents.js.map +1 -1
  11. package/dist/AppVersion.d.ts +2 -2
  12. package/dist/AppVersion.d.ts.map +1 -1
  13. package/dist/AppVersion.js.map +1 -1
  14. package/dist/BankBranches.d.ts +47 -0
  15. package/dist/BankBranches.d.ts.map +1 -0
  16. package/dist/BankBranches.js +91 -0
  17. package/dist/BankBranches.js.map +1 -0
  18. package/dist/Currencies.d.ts +57 -0
  19. package/dist/Currencies.d.ts.map +1 -0
  20. package/dist/Currencies.js +106 -0
  21. package/dist/Currencies.js.map +1 -0
  22. package/dist/Dlq.d.ts +3 -3
  23. package/dist/Dlq.d.ts.map +1 -1
  24. package/dist/Dlq.js.map +1 -1
  25. package/dist/GlobalNotifications.d.ts +3 -3
  26. package/dist/GlobalNotifications.d.ts.map +1 -1
  27. package/dist/GlobalNotifications.js.map +1 -1
  28. package/dist/Kyc.d.ts +223 -25
  29. package/dist/Kyc.d.ts.map +1 -1
  30. package/dist/Kyc.js +341 -28
  31. package/dist/Kyc.js.map +1 -1
  32. package/dist/Metrics.d.ts +14 -0
  33. package/dist/Metrics.d.ts.map +1 -0
  34. package/dist/Metrics.js +33 -0
  35. package/dist/Metrics.js.map +1 -0
  36. package/dist/Notifications.d.ts.map +1 -1
  37. package/dist/Transactions.d.ts +2 -2
  38. package/dist/Transactions.d.ts.map +1 -1
  39. package/dist/Transactions.js.map +1 -1
  40. package/dist/Users.d.ts +3 -3
  41. package/dist/Users.d.ts.map +1 -1
  42. package/dist/Users.js.map +1 -1
  43. package/dist/data-contracts.d.ts +489 -293
  44. package/dist/data-contracts.d.ts.map +1 -1
  45. package/dist/index.d.ts +12 -3
  46. package/dist/index.d.ts.map +1 -1
  47. package/dist/index.js +17 -5
  48. package/dist/index.js.map +1 -1
  49. package/package.json +1 -1
@@ -1,13 +1,13 @@
1
1
  export interface AdminLoginRequestDto {
2
2
  /**
3
3
  * Admin email address
4
- * @example "admin@tamm.com"
4
+ * @example "superadmin@tamm.com"
5
5
  */
6
6
  email: string;
7
7
  /**
8
8
  * Admin password
9
9
  * @minLength 6
10
- * @example "SecureP@ss123"
10
+ * @example "Test@1234"
11
11
  */
12
12
  password: string;
13
13
  /**
@@ -582,16 +582,31 @@ export interface AgentStatisticsDto {
582
582
  activeAgents: number;
583
583
  /** Number of suspended agents */
584
584
  suspendedAgents: number;
585
- /** Total number of branches across all agents */
586
- totalBranches: number;
585
+ }
586
+ export interface LocalizedNameDto {
587
+ /**
588
+ * English name
589
+ * @example "Head Office"
590
+ */
591
+ en: string;
592
+ /**
593
+ * Arabic name
594
+ * @example "المركز الرئيسي"
595
+ */
596
+ ar: string;
587
597
  }
588
598
  export interface AgentListItemDto {
589
599
  /** @format uuid */
590
600
  id: string;
591
601
  type: "MONEY_TRANSFER" | "EXCHANGE_BUREAU" | "BANK";
592
602
  status: "PENDING" | "ACTIVE" | "SUSPENDED" | "TERMINATED";
593
- name: string;
603
+ name: LocalizedNameDto;
594
604
  licenseNumber: string;
605
+ /**
606
+ * 8-digit Customer Information File identifier
607
+ * @example "00074521"
608
+ */
609
+ cif: string;
595
610
  contactPerson: string;
596
611
  contactEmail: string;
597
612
  contactPhone: string;
@@ -604,8 +619,6 @@ export interface AgentListItemDto {
604
619
  createdAt: string;
605
620
  /** @format date-time */
606
621
  updatedAt: string;
607
- /** @example 3 */
608
- branchCount: number;
609
622
  }
610
623
  export interface AgentListResponseDto {
611
624
  /** List of agents */
@@ -685,48 +698,6 @@ export interface AgentCommissionResponseDto {
685
698
  */
686
699
  updatedAt: string;
687
700
  }
688
- export interface BranchResponseDto {
689
- /**
690
- * Branch ID
691
- * @format uuid
692
- */
693
- id: string;
694
- /**
695
- * Agent ID
696
- * @format uuid
697
- */
698
- agentId: string;
699
- /** Branch name */
700
- name: string;
701
- /** Branch code */
702
- code: string;
703
- /** Branch status */
704
- status: "ACTIVE" | "INACTIVE" | "SUSPENDED";
705
- /** Address */
706
- address: string;
707
- /** City */
708
- city: string;
709
- /** Latitude */
710
- latitude: number;
711
- /** Longitude */
712
- longitude: number;
713
- /** Contact phone */
714
- contactPhone: string;
715
- /** Contact email */
716
- contactEmail?: string;
717
- /** Whether the branch is active */
718
- isActive: boolean;
719
- /**
720
- * Created at
721
- * @format date-time
722
- */
723
- createdAt: string;
724
- /**
725
- * Updated at
726
- * @format date-time
727
- */
728
- updatedAt: string;
729
- }
730
701
  export interface AdminAccountResponseDto {
731
702
  /**
732
703
  * Account ID (UUID)
@@ -734,8 +705,8 @@ export interface AdminAccountResponseDto {
734
705
  */
735
706
  id: string;
736
707
  /**
737
- * Human-readable 16-digit account number. Only set for main accounts.
738
- * @example "1076012345678903"
708
+ * Human-readable 22-digit account number. Only set for main accounts.
709
+ * @example "0017601010000001000011"
739
710
  */
740
711
  accountNumber?: string;
741
712
  /**
@@ -796,8 +767,13 @@ export interface AgentResponseDto {
796
767
  id: string;
797
768
  type: "MONEY_TRANSFER" | "EXCHANGE_BUREAU" | "BANK";
798
769
  status: "PENDING" | "ACTIVE" | "SUSPENDED" | "TERMINATED";
799
- name: string;
770
+ name: LocalizedNameDto;
800
771
  licenseNumber: string;
772
+ /**
773
+ * 8-digit Customer Information File identifier
774
+ * @example "00074521"
775
+ */
776
+ cif: string;
801
777
  contactPerson: string;
802
778
  contactEmail: string;
803
779
  contactPhone: string;
@@ -810,11 +786,8 @@ export interface AgentResponseDto {
810
786
  createdAt: string;
811
787
  /** @format date-time */
812
788
  updatedAt: string;
813
- /** @example 3 */
814
- branchCount: number;
815
789
  limits?: AgentLimitResponseDto[];
816
790
  commissions?: AgentCommissionResponseDto[];
817
- branches?: BranchResponseDto[];
818
791
  /** Agent main wallets (admin GET only; unified ownerId + type per account) */
819
792
  accounts?: AdminAccountResponseDto[];
820
793
  }
@@ -832,11 +805,8 @@ export interface CreateAgentWalletDto {
832
805
  name?: string;
833
806
  }
834
807
  export interface CreateAgentDto {
835
- /**
836
- * Agent name
837
- * @example "Acme Agent"
838
- */
839
- name: string;
808
+ /** Translatable display name */
809
+ name: LocalizedNameDto;
840
810
  /** @example "MONEY_TRANSFER" */
841
811
  type: "MONEY_TRANSFER" | "EXCHANGE_BUREAU" | "BANK";
842
812
  /**
@@ -887,15 +857,12 @@ export interface CreateAgentResponseDto {
887
857
  * @format uuid
888
858
  */
889
859
  id: string;
890
- /** Agent name */
891
- name: string;
860
+ /** Translatable agent name */
861
+ name: LocalizedNameDto;
892
862
  }
893
863
  export interface UpdateAgentDto {
894
- /**
895
- * Agent name
896
- * @example "Acme Agent"
897
- */
898
- name?: string;
864
+ /** Translatable display name */
865
+ name?: LocalizedNameDto;
899
866
  /** @example "MONEY_TRANSFER" */
900
867
  type?: "MONEY_TRANSFER" | "EXCHANGE_BUREAU" | "BANK";
901
868
  /**
@@ -946,68 +913,8 @@ export interface UpdateAgentResponseDto {
946
913
  * @format uuid
947
914
  */
948
915
  id: string;
949
- /** Agent name */
950
- name: string;
951
- }
952
- export interface UpsertBranchItemDto {
953
- /**
954
- * Branch name
955
- * @example "Downtown Branch"
956
- */
957
- name: string;
958
- /**
959
- * Unique branch code
960
- * @example "BR-001"
961
- */
962
- code: string;
963
- /**
964
- * Address
965
- * @example "123 Main St"
966
- */
967
- address: string;
968
- /**
969
- * City
970
- * @example "Dubai"
971
- */
972
- city: string;
973
- /**
974
- * Latitude
975
- * @example 25.276987
976
- */
977
- latitude?: number;
978
- /**
979
- * Longitude
980
- * @example 55.296249
981
- */
982
- longitude?: number;
983
- /**
984
- * Contact phone
985
- * @example "+971501234567"
986
- */
987
- contactPhone: string;
988
- /**
989
- * Contact email
990
- * @example "branch@acme.com"
991
- */
992
- contactEmail?: string;
993
- /**
994
- * Whether the branch is active
995
- * @default true
996
- */
997
- isActive?: boolean;
998
- /** Branch status */
999
- status?: "ACTIVE" | "SUSPENDED" | "INACTIVE";
1000
- /**
1001
- * Branch ID — if provided, updates; if omitted, creates
1002
- * @format uuid
1003
- */
1004
- branchId?: string;
1005
- }
1006
- export interface UpsertBranchesDto {
1007
- branches: UpsertBranchItemDto[];
1008
- }
1009
- export interface BranchesUpsertResponseDto {
1010
- branches: BranchResponseDto[];
916
+ /** Translatable agent name */
917
+ name: LocalizedNameDto;
1011
918
  }
1012
919
  export interface SetLimitDto {
1013
920
  /**
@@ -1088,136 +995,243 @@ export interface AgentCommissionsResponseDto {
1088
995
  /** List of agent commissions */
1089
996
  commissions: AgentCommissionResponseDto[];
1090
997
  }
1091
- export interface KycStatisticsResponseDto {
998
+ export interface SubmissionStatisticsResponseDto {
1092
999
  /**
1093
- * Total number of KYC requests
1094
- * @example 150
1000
+ * Submissions still waiting on storage to confirm uploads
1001
+ * @example 3
1095
1002
  */
1096
- total: number;
1003
+ pending_upload: number;
1097
1004
  /**
1098
- * Number of pending KYC requests
1099
- * @example 45
1005
+ * Submissions whose files are confirmed; awaiting reviewer
1006
+ * @example 17
1100
1007
  */
1101
- pending: number;
1008
+ uploaded: number;
1102
1009
  /**
1103
- * Number of KYC requests under review
1104
- * @example 12
1010
+ * Submissions currently being reviewed
1011
+ * @example 5
1105
1012
  */
1106
- underReview: number;
1013
+ under_review: number;
1107
1014
  /**
1108
- * Number of verified KYC requests
1109
- * @example 80
1015
+ * Approved submissions (post-saga for INDIVIDUAL)
1016
+ * @example 102
1110
1017
  */
1111
- verified: number;
1018
+ approved: number;
1112
1019
  /**
1113
- * Number of rejected KYC requests
1114
- * @example 13
1020
+ * Rejected submissions (customer may re-submit)
1021
+ * @example 11
1115
1022
  */
1116
1023
  rejected: number;
1117
- }
1118
- export interface ListKycResponseRow {
1119
- id: string;
1120
- fullName: string;
1121
1024
  /**
1122
- * KYC request status
1123
- * @example "pending"
1124
- */
1125
- status: "pending" | "under_review" | "verified" | "rejected";
1126
- createdAt: string;
1127
- }
1128
- export interface KycListResponseDto {
1129
- /** List of KYC requests */
1130
- data: ListKycResponseRow[];
1131
- /** Pagination metadata */
1025
+ * Submissions whose expiry_date has passed (background cron)
1026
+ * @example 4
1027
+ */
1028
+ expired: number;
1029
+ }
1030
+ export interface SubjectInputDto {
1031
+ role: "INDIVIDUAL" | "BUSINESS" | "UBO" | "DIRECTOR";
1032
+ subject_id: string;
1033
+ display_name: string;
1034
+ }
1035
+ export interface SubmissionFileResponseDto {
1036
+ file_id: string;
1037
+ slot_key: string;
1038
+ storage_reference?: string;
1039
+ original_name: string;
1040
+ mime_type: string;
1041
+ size_bytes: number;
1042
+ sha256?: object;
1043
+ uploaded_at: string;
1044
+ uploaded_by?: string;
1045
+ }
1046
+ export interface SubmissionReviewResponseDto {
1047
+ reviewer_id?: object;
1048
+ reviewed_at?: object;
1049
+ decision?: object;
1050
+ rejection_reason_code?: object;
1051
+ rejection_notes?: object;
1052
+ previous_attempts: number;
1053
+ }
1054
+ export interface SubmissionResponseDto {
1055
+ submission_id: string;
1056
+ customer_id: string;
1057
+ subject: SubjectInputDto;
1058
+ document_type_code: string;
1059
+ document_type_version: number;
1060
+ document_type_category: string;
1061
+ files: SubmissionFileResponseDto[];
1062
+ extracted_fields: object;
1063
+ status: "PENDING_UPLOAD" | "UPLOADED" | "UNDER_REVIEW" | "APPROVED" | "REJECTED" | "EXPIRED";
1064
+ review: SubmissionReviewResponseDto;
1065
+ previous_submission_id?: object;
1066
+ created_at: string;
1067
+ updated_at: string;
1068
+ expires_at?: object;
1069
+ }
1070
+ export interface SubmissionListResponseDto {
1071
+ data: SubmissionResponseDto[];
1132
1072
  meta: PaginationMetaDto;
1133
1073
  }
1134
- export interface KycDocumentResponseDto {
1135
- /**
1136
- * Document type
1137
- * @example "id_front"
1138
- */
1139
- documentType: "id_front" | "id_back" | "selfie";
1140
- /**
1141
- * Reference to the encrypted storage location
1142
- * @example "uploads/kyc/123/id_front.enc"
1143
- */
1144
- storageReference: string;
1145
- }
1146
- export interface KycRequestResponseDto {
1147
- /**
1148
- * KYC request unique identifier
1149
- * @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
1150
- */
1074
+ export interface ApproveSubmissionRequestDto {
1075
+ notes?: string;
1076
+ }
1077
+ export interface RejectSubmissionRequestDto {
1078
+ reason_code: "EXPIRED" | "ILLEGIBLE" | "WRONG_DOCUMENT" | "OTHER";
1079
+ notes: string;
1080
+ }
1081
+ export interface SubmitFieldsRequestDto {
1082
+ /** Map of field key → value, validated against pinned schema */
1083
+ extracted_fields: object;
1084
+ }
1085
+ export interface FileSlotDto {
1086
+ key: string;
1087
+ /** i18n map (e.g. { en: "Front", ar: "الأمامي" }) */
1088
+ label_i18n: object;
1089
+ /** Optional i18n helper text shown under the label (e.g. capture hints) */
1090
+ description_i18n?: object;
1091
+ required: boolean;
1092
+ accepted_mime: string[];
1093
+ max_size_mb: number;
1094
+ capture_hint: "document" | "selfie" | "any";
1095
+ }
1096
+ export interface FieldValidationDto {
1097
+ pattern?: string;
1098
+ min_length?: number;
1099
+ max_length?: number;
1100
+ min?: number;
1101
+ max?: number;
1102
+ min_offset_days?: number;
1103
+ max_offset_days?: number;
1104
+ options?: string[];
1105
+ options_source?: string;
1106
+ }
1107
+ export interface FieldDto {
1108
+ key: string;
1109
+ label_i18n: object;
1110
+ /** Optional i18n helper text shown under the label (e.g. "As printed on the document") */
1111
+ description_i18n?: object;
1112
+ type: "string" | "number" | "date" | "boolean" | "enum";
1113
+ required: boolean;
1114
+ pii?: boolean;
1115
+ validation: FieldValidationDto;
1116
+ }
1117
+ export interface DocumentTypeResponseDto {
1151
1118
  id: string;
1119
+ code: string;
1120
+ version: number;
1121
+ name_i18n: object;
1122
+ description_i18n?: object;
1123
+ category: "IDENTITY" | "ADDRESS" | "INCORPORATION" | "OWNERSHIP" | "FINANCIAL" | "OTHER";
1124
+ applies_to: "INDIVIDUAL" | "BUSINESS" | "UBO" | "DIRECTOR";
1125
+ file_slots: FileSlotDto[];
1126
+ fields: FieldDto[];
1127
+ is_active: boolean;
1128
+ created_by: string;
1129
+ created_at: string;
1130
+ }
1131
+ export interface CreateDocumentTypeRequestDto {
1132
+ code: string;
1133
+ name_i18n: object;
1134
+ description_i18n?: object;
1135
+ category: "IDENTITY" | "ADDRESS" | "INCORPORATION" | "OWNERSHIP" | "FINANCIAL" | "OTHER";
1136
+ applies_to: "INDIVIDUAL" | "BUSINESS" | "UBO" | "DIRECTOR";
1137
+ file_slots: FileSlotDto[];
1138
+ fields: FieldDto[];
1139
+ }
1140
+ export interface PatchDocumentTypeRequestDto {
1141
+ is_active?: boolean;
1142
+ name_i18n?: object;
1143
+ }
1144
+ export interface RuleResponseDto {
1145
+ id: string;
1146
+ country_code?: object;
1147
+ customer_type?: "INDIVIDUAL" | "SME" | "CORPORATE";
1148
+ risk_level?: "LOW" | "MEDIUM" | "HIGH";
1149
+ business_type?: object;
1150
+ subject_role: "INDIVIDUAL" | "BUSINESS" | "UBO" | "DIRECTOR";
1151
+ document_type_code: string;
1152
+ is_mandatory: boolean;
1153
+ alternative_group?: object;
1154
+ min_count?: object | null;
1155
+ priority: number;
1156
+ is_active: boolean;
1157
+ }
1158
+ export interface CreateRuleRequestDto {
1159
+ /** ISO 3166-1 alpha-2; null = wildcard */
1160
+ country_code?: string;
1161
+ customer_type?: "INDIVIDUAL" | "SME" | "CORPORATE";
1162
+ risk_level?: "LOW" | "MEDIUM" | "HIGH";
1163
+ subject_role: "INDIVIDUAL" | "BUSINESS" | "UBO" | "DIRECTOR";
1164
+ document_type_code: string;
1165
+ is_mandatory: boolean;
1166
+ alternative_group?: string;
1152
1167
  /**
1153
- * Person unique identifier
1154
- * @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
1155
- */
1156
- personId: string;
1157
- firstName: string;
1158
- lastName: string;
1159
- fatherName: string;
1160
- motherName: string;
1161
- /**
1162
- * Full national ID number (decrypted)
1163
- * @example "12345678901234"
1164
- */
1165
- nationalIdNumber: string;
1166
- nationality: string;
1167
- dateOfBirth: string;
1168
- address: string;
1169
- documentType: "passport" | "national_id";
1170
- /**
1171
- * KYC provider (MANUAL, AUTOMATED, etc.)
1172
- * @example "MANUAL"
1173
- */
1174
- provider: string;
1175
- /**
1176
- * KYC request status
1177
- * @example "pending"
1178
- */
1179
- status: "pending" | "under_review" | "verified" | "rejected";
1180
- /** Uploaded documents for this request */
1181
- documents: KycDocumentResponseDto[];
1182
- /**
1183
- * Timestamp when the request entered review
1184
- * @example "2025-01-01T12:00:00.000Z"
1185
- */
1186
- reviewAt: string | null;
1187
- /**
1188
- * Rejection reason if status is rejected
1189
- * @example "DOCUMENT_BLURRY"
1168
+ * KYB scope — business type code; null/omit = any business type
1169
+ * @example "LLC"
1190
1170
  */
1191
- rejectionReason: string | null;
1171
+ business_type?: string;
1192
1172
  /**
1193
- * Admin identifier who reviewed the request
1194
- * @example "admin-123"
1173
+ * Minimum subjects required for this rule's subject_role (e.g. 2 UBOs). Omit to use the resolver default.
1174
+ * @min 1
1195
1175
  */
1196
- reviewedByAdminId: string | null;
1176
+ min_count?: number;
1177
+ /** @default 100 */
1178
+ priority: number;
1179
+ }
1180
+ export interface PatchRuleRequestDto {
1181
+ is_mandatory?: boolean;
1182
+ alternative_group?: string;
1183
+ priority?: number;
1184
+ is_active?: boolean;
1185
+ /** @min 1 */
1186
+ min_count?: number;
1187
+ }
1188
+ export interface PreviewRequirementsRequestDto {
1197
1189
  /**
1198
- * Email of the admin who reviewed the request
1199
- * @example "admin@tamm.com"
1190
+ * ISO 3166-1 alpha-2 country code
1191
+ * @example "EG"
1200
1192
  */
1201
- reviewedByAdminEmail: string | null;
1193
+ country: string;
1194
+ customer_type: "INDIVIDUAL" | "SME" | "CORPORATE";
1195
+ risk_level: "LOW" | "MEDIUM" | "HIGH";
1202
1196
  /**
1203
- * Creation timestamp of the request
1204
- * @example "2025-01-01T11:00:00.000Z"
1197
+ * KYB only business type code to preview
1198
+ * @example "LLC"
1205
1199
  */
1206
- createdAt: string;
1207
- /** @example "2025-01-01T11:00:00.000Z" */
1208
- updatedAt: string;
1200
+ business_type?: string;
1201
+ /** Language override for labels */
1202
+ lang?: string;
1209
1203
  }
1210
- export interface UpdateKycStatusDto {
1204
+ export interface BusinessTypeResponseDto {
1205
+ id: string;
1206
+ code: string;
1207
+ name_i18n: object;
1208
+ description_i18n?: object;
1209
+ customer_type?: object | null;
1210
+ is_active: boolean;
1211
+ created_by: string;
1212
+ created_at: string;
1213
+ }
1214
+ export interface CreateBusinessTypeRequestDto {
1211
1215
  /**
1212
- * Target status: under_review (start review), rejected or verified (approve)
1213
- * @example "under_review"
1216
+ * Unique code, e.g. "LLC"
1217
+ * @example "LLC"
1214
1218
  */
1215
- status: "pending" | "under_review" | "verified" | "rejected";
1219
+ code: string;
1216
1220
  /**
1217
- * Rejection reason
1218
- * @example "Document is blurry"
1221
+ * i18n name map
1222
+ * @example {"en":"LLC","ar":"ش.ذ.م.م"}
1219
1223
  */
1220
- rejectionReason: string;
1224
+ name_i18n: object;
1225
+ /** i18n description map */
1226
+ description_i18n?: object;
1227
+ /** Which customer_type this business type belongs to (null = any) */
1228
+ customer_type?: "INDIVIDUAL" | "SME" | "CORPORATE";
1229
+ }
1230
+ export interface PatchBusinessTypeRequestDto {
1231
+ is_active?: boolean;
1232
+ name_i18n?: object;
1233
+ description_i18n?: object;
1234
+ customer_type?: "INDIVIDUAL" | "SME" | "CORPORATE";
1221
1235
  }
1222
1236
  export interface AmlRuleDto {
1223
1237
  /**
@@ -1729,7 +1743,7 @@ export interface TransactionResponseDto {
1729
1743
  * Transaction status
1730
1744
  * @example "COMPLETED"
1731
1745
  */
1732
- status: "VOUCHER_PENDING" | "INITIATED" | "VALIDATING" | "AUTHORIZED" | "RESERVED" | "POSTING" | "COMPLETED" | "REJECTED" | "DECLINED" | "CANCELLED" | "FAILED" | "REVERSING" | "REVERSED";
1746
+ status: "COMPLETED" | "FAILED" | "VOUCHER_PENDING" | "REVERSED";
1733
1747
  /**
1734
1748
  * Transaction description
1735
1749
  * @example "Payment for services"
@@ -1741,10 +1755,10 @@ export interface TransactionResponseDto {
1741
1755
  */
1742
1756
  correlationId: string;
1743
1757
  /**
1744
- * Human-readable reason for the current status (e.g. AML decline reason)
1745
- * @example "Transaction declined due to high risk (risk score: 85, matched rules: 2)"
1758
+ * Deprecated kept for wire compatibility. Failure reasons now ride the transaction.failed event payload; AML reasons live in transaction_summaries.
1759
+ * @example ""
1746
1760
  */
1747
- statusReason: string;
1761
+ statusReason?: string;
1748
1762
  /**
1749
1763
  * Transaction creation timestamp (ISO format)
1750
1764
  * @example "2024-01-15T12:00:00Z"
@@ -1849,8 +1863,8 @@ export interface AdminAccountDetailResponseDto {
1849
1863
  */
1850
1864
  id: string;
1851
1865
  /**
1852
- * Human-readable 16-digit account number. Only set for main accounts.
1853
- * @example "1076012345678903"
1866
+ * Human-readable 22-digit account number. Only set for main accounts.
1867
+ * @example "0017601010000001000011"
1854
1868
  */
1855
1869
  accountNumber?: string;
1856
1870
  /**
@@ -1985,10 +1999,13 @@ export interface AdminTransactionItemDto {
1985
1999
  /** @example "P2P_TRANSFER" */
1986
2000
  type: "P2P_TRANSFER" | "WITHDRAWAL" | "TOP_UP" | "MERCHANT_PAYMENT" | "REVERSAL" | "REFUND" | "MOVING";
1987
2001
  /** @example "COMPLETED" */
1988
- status: "INITIATED" | "VALIDATING" | "AUTHORIZED" | "RESERVED" | "POSTING" | "COMPLETED" | "REJECTED" | "DECLINED" | "CANCELLED" | "FAILED" | "REVERSING" | "REVERSED";
2002
+ status: "COMPLETED" | "FAILED" | "VOUCHER_PENDING" | "REVERSED";
1989
2003
  /** @example "Payment for services" */
1990
2004
  description?: string;
1991
- /** @example 0 */
2005
+ /**
2006
+ * AML risk score (0-100). Computed asynchronously after the transaction is posted; admin views fetch this from aml-service.transaction_summaries via gRPC and merge it in.
2007
+ * @example 0
2008
+ */
1992
2009
  amlRiskScore: number;
1993
2010
  /** @example "LOW" */
1994
2011
  amlRiskLevel: "LOW" | "MEDIUM" | "HIGH" | "CRITICAL";
@@ -2724,6 +2741,95 @@ export interface ResolveDlqMessageDto {
2724
2741
  */
2725
2742
  note?: string;
2726
2743
  }
2744
+ export interface BankBranchResponseDto {
2745
+ /** @example "001" */
2746
+ code: string;
2747
+ name: LocalizedNameDto;
2748
+ /** @example true */
2749
+ isActive: boolean;
2750
+ /** @format date-time */
2751
+ createdAt: string;
2752
+ /** @format date-time */
2753
+ updatedAt: string;
2754
+ }
2755
+ export interface BankBranchesListResponseDto {
2756
+ branches: BankBranchResponseDto[];
2757
+ }
2758
+ export interface CreateBankBranchDto {
2759
+ /**
2760
+ * 3-digit branch code (immutable once issued)
2761
+ * @example "002"
2762
+ */
2763
+ code: string;
2764
+ /** Translatable display name */
2765
+ name: LocalizedNameDto;
2766
+ }
2767
+ export interface UpdateBankBranchDto {
2768
+ name?: LocalizedNameDto;
2769
+ /** Toggle whether this branch can issue new account numbers */
2770
+ isActive?: boolean;
2771
+ }
2772
+ export interface AccountTypeResponseDto {
2773
+ /** @example "10" */
2774
+ code: string;
2775
+ /**
2776
+ * Matches accountTypeEnum value
2777
+ * @example "personal"
2778
+ */
2779
+ key: string;
2780
+ name: LocalizedNameDto;
2781
+ /** @example true */
2782
+ isActive: boolean;
2783
+ /** @format date-time */
2784
+ createdAt: string;
2785
+ /** @format date-time */
2786
+ updatedAt: string;
2787
+ }
2788
+ export interface AccountTypesListResponseDto {
2789
+ accountTypes: AccountTypeResponseDto[];
2790
+ }
2791
+ export interface UpdateAccountTypeDto {
2792
+ name?: LocalizedNameDto;
2793
+ /** Toggle whether the generator may issue new account numbers of this type */
2794
+ isActive?: boolean;
2795
+ }
2796
+ export interface CurrencyConfigResponseDto {
2797
+ /** @example "USD" */
2798
+ code: string;
2799
+ /** @example "840" */
2800
+ numericCode: string;
2801
+ name: LocalizedNameDto;
2802
+ /** @example true */
2803
+ isActive: boolean;
2804
+ /** @format date-time */
2805
+ createdAt: string;
2806
+ }
2807
+ export interface CurrencyConfigListResponseDto {
2808
+ currencies: CurrencyConfigResponseDto[];
2809
+ }
2810
+ export interface CreateCurrencyConfigDto {
2811
+ /**
2812
+ * ISO 4217 alpha-3 code
2813
+ * @example "EUR"
2814
+ */
2815
+ code: string;
2816
+ /**
2817
+ * ISO 4217 numeric code (3 digits)
2818
+ * @example "978"
2819
+ */
2820
+ numericCode: string;
2821
+ name: LocalizedNameDto;
2822
+ }
2823
+ export interface UpdateCurrencyConfigDto {
2824
+ /**
2825
+ * ISO 4217 numeric code (3 digits)
2826
+ * @example "978"
2827
+ */
2828
+ numericCode?: string;
2829
+ name?: LocalizedNameDto;
2830
+ /** Toggle whether the generator may issue new account numbers in this currency */
2831
+ isActive?: boolean;
2832
+ }
2727
2833
  export type LoginData = AdminLoginResponseDto;
2728
2834
  export type LoginError = ErrorResponseDto;
2729
2835
  export type RefreshData = AdminLoginResponseDto;
@@ -2903,7 +3009,7 @@ export interface FindAllParams6 {
2903
3009
  */
2904
3010
  endDate?: string;
2905
3011
  }
2906
- export type FindAllResult1 = ActivityLogListResponseDto;
3012
+ export type FindAllOutput1 = ActivityLogListResponseDto;
2907
3013
  export interface FindAllParams8 {
2908
3014
  /**
2909
3015
  * Page number (1-based)
@@ -2926,7 +3032,7 @@ export interface FindAllParams8 {
2926
3032
  */
2927
3033
  read?: boolean;
2928
3034
  }
2929
- export type FindAllOutput1 = AdminNotificationListResponseDto;
3035
+ export type FindAllResult1 = AdminNotificationListResponseDto;
2930
3036
  export type GetUnreadCountData = any;
2931
3037
  export interface MarkAsReadParams {
2932
3038
  /** Notification ID */
@@ -2977,11 +3083,6 @@ export interface CreateAgentWalletParams {
2977
3083
  id: string;
2978
3084
  }
2979
3085
  export type CreateAgentWalletData = AdminAccountResponseDto;
2980
- export interface UpsertAgentBranchesParams {
2981
- /** Agent ID */
2982
- id: string;
2983
- }
2984
- export type UpsertAgentBranchesData = BranchesUpsertResponseDto;
2985
3086
  export interface UpsertAgentLimitsParams {
2986
3087
  /** Agent ID (UUID) */
2987
3088
  id: string;
@@ -2992,11 +3093,6 @@ export interface UpsertAgentCommissionsParams {
2992
3093
  id: string;
2993
3094
  }
2994
3095
  export type UpsertAgentCommissionsData = AgentCommissionsResponseDto;
2995
- export interface DeleteBranchParams {
2996
- /** Branch ID (UUID) */
2997
- branchId: string;
2998
- }
2999
- export type DeleteBranchData = MessageResponseDto;
3000
3096
  export interface DeleteLimitParams {
3001
3097
  /** Limit ID (UUID) */
3002
3098
  limitId: string;
@@ -3007,45 +3103,99 @@ export interface DeleteCommissionParams {
3007
3103
  commissionId: string;
3008
3104
  }
3009
3105
  export type DeleteCommissionData = MessageResponseDto;
3010
- export type GetStatisticsResult = KycStatisticsResponseDto;
3011
- export interface FindAllParams10 {
3106
+ export type StatisticsData = SubmissionStatisticsResponseDto;
3107
+ export interface ListParams {
3108
+ status?: "PENDING_UPLOAD" | "UPLOADED" | "UNDER_REVIEW" | "APPROVED" | "REJECTED" | "EXPIRED";
3109
+ subject_id?: string;
3110
+ subject_role?: "INDIVIDUAL" | "BUSINESS" | "UBO" | "DIRECTOR";
3012
3111
  /**
3013
- * Page number (1-based)
3014
3112
  * @min 1
3015
3113
  * @default 1
3016
- * @example 1
3017
3114
  */
3018
3115
  page?: number;
3019
3116
  /**
3020
- * Number of items per page
3021
3117
  * @min 1
3022
3118
  * @max 200
3023
3119
  * @default 20
3024
- * @example 20
3025
3120
  */
3026
3121
  limit?: number;
3027
- /**
3028
- * Filter by KYC status
3029
- * @example "pending"
3030
- */
3031
- status?: "pending" | "under_review" | "verified" | "rejected";
3032
- /**
3033
- * Search by KYC request ID or person ID
3034
- * @example "kyc-001"
3035
- */
3036
- search?: string;
3037
3122
  }
3038
- export type FindAllResult2 = KycListResponseDto;
3039
- export interface FindByIdParams6 {
3040
- /** KYC request ID */
3123
+ export type ListData = SubmissionListResponseDto;
3124
+ export interface GetParams {
3125
+ id: string;
3126
+ }
3127
+ export type GetData = SubmissionResponseDto;
3128
+ export interface StartReviewParams {
3129
+ id: string;
3130
+ }
3131
+ export type StartReviewData = any;
3132
+ export interface ApproveParams {
3041
3133
  id: string;
3042
3134
  }
3043
- export type FindByIdResult1 = KycRequestResponseDto;
3044
- export interface UpdateStatusParams2 {
3045
- /** KYC request ID */
3135
+ export type ApproveData = any;
3136
+ export interface RejectParams {
3046
3137
  id: string;
3047
3138
  }
3048
- export type UpdateStatusResult = KycRequestResponseDto;
3139
+ export type RejectData = any;
3140
+ export interface PatchFieldsParams {
3141
+ id: string;
3142
+ }
3143
+ export type PatchFieldsData = any;
3144
+ export interface List2Params {
3145
+ only_active: string;
3146
+ }
3147
+ export type List2Data = DocumentTypeResponseDto[];
3148
+ export type CreateResult1 = any;
3149
+ export interface ListVersionsParams {
3150
+ code: string;
3151
+ }
3152
+ export type ListVersionsData = any;
3153
+ export interface CreateVersionParams {
3154
+ code: string;
3155
+ }
3156
+ export type CreateVersionData = any;
3157
+ export interface PatchParams {
3158
+ id: string;
3159
+ }
3160
+ export type PatchData = any;
3161
+ export interface RemoveParams {
3162
+ id: string;
3163
+ }
3164
+ export type RemoveData = any;
3165
+ export interface List3Params {
3166
+ country_code?: string;
3167
+ customer_type?: "INDIVIDUAL" | "SME" | "CORPORATE";
3168
+ risk_level?: "LOW" | "MEDIUM" | "HIGH";
3169
+ subject_role?: "INDIVIDUAL" | "BUSINESS" | "UBO" | "DIRECTOR";
3170
+ document_type_code?: string;
3171
+ /** KYB business type code filter */
3172
+ business_type?: string;
3173
+ only_active?: boolean;
3174
+ }
3175
+ export type List3Data = RuleResponseDto[];
3176
+ export type Create2Data = any;
3177
+ export interface Patch2Params {
3178
+ id: string;
3179
+ }
3180
+ export type Patch2Data = any;
3181
+ export interface Remove2Params {
3182
+ id: string;
3183
+ }
3184
+ export type Remove2Data = any;
3185
+ export type PreviewData = any;
3186
+ export interface List4Params {
3187
+ only_active: string;
3188
+ }
3189
+ export type List4Data = BusinessTypeResponseDto[];
3190
+ export type Create3Data = any;
3191
+ export interface Patch3Params {
3192
+ id: string;
3193
+ }
3194
+ export type Patch3Data = any;
3195
+ export interface Remove3Params {
3196
+ id: string;
3197
+ }
3198
+ export type Remove3Data = any;
3049
3199
  export interface GetAmlRulesParams {
3050
3200
  currency?: "SYP" | "USD" | "EUR";
3051
3201
  isActive?: boolean;
@@ -3101,7 +3251,7 @@ export interface AssignAlertParams {
3101
3251
  }
3102
3252
  export type AssignAlertData = AmlAlertDto;
3103
3253
  export type AssignAlertError = ErrorResponseDto;
3104
- export type GetStatisticsOutput = AccountStatisticsResponseDto;
3254
+ export type GetStatisticsResult = AccountStatisticsResponseDto;
3105
3255
  export interface ListAccountsParams {
3106
3256
  /**
3107
3257
  * Page number (1-based)
@@ -3175,7 +3325,7 @@ export interface UpdateAccountStatusParams {
3175
3325
  id: string;
3176
3326
  }
3177
3327
  export type UpdateAccountStatusData = AdminAccountResponseDto;
3178
- export interface GetStatisticsParams3 {
3328
+ export interface GetStatisticsParams2 {
3179
3329
  /** Start date filter (ISO date, e.g. 2025-01-01) */
3180
3330
  startDate?: string;
3181
3331
  /** End date filter (ISO date, e.g. 2025-12-31) */
@@ -3183,7 +3333,7 @@ export interface GetStatisticsParams3 {
3183
3333
  /** Filter by currency */
3184
3334
  currency?: "SYP" | "USD" | "EUR";
3185
3335
  }
3186
- export type GetStatisticsResult1 = TransactionStatisticsResponseDto;
3336
+ export type GetStatisticsOutput = TransactionStatisticsResponseDto;
3187
3337
  export interface ListTransactionsParams {
3188
3338
  /** Search by transaction ID or public transaction ID */
3189
3339
  search?: string;
@@ -3220,7 +3370,7 @@ export type SendGlobalNotificationData = SendGlobalNotificationResponseDto;
3220
3370
  export type SendGlobalNotificationError = ErrorResponseDto;
3221
3371
  export type CreateData1 = ScheduledNotificationResponseDto;
3222
3372
  export type CreateErrorData = ErrorResponseDto;
3223
- export interface FindAllParams12 {
3373
+ export interface FindAllParams10 {
3224
3374
  /** Filter by status */
3225
3375
  status?: "pending" | "sent" | "failed" | "cancelled";
3226
3376
  /**
@@ -3235,7 +3385,7 @@ export interface FindAllParams12 {
3235
3385
  */
3236
3386
  limit?: number;
3237
3387
  }
3238
- export type FindAllData1 = ScheduledNotificationsListResponseDto;
3388
+ export type FindAllResult2 = ScheduledNotificationsListResponseDto;
3239
3389
  export interface FindOneParams {
3240
3390
  /** MongoDB ObjectId */
3241
3391
  id: string;
@@ -3246,13 +3396,13 @@ export interface UpdateParams6 {
3246
3396
  /** MongoDB ObjectId */
3247
3397
  id: string;
3248
3398
  }
3249
- export type UpdateResult1 = ScheduledNotificationResponseDto;
3399
+ export type UpdateOutput1 = ScheduledNotificationResponseDto;
3250
3400
  export type UpdateErrorData = ErrorResponseDto;
3251
- export interface RemoveParams {
3401
+ export interface RemoveParams2 {
3252
3402
  /** MongoDB ObjectId */
3253
3403
  id: string;
3254
3404
  }
3255
- export type RemoveData = any;
3405
+ export type RemoveResult = any;
3256
3406
  export type RemoveError = ErrorResponseDto;
3257
3407
  export interface GetSystemConfigsParams {
3258
3408
  /** Filter by config key */
@@ -3309,14 +3459,14 @@ export interface DeleteDocumentParams {
3309
3459
  }
3310
3460
  export type DeleteDocumentData = any;
3311
3461
  export type DeleteDocumentError = ErrorResponseDto;
3312
- export type ListData = AppVersionPolicyListResponseDto;
3462
+ export type ListResult = AppVersionPolicyListResponseDto;
3313
3463
  export type UpsertData = AppVersionPolicyDto;
3314
- export interface GetParams {
3464
+ export interface GetParams2 {
3315
3465
  platform: "ios" | "android";
3316
3466
  }
3317
- export type GetData = AppVersionPolicyDto;
3318
- export type GetStatisticsResult2 = UserStatisticsResponseDto;
3319
- export interface FindAllParams14 {
3467
+ export type GetResult = AppVersionPolicyDto;
3468
+ export type GetStatisticsOutput1 = UserStatisticsResponseDto;
3469
+ export interface FindAllParams12 {
3320
3470
  /**
3321
3471
  * Page number (1-based)
3322
3472
  * @min 1
@@ -3404,11 +3554,11 @@ export interface ExportUsersParams {
3404
3554
  export type ExportUsersData = any;
3405
3555
  export type GetSecurityQuestionsByPhoneData = GetSecurityQuestionsByPhoneResponseDto;
3406
3556
  export type RegenerateRecoveryCodeData = RegenerateRecoveryCodeByPhoneResponseDto;
3407
- export interface FindByIdParams8 {
3557
+ export interface FindByIdParams6 {
3408
3558
  /** Person ID (UUID) */
3409
3559
  id: string;
3410
3560
  }
3411
- export type FindByIdResult2 = PersonDetailDto;
3561
+ export type FindByIdData1 = PersonDetailDto;
3412
3562
  export interface UpdatePersonStatusParams {
3413
3563
  /** Person ID (UUID) */
3414
3564
  id: string;
@@ -3419,7 +3569,7 @@ export interface UpdateUserStatusParams {
3419
3569
  id: string;
3420
3570
  }
3421
3571
  export type UpdateUserStatusData = any;
3422
- export interface FindAllParams16 {
3572
+ export interface FindAllParams14 {
3423
3573
  /**
3424
3574
  * Page number (1-based)
3425
3575
  * @default 1
@@ -3448,14 +3598,60 @@ export interface FindAllParams16 {
3448
3598
  */
3449
3599
  endDate?: string;
3450
3600
  }
3451
- export type FindAllData2 = DlqMessageListResponseDto;
3601
+ export type FindAllData1 = DlqMessageListResponseDto;
3452
3602
  export type PendingByTopicData = DlqPendingByTopicResponseDto[];
3453
- export interface FindByIdParams10 {
3603
+ export interface FindByIdParams8 {
3454
3604
  id: string;
3455
3605
  }
3456
- export type FindByIdData1 = DlqMessageResponseDto;
3606
+ export type FindByIdResult1 = DlqMessageResponseDto;
3457
3607
  export interface ResolveParams {
3458
3608
  id: string;
3459
3609
  }
3460
3610
  export type ResolveData = DlqMessageResponseDto;
3611
+ export interface ListParams3 {
3612
+ /** Return only active branches */
3613
+ onlyActive?: boolean;
3614
+ }
3615
+ export type ListOutput = BankBranchesListResponseDto;
3616
+ export type CreateResult2 = BankBranchResponseDto;
3617
+ export interface GetByCodeParams {
3618
+ /** 3-digit branch code */
3619
+ code: string;
3620
+ }
3621
+ export type GetByCodeData = BankBranchResponseDto;
3622
+ export interface UpdateParams8 {
3623
+ /** 3-digit branch code */
3624
+ code: string;
3625
+ }
3626
+ export type UpdateResult1 = BankBranchResponseDto;
3627
+ export interface ListParams5 {
3628
+ onlyActive?: boolean;
3629
+ }
3630
+ export type ListData1 = AccountTypesListResponseDto;
3631
+ export interface UpdateParams10 {
3632
+ /** 2-digit account-type code */
3633
+ code: string;
3634
+ }
3635
+ export type UpdateOutput2 = AccountTypeResponseDto;
3636
+ export interface ListParams7 {
3637
+ onlyActive?: boolean;
3638
+ }
3639
+ export type ListResult1 = CurrencyConfigListResponseDto;
3640
+ export type CreateResult3 = CurrencyConfigResponseDto;
3641
+ export interface GetByCodeParams2 {
3642
+ /** ISO 4217 alpha-3 code (e.g. USD) */
3643
+ code: string;
3644
+ }
3645
+ export type GetByCodeResult = CurrencyConfigResponseDto;
3646
+ export interface DeleteParams6 {
3647
+ /** ISO 4217 alpha-3 code */
3648
+ code: string;
3649
+ }
3650
+ export type DeleteResult1 = any;
3651
+ export interface UpdateParams12 {
3652
+ /** ISO 4217 alpha-3 code */
3653
+ code: string;
3654
+ }
3655
+ export type UpdateOutput3 = CurrencyConfigResponseDto;
3656
+ export type IndexData = any;
3461
3657
  //# sourceMappingURL=data-contracts.d.ts.map