@enfuce/nextgen-sdk 0.0.2 → 0.0.3

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 (221) hide show
  1. package/dist/authorisation-control/api.d.ts +0 -302
  2. package/dist/authorisation-control/api.js +10 -28
  3. package/dist/authorisation-control/base.d.ts +0 -24
  4. package/dist/authorisation-control/base.js +0 -19
  5. package/dist/authorisation-control/common.d.ts +4 -35
  6. package/dist/authorisation-control/common.js +16 -38
  7. package/dist/authorisation-control/configuration.d.ts +24 -17
  8. package/dist/authorisation-control/configuration.js +3 -3
  9. package/dist/card/api.d.ts +41 -740
  10. package/dist/card/api.js +38 -105
  11. package/dist/card/base.d.ts +0 -24
  12. package/dist/card/base.js +0 -19
  13. package/dist/card/common.d.ts +4 -35
  14. package/dist/card/common.js +16 -38
  15. package/dist/card/configuration.d.ts +24 -17
  16. package/dist/card/configuration.js +3 -3
  17. package/dist/cardholder/api.d.ts +959 -686
  18. package/dist/cardholder/api.js +783 -73
  19. package/dist/cardholder/base.d.ts +0 -24
  20. package/dist/cardholder/base.js +0 -19
  21. package/dist/cardholder/common.d.ts +4 -35
  22. package/dist/cardholder/common.js +16 -38
  23. package/dist/cardholder/configuration.d.ts +24 -17
  24. package/dist/cardholder/configuration.js +3 -3
  25. package/dist/cards/api.d.ts +0 -7
  26. package/dist/cards/api.js +2 -9
  27. package/dist/cards/base.d.ts +0 -24
  28. package/dist/cards/base.js +0 -19
  29. package/dist/cards/common.d.ts +4 -35
  30. package/dist/cards/common.js +16 -38
  31. package/dist/cards/configuration.d.ts +24 -17
  32. package/dist/cards/configuration.js +3 -3
  33. package/dist/clearing-file-copy/api.d.ts +0 -497
  34. package/dist/clearing-file-copy/api.js +12 -26
  35. package/dist/clearing-file-copy/base.d.ts +0 -24
  36. package/dist/clearing-file-copy/base.js +0 -19
  37. package/dist/clearing-file-copy/common.d.ts +4 -35
  38. package/dist/clearing-file-copy/common.js +16 -38
  39. package/dist/clearing-file-copy/configuration.d.ts +24 -17
  40. package/dist/clearing-file-copy/configuration.js +3 -3
  41. package/dist/esm/authorisation-control/api.d.ts +0 -302
  42. package/dist/esm/authorisation-control/api.js +10 -28
  43. package/dist/esm/authorisation-control/base.d.ts +0 -24
  44. package/dist/esm/authorisation-control/base.js +0 -19
  45. package/dist/esm/authorisation-control/common.d.ts +4 -35
  46. package/dist/esm/authorisation-control/common.js +14 -37
  47. package/dist/esm/authorisation-control/configuration.d.ts +24 -17
  48. package/dist/esm/authorisation-control/configuration.js +3 -3
  49. package/dist/esm/card/api.d.ts +41 -740
  50. package/dist/esm/card/api.js +38 -105
  51. package/dist/esm/card/base.d.ts +0 -24
  52. package/dist/esm/card/base.js +0 -19
  53. package/dist/esm/card/common.d.ts +4 -35
  54. package/dist/esm/card/common.js +14 -37
  55. package/dist/esm/card/configuration.d.ts +24 -17
  56. package/dist/esm/card/configuration.js +3 -3
  57. package/dist/esm/cardholder/api.d.ts +959 -686
  58. package/dist/esm/cardholder/api.js +782 -72
  59. package/dist/esm/cardholder/base.d.ts +0 -24
  60. package/dist/esm/cardholder/base.js +0 -19
  61. package/dist/esm/cardholder/common.d.ts +4 -35
  62. package/dist/esm/cardholder/common.js +14 -37
  63. package/dist/esm/cardholder/configuration.d.ts +24 -17
  64. package/dist/esm/cardholder/configuration.js +3 -3
  65. package/dist/esm/cards/api.d.ts +0 -7
  66. package/dist/esm/cards/api.js +2 -9
  67. package/dist/esm/cards/base.d.ts +0 -24
  68. package/dist/esm/cards/base.js +0 -19
  69. package/dist/esm/cards/common.d.ts +4 -35
  70. package/dist/esm/cards/common.js +14 -37
  71. package/dist/esm/cards/configuration.d.ts +24 -17
  72. package/dist/esm/cards/configuration.js +3 -3
  73. package/dist/esm/clearing-file-copy/api.d.ts +0 -497
  74. package/dist/esm/clearing-file-copy/api.js +12 -26
  75. package/dist/esm/clearing-file-copy/base.d.ts +0 -24
  76. package/dist/esm/clearing-file-copy/base.js +0 -19
  77. package/dist/esm/clearing-file-copy/common.d.ts +4 -35
  78. package/dist/esm/clearing-file-copy/common.js +14 -37
  79. package/dist/esm/clearing-file-copy/configuration.d.ts +24 -17
  80. package/dist/esm/clearing-file-copy/configuration.js +3 -3
  81. package/dist/esm/issuer-events/api.d.ts +639 -601
  82. package/dist/esm/issuer-events/api.js +520 -54
  83. package/dist/esm/issuer-events/base.d.ts +0 -24
  84. package/dist/esm/issuer-events/base.js +0 -19
  85. package/dist/esm/issuer-events/common.d.ts +4 -35
  86. package/dist/esm/issuer-events/common.js +14 -37
  87. package/dist/esm/issuer-events/configuration.d.ts +24 -17
  88. package/dist/esm/issuer-events/configuration.js +3 -3
  89. package/dist/esm/pin/api.d.ts +0 -76
  90. package/dist/esm/pin/api.js +3 -15
  91. package/dist/esm/pin/base.d.ts +0 -24
  92. package/dist/esm/pin/base.js +0 -19
  93. package/dist/esm/pin/common.d.ts +4 -35
  94. package/dist/esm/pin/common.js +14 -37
  95. package/dist/esm/pin/configuration.d.ts +24 -17
  96. package/dist/esm/pin/configuration.js +3 -3
  97. package/dist/esm/threeds/api.d.ts +0 -18
  98. package/dist/esm/threeds/api.js +1 -8
  99. package/dist/esm/threeds/base.d.ts +0 -24
  100. package/dist/esm/threeds/base.js +0 -19
  101. package/dist/esm/threeds/common.d.ts +4 -35
  102. package/dist/esm/threeds/common.js +14 -37
  103. package/dist/esm/threeds/configuration.d.ts +24 -17
  104. package/dist/esm/threeds/configuration.js +3 -3
  105. package/dist/esm/threeds-oob/api.d.ts +0 -90
  106. package/dist/esm/threeds-oob/api.js +2 -9
  107. package/dist/esm/threeds-oob/base.d.ts +0 -24
  108. package/dist/esm/threeds-oob/base.js +0 -19
  109. package/dist/esm/threeds-oob/common.d.ts +4 -35
  110. package/dist/esm/threeds-oob/common.js +14 -37
  111. package/dist/esm/threeds-oob/configuration.d.ts +24 -17
  112. package/dist/esm/threeds-oob/configuration.js +3 -3
  113. package/dist/esm/transaction-event/api.d.ts +0 -452
  114. package/dist/esm/transaction-event/api.js +11 -27
  115. package/dist/esm/transaction-event/base.d.ts +0 -24
  116. package/dist/esm/transaction-event/base.js +0 -19
  117. package/dist/esm/transaction-event/common.d.ts +4 -35
  118. package/dist/esm/transaction-event/common.js +14 -37
  119. package/dist/esm/transaction-event/configuration.d.ts +24 -17
  120. package/dist/esm/transaction-event/configuration.js +3 -3
  121. package/dist/esm/wallet/api.d.ts +0 -342
  122. package/dist/esm/wallet/api.js +29 -83
  123. package/dist/esm/wallet/base.d.ts +0 -24
  124. package/dist/esm/wallet/base.js +0 -19
  125. package/dist/esm/wallet/common.d.ts +4 -35
  126. package/dist/esm/wallet/common.js +14 -37
  127. package/dist/esm/wallet/configuration.d.ts +24 -17
  128. package/dist/esm/wallet/configuration.js +3 -3
  129. package/dist/issuer-events/api.d.ts +639 -601
  130. package/dist/issuer-events/api.js +521 -55
  131. package/dist/issuer-events/base.d.ts +0 -24
  132. package/dist/issuer-events/base.js +0 -19
  133. package/dist/issuer-events/common.d.ts +4 -35
  134. package/dist/issuer-events/common.js +16 -38
  135. package/dist/issuer-events/configuration.d.ts +24 -17
  136. package/dist/issuer-events/configuration.js +3 -3
  137. package/dist/pin/api.d.ts +0 -76
  138. package/dist/pin/api.js +3 -15
  139. package/dist/pin/base.d.ts +0 -24
  140. package/dist/pin/base.js +0 -19
  141. package/dist/pin/common.d.ts +4 -35
  142. package/dist/pin/common.js +16 -38
  143. package/dist/pin/configuration.d.ts +24 -17
  144. package/dist/pin/configuration.js +3 -3
  145. package/dist/threeds/api.d.ts +0 -18
  146. package/dist/threeds/api.js +1 -8
  147. package/dist/threeds/base.d.ts +0 -24
  148. package/dist/threeds/base.js +0 -19
  149. package/dist/threeds/common.d.ts +4 -35
  150. package/dist/threeds/common.js +16 -38
  151. package/dist/threeds/configuration.d.ts +24 -17
  152. package/dist/threeds/configuration.js +3 -3
  153. package/dist/threeds-oob/api.d.ts +0 -90
  154. package/dist/threeds-oob/api.js +2 -9
  155. package/dist/threeds-oob/base.d.ts +0 -24
  156. package/dist/threeds-oob/base.js +0 -19
  157. package/dist/threeds-oob/common.d.ts +4 -35
  158. package/dist/threeds-oob/common.js +16 -38
  159. package/dist/threeds-oob/configuration.d.ts +24 -17
  160. package/dist/threeds-oob/configuration.js +3 -3
  161. package/dist/transaction-event/api.d.ts +0 -452
  162. package/dist/transaction-event/api.js +11 -27
  163. package/dist/transaction-event/base.d.ts +0 -24
  164. package/dist/transaction-event/base.js +0 -19
  165. package/dist/transaction-event/common.d.ts +4 -35
  166. package/dist/transaction-event/common.js +16 -38
  167. package/dist/transaction-event/configuration.d.ts +24 -17
  168. package/dist/transaction-event/configuration.js +3 -3
  169. package/dist/wallet/api.d.ts +0 -342
  170. package/dist/wallet/api.js +29 -83
  171. package/dist/wallet/base.d.ts +0 -24
  172. package/dist/wallet/base.js +0 -19
  173. package/dist/wallet/common.d.ts +4 -35
  174. package/dist/wallet/common.js +16 -38
  175. package/dist/wallet/configuration.d.ts +24 -17
  176. package/dist/wallet/configuration.js +3 -3
  177. package/package.json +2 -2
  178. package/src/authorisation-control/api.ts +11 -314
  179. package/src/authorisation-control/base.ts +0 -24
  180. package/src/authorisation-control/common.ts +15 -38
  181. package/src/authorisation-control/configuration.ts +26 -20
  182. package/src/card/api.ts +80 -786
  183. package/src/card/base.ts +0 -24
  184. package/src/card/common.ts +15 -38
  185. package/src/card/configuration.ts +26 -20
  186. package/src/cardholder/api.ts +987 -714
  187. package/src/cardholder/base.ts +0 -24
  188. package/src/cardholder/common.ts +15 -38
  189. package/src/cardholder/configuration.ts +26 -20
  190. package/src/cards/api.ts +3 -11
  191. package/src/cards/base.ts +0 -24
  192. package/src/cards/common.ts +15 -38
  193. package/src/cards/configuration.ts +26 -20
  194. package/src/clearing-file-copy/api.ts +13 -510
  195. package/src/clearing-file-copy/base.ts +0 -24
  196. package/src/clearing-file-copy/common.ts +15 -38
  197. package/src/clearing-file-copy/configuration.ts +26 -20
  198. package/src/issuer-events/api.ts +661 -628
  199. package/src/issuer-events/base.ts +0 -24
  200. package/src/issuer-events/common.ts +15 -38
  201. package/src/issuer-events/configuration.ts +26 -20
  202. package/src/pin/api.ts +4 -83
  203. package/src/pin/base.ts +0 -24
  204. package/src/pin/common.ts +15 -38
  205. package/src/pin/configuration.ts +26 -20
  206. package/src/threeds/api.ts +2 -22
  207. package/src/threeds/base.ts +0 -24
  208. package/src/threeds/common.ts +15 -38
  209. package/src/threeds/configuration.ts +26 -20
  210. package/src/threeds-oob/api.ts +3 -95
  211. package/src/threeds-oob/base.ts +0 -24
  212. package/src/threeds-oob/common.ts +15 -38
  213. package/src/threeds-oob/configuration.ts +26 -20
  214. package/src/transaction-event/api.ts +12 -464
  215. package/src/transaction-event/base.ts +0 -24
  216. package/src/transaction-event/common.ts +15 -38
  217. package/src/transaction-event/configuration.ts +26 -20
  218. package/src/wallet/api.ts +30 -377
  219. package/src/wallet/base.ts +0 -24
  220. package/src/wallet/common.ts +15 -38
  221. package/src/wallet/configuration.ts +26 -20
@@ -11,50 +11,34 @@
11
11
  */
12
12
  /**
13
13
  * Information about the card used for the payment.
14
- * @export
15
- * @interface Card
16
14
  */
17
15
  export interface Card {
18
16
  /**
19
17
  * Enfuce generated unique ID assigned to each card used — enables you to identify the card that you must authorise.
20
- * @type {string}
21
- * @memberof Card
22
18
  */
23
19
  'id'?: string;
24
20
  /**
25
21
  * Card expiration date as received in the scheme message.
26
- * @type {Expiration}
27
- * @memberof Card
28
22
  */
29
23
  'expirationDate'?: Expiration;
30
24
  /**
31
25
  * Card sequence number as received in the scheme message.
32
- * @type {number}
33
- * @memberof Card
34
26
  */
35
27
  'sequenceNumber'?: number;
36
28
  /**
37
29
  * Ledger provided account ID associated with the card.
38
- * @type {string}
39
- * @memberof Card
40
30
  */
41
31
  'accountId'?: string;
42
32
  /**
43
33
  * Unique ID of the cardholder associated with the card.
44
- * @type {string}
45
- * @memberof Card
46
34
  */
47
35
  'cardholderId'?: string;
48
36
  /**
49
37
  * Information about any parent card group associated with the card.
50
- * @type {Array<CardGroupsInner>}
51
- * @memberof Card
52
38
  */
53
39
  'groups'?: Array<CardGroupsInner>;
54
40
  /**
55
41
  * The type of card application used for the transaction.
56
- * @type {string}
57
- * @memberof Card
58
42
  */
59
43
  'applicationSelection'?: CardApplicationSelectionEnum;
60
44
  }
@@ -65,8 +49,6 @@ export declare const CardApplicationSelectionEnum: {
65
49
  export type CardApplicationSelectionEnum = typeof CardApplicationSelectionEnum[keyof typeof CardApplicationSelectionEnum];
66
50
  /**
67
51
  * Describes how the card credentials were captured.
68
- * @export
69
- * @enum {string}
70
52
  */
71
53
  export declare const CardEntryMode: {
72
54
  readonly Chip: "CHIP";
@@ -80,23 +62,14 @@ export declare const CardEntryMode: {
80
62
  readonly Unknown: "UNKNOWN";
81
63
  };
82
64
  export type CardEntryMode = typeof CardEntryMode[keyof typeof CardEntryMode];
83
- /**
84
- *
85
- * @export
86
- * @interface CardGroupsInner
87
- */
88
65
  export interface CardGroupsInner {
89
66
  /**
90
67
  * Unique ID assigned to the parent card group.
91
- * @type {string}
92
- * @memberof CardGroupsInner
93
68
  */
94
69
  'groupId': string;
95
70
  }
96
71
  /**
97
72
  * The method used for verifying the cardholder: - PIN_VERIFIED_BY_CARD: The card\'s PIN is verified. - PIN_VERIFIED_BY_ISSUER: The card\'s PIN is verified by issuer. - WALLET: The cardholder is verified by the digital wallet. - THREE_DS: The cardholder is 3DS authenticated. - BIOMETRIC: The cardholder is verified by biometrics data. - SIGNATURE: The cardholder\'s signature verified. - NO_VERIFICATION: No verification is performed.
98
- * @export
99
- * @enum {string}
100
73
  */
101
74
  export declare const CardholderVerificationMethod: {
102
75
  readonly PinVerifiedByCard: "PIN_VERIFIED_BY_CARD";
@@ -108,41 +81,20 @@ export declare const CardholderVerificationMethod: {
108
81
  readonly NoVerification: "NO_VERIFICATION";
109
82
  };
110
83
  export type CardholderVerificationMethod = typeof CardholderVerificationMethod[keyof typeof CardholderVerificationMethod];
111
- /**
112
- *
113
- * @export
114
- * @interface ClearingMetadata
115
- */
116
84
  export interface ClearingMetadata {
117
85
  /**
118
86
  * Unique system generated ID assigned to each event in the payment processing workflow. For example, an ID assigned to the initial authorisation event.
119
- * @type {string}
120
- * @memberof ClearingMetadata
121
87
  */
122
88
  'id'?: string;
123
89
  /**
124
90
  * Enfuce generated unique ID assigned to each card transaction. Transaction events for the same card payment includes the same `transactionId`. For example, authorisation, incremental authorisation, and adjustment for the same transaction includes the same `transactionID`.
125
- * @type {string}
126
- * @memberof ClearingMetadata
127
91
  */
128
92
  'transactionId'?: string;
129
93
  /**
130
94
  * Describes outcome of processed transaction
131
- * @type {string}
132
- * @memberof ClearingMetadata
133
95
  */
134
96
  'postingStatus'?: ClearingMetadataPostingStatusEnum;
135
- /**
136
- *
137
- * @type {MessageCategoryClearing}
138
- * @memberof ClearingMetadata
139
- */
140
97
  'messageCategory'?: MessageCategoryClearing;
141
- /**
142
- *
143
- * @type {MessageFunctionClearing}
144
- * @memberof ClearingMetadata
145
- */
146
98
  'messageFunction'?: MessageFunctionClearing;
147
99
  }
148
100
  export declare const ClearingMetadataPostingStatusEnum: {
@@ -154,8 +106,6 @@ export declare const ClearingMetadataPostingStatusEnum: {
154
106
  export type ClearingMetadataPostingStatusEnum = typeof ClearingMetadataPostingStatusEnum[keyof typeof ClearingMetadataPostingStatusEnum];
155
107
  /**
156
108
  * The status of the transaction. CLEARED means that the transaction has been fully cleared, PARTIALLY_CLEARED means that the transaction is partially cleared.
157
- * @export
158
- * @enum {string}
159
109
  */
160
110
  export declare const ClearingStatus: {
161
111
  readonly Cleared: "CLEARED";
@@ -164,89 +114,52 @@ export declare const ClearingStatus: {
164
114
  export type ClearingStatus = typeof ClearingStatus[keyof typeof ClearingStatus];
165
115
  /**
166
116
  * Field that contains exchange rates for the transaction, it is null if both currencies are the same.
167
- * @export
168
- * @interface ExchangeRates
169
117
  */
170
118
  export interface ExchangeRates {
171
119
  /**
172
120
  * European Central Bank exchange rate.
173
- * @type {number}
174
- * @memberof ExchangeRates
175
121
  */
176
122
  'ecbRate'?: number;
177
123
  }
178
- /**
179
- *
180
- * @export
181
- * @interface Expiration
182
- */
183
124
  export interface Expiration {
184
125
  /**
185
126
  * Expiration year in YYYY format.
186
- * @type {number}
187
- * @memberof Expiration
188
127
  */
189
128
  'year': number;
190
129
  /**
191
130
  * Expiration month in MM format.
192
- * @type {number}
193
- * @memberof Expiration
194
131
  */
195
132
  'month': number;
196
133
  }
197
- /**
198
- *
199
- * @export
200
- * @interface FileData
201
- */
202
134
  export interface FileData {
203
- /**
204
- *
205
- * @type {FileDataFileHeader}
206
- * @memberof FileData
207
- */
208
135
  'fileHeader'?: FileDataFileHeader;
209
136
  /**
210
137
  * This array comprises a collection of records in the file.<br><br> Generally, the `transaction` object will be included. However, there are situations where the `masterCardMessage` object is present instead.<br><br> The `masterCardMessage` object is an unparsed ISO8583 message that has not been converted into a `transaction` object.<br><br> The `visaMessage` object represents a message in the Visa Base II format that has not been converted into a `transaction`, containing the mappings between the transaction component records (TCRs) and their data.
211
- * @type {Array<FileDataRecordsInner>}
212
- * @memberof FileData
213
138
  */
214
139
  'records'?: Array<FileDataRecordsInner>;
215
140
  }
216
141
  /**
217
142
  * Header information of the file.
218
- * @export
219
- * @interface FileDataFileHeader
220
143
  */
221
144
  export interface FileDataFileHeader {
222
145
  /**
223
146
  * This is the unique identifier for the file.
224
- * @type {string}
225
- * @memberof FileDataFileHeader
226
147
  */
227
148
  'fileId'?: string;
228
149
  /**
229
150
  * Name of the file as received from the scheme.
230
- * @type {string}
231
- * @memberof FileDataFileHeader
232
151
  */
233
152
  'fileName'?: string;
234
153
  /**
235
154
  * Date and time that Enfuce received the clearing file into the card system.
236
- * @type {string}
237
- * @memberof FileDataFileHeader
238
155
  */
239
156
  'fileReceivedDateTime'?: string;
240
157
  /**
241
158
  * The payment scheme of the file.
242
- * @type {string}
243
- * @memberof FileDataFileHeader
244
159
  */
245
160
  'paymentScheme'?: FileDataFileHeaderPaymentSchemeEnum;
246
161
  /**
247
162
  * Number of \'transactions\' objects in the file.
248
- * @type {number}
249
- * @memberof FileDataFileHeader
250
163
  */
251
164
  'numberOfTransactions'?: number;
252
165
  }
@@ -255,70 +168,27 @@ export declare const FileDataFileHeaderPaymentSchemeEnum: {
255
168
  readonly Visa: "VISA";
256
169
  };
257
170
  export type FileDataFileHeaderPaymentSchemeEnum = typeof FileDataFileHeaderPaymentSchemeEnum[keyof typeof FileDataFileHeaderPaymentSchemeEnum];
258
- /**
259
- *
260
- * @export
261
- * @interface FileDataRecordsInner
262
- */
263
171
  export interface FileDataRecordsInner {
264
172
  /**
265
173
  * Unique system generated ID assigned to each event in the payment processing workflow. For example, an ID assigned to the initial authorisation event.
266
- * @type {string}
267
- * @memberof FileDataRecordsInner
268
174
  */
269
175
  'id'?: string;
270
176
  /**
271
177
  * Enfuce generated unique ID assigned to each card transaction. Transaction events for the same card payment includes the same `transactionId`. For example, authorisation, incremental authorisation, and adjustment for the same transaction includes the same `transactionID`.
272
- * @type {string}
273
- * @memberof FileDataRecordsInner
274
178
  */
275
179
  'transactionId'?: string;
276
180
  /**
277
181
  * Describes outcome of processed transaction
278
- * @type {string}
279
- * @memberof FileDataRecordsInner
280
182
  */
281
183
  'postingStatus'?: FileDataRecordsInnerPostingStatusEnum;
282
- /**
283
- *
284
- * @type {MessageCategoryClearing}
285
- * @memberof FileDataRecordsInner
286
- */
287
184
  'messageCategory'?: MessageCategoryClearing;
288
- /**
289
- *
290
- * @type {MessageFunctionClearing}
291
- * @memberof FileDataRecordsInner
292
- */
293
185
  'messageFunction'?: MessageFunctionClearing;
294
- /**
295
- *
296
- * @type {Card}
297
- * @memberof FileDataRecordsInner
298
- */
299
186
  'card'?: Card;
300
- /**
301
- *
302
- * @type {Merchant}
303
- * @memberof FileDataRecordsInner
304
- */
305
187
  'merchant'?: Merchant;
306
- /**
307
- *
308
- * @type {Transaction1}
309
- * @memberof FileDataRecordsInner
310
- */
311
188
  'transaction'?: Transaction1;
312
- /**
313
- *
314
- * @type {FileDataRecordsInnerAllOfMasterCardMessage}
315
- * @memberof FileDataRecordsInner
316
- */
317
189
  'masterCardMessage'?: FileDataRecordsInnerAllOfMasterCardMessage;
318
190
  /**
319
191
  * The raw Visa message.
320
- * @type {{ [key: string]: string; }}
321
- * @memberof FileDataRecordsInner
322
192
  */
323
193
  'visaMessage'?: {
324
194
  [key: string]: string;
@@ -331,300 +201,193 @@ export declare const FileDataRecordsInnerPostingStatusEnum: {
331
201
  readonly Metadata: "METADATA";
332
202
  };
333
203
  export type FileDataRecordsInnerPostingStatusEnum = typeof FileDataRecordsInnerPostingStatusEnum[keyof typeof FileDataRecordsInnerPostingStatusEnum];
334
- /**
335
- *
336
- * @export
337
- * @interface FileDataRecordsInnerAllOfMasterCardMessage
338
- */
339
204
  export interface FileDataRecordsInnerAllOfMasterCardMessage {
340
205
  /**
341
206
  * Message Type Identifier (MTI) n-4
342
- * @type {string}
343
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
344
207
  */
345
208
  'MTI'?: string;
346
209
  /**
347
210
  * Processing code n-6
348
- * @type {string}
349
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
350
211
  */
351
212
  'DE03'?: string;
352
213
  /**
353
214
  * Amount, Transaction n-12
354
- * @type {string}
355
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
356
215
  */
357
216
  'DE04'?: string;
358
217
  /**
359
218
  * Amount, Reconciliation n-12
360
- * @type {string}
361
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
362
219
  */
363
220
  'DE05'?: string;
364
221
  /**
365
222
  * Amount, Cardholder Billing n-12
366
- * @type {string}
367
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
368
223
  */
369
224
  'DE06'?: string;
370
225
  /**
371
226
  * Conversion Rate, Reconciliation n-8
372
- * @type {string}
373
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
374
227
  */
375
228
  'DE09'?: string;
376
229
  /**
377
230
  * Conversion Rate, Cardholder Billing n-8
378
- * @type {string}
379
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
380
231
  */
381
232
  'DE10'?: string;
382
233
  /**
383
234
  * Date and Time, Local Transaction n-12; YYMMDDhhmmss
384
- * @type {string}
385
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
386
235
  */
387
236
  'DE12'?: string;
388
237
  /**
389
238
  * Date, Expiration n-4; YYMM
390
- * @type {string}
391
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
392
239
  */
393
240
  'DE14'?: string;
394
241
  /**
395
242
  * Point of Service (POS) Entry Mode an-12
396
- * @type {string}
397
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
398
243
  */
399
244
  'DE22'?: string;
400
245
  /**
401
246
  * Card Sequence Number n-3
402
- * @type {string}
403
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
404
247
  */
405
248
  'DE23'?: string;
406
249
  /**
407
250
  * Function Code n-3
408
- * @type {string}
409
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
410
251
  */
411
252
  'DE24'?: string;
412
253
  /**
413
254
  * Point of Service Condition Code n-4
414
- * @type {string}
415
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
416
255
  */
417
256
  'DE25'?: string;
418
257
  /**
419
258
  * Point of Service PIN capture Code n-4
420
- * @type {string}
421
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
422
259
  */
423
260
  'DE26'?: string;
424
261
  /**
425
262
  * Amounts, Original n-24
426
- * @type {string}
427
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
428
263
  */
429
264
  'DE30'?: string;
430
265
  /**
431
266
  * Acquirer Reference Data n-23; LLVAR
432
- * @type {string}
433
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
434
267
  */
435
268
  'DE31'?: string;
436
269
  /**
437
270
  * Acquiring institution Identification Code n...11; LLVAR
438
- * @type {string}
439
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
440
271
  */
441
272
  'DE32'?: string;
442
273
  /**
443
274
  * Forwarding institution Identification Code n...11; LLVAR
444
- * @type {string}
445
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
446
275
  */
447
276
  'DE33'?: string;
448
277
  /**
449
278
  * Retrieval Reference Number ans-12
450
- * @type {string}
451
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
452
279
  */
453
280
  'DE37'?: string;
454
281
  /**
455
282
  * Approval Code ans-6
456
- * @type {string}
457
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
458
283
  */
459
284
  'DE38'?: string;
460
285
  /**
461
286
  * Service Code n-3
462
- * @type {string}
463
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
464
287
  */
465
288
  'DE40'?: string;
466
289
  /**
467
290
  * Card Acceptor Terminal ID ans-8
468
- * @type {string}
469
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
470
291
  */
471
292
  'DE41'?: string;
472
293
  /**
473
294
  * Card Acceptor ID Code ans-15
474
- * @type {string}
475
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
476
295
  */
477
296
  'DE42'?: string;
478
297
  /**
479
298
  * Card Acceptor Name/Location ans...99; LLVAR
480
- * @type {string}
481
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
482
299
  */
483
300
  'DE43'?: string;
484
301
  /**
485
302
  * Additional Data an...999; LLLVAR
486
- * @type {string}
487
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
488
303
  */
489
304
  'DE48'?: string;
490
305
  /**
491
306
  * Currency Code, Transaction n-3
492
- * @type {string}
493
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
494
307
  */
495
308
  'DE49'?: string;
496
309
  /**
497
310
  * Currency Code, Reconciliation n-3
498
- * @type {string}
499
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
500
311
  */
501
312
  'DE50'?: string;
502
313
  /**
503
314
  * Currency Code, Cardholder Billing n-3
504
- * @type {string}
505
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
506
315
  */
507
316
  'DE51'?: string;
508
317
  /**
509
318
  * Amounts, Additional ans-20; LLLVAR
510
- * @type {string}
511
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
512
319
  */
513
320
  'DE54'?: string;
514
321
  /**
515
322
  * Additional Data 2 ans...999; LLLVAR
516
- * @type {string}
517
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
518
323
  */
519
324
  'DE62'?: string;
520
325
  /**
521
326
  * Transaction Life Cycle ID ans-16; LLLVAR
522
- * @type {string}
523
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
524
327
  */
525
328
  'DE63'?: string;
526
329
  /**
527
330
  * Message Number n-8
528
- * @type {string}
529
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
530
331
  */
531
332
  'DE71'?: string;
532
333
  /**
533
334
  * Data Record ans...999; LLLVAR
534
- * @type {string}
535
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
536
335
  */
537
336
  'DE72'?: string;
538
337
  /**
539
338
  * Date, Action n-6; YYMMDD
540
- * @type {string}
541
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
542
339
  */
543
340
  'DE73'?: string;
544
341
  /**
545
342
  * Transaction Destination Institution ID Code n...11; LLVAR
546
- * @type {string}
547
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
548
343
  */
549
344
  'DE93'?: string;
550
345
  /**
551
346
  * Transaction Originator Institution ID Code n...11; LLVAR
552
- * @type {string}
553
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
554
347
  */
555
348
  'DE94'?: string;
556
349
  /**
557
350
  * Card Issuer Reference Data n-10; LLVAR
558
- * @type {string}
559
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
560
351
  */
561
352
  'DE95'?: string;
562
353
  /**
563
354
  * Receiving Institution ID Code n...11; LLVAR
564
- * @type {string}
565
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
566
355
  */
567
356
  'DE100'?: string;
568
357
  /**
569
358
  * Multi-Use Transaction Identification Data ans...999; LLVAR
570
- * @type {string}
571
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
572
359
  */
573
360
  'DE105'?: string;
574
361
  /**
575
362
  * Amount, Currency Conversion Assessment
576
- * @type {string}
577
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
578
363
  */
579
364
  'DE111'?: string;
580
365
  /**
581
366
  * Additional Data 3 ans...999; LLLVAR
582
- * @type {string}
583
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
584
367
  */
585
368
  'DE123'?: string;
586
369
  /**
587
370
  * Additional Data 4 ans...999; LLLVAR
588
- * @type {string}
589
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
590
371
  */
591
372
  'DE124'?: string;
592
373
  /**
593
374
  * Additional Data 5 ans...999; LLLVAR
594
- * @type {string}
595
- * @memberof FileDataRecordsInnerAllOfMasterCardMessage
596
375
  */
597
376
  'DE125'?: string;
598
377
  }
599
378
  /**
600
379
  * Interchange calculated by the scheme for the transaction.
601
- * @export
602
- * @interface InterchangeFee
603
380
  */
604
381
  export interface InterchangeFee {
605
- /**
606
- *
607
- * @type {number}
608
- * @memberof InterchangeFee
609
- */
610
382
  'amount': number;
611
383
  /**
612
384
  * A valid ISO 4217 currency code
613
- * @type {string}
614
- * @memberof InterchangeFee
615
385
  */
616
386
  'currency': string;
617
- /**
618
- *
619
- * @type {InterchangeFeeDirection}
620
- * @memberof InterchangeFee
621
- */
622
387
  'direction': InterchangeFeeDirection;
623
388
  }
624
389
  /**
625
390
  * Specifies if the interchange fee amount is a credit or a debit for the cardholder.
626
- * @export
627
- * @enum {string}
628
391
  */
629
392
  export declare const InterchangeFeeDirection: {
630
393
  readonly Credit: "CREDIT";
@@ -632,120 +395,73 @@ export declare const InterchangeFeeDirection: {
632
395
  readonly Unknown: "UNKNOWN";
633
396
  };
634
397
  export type InterchangeFeeDirection = typeof InterchangeFeeDirection[keyof typeof InterchangeFeeDirection];
635
- /**
636
- *
637
- * @export
638
- * @interface Merchant
639
- */
640
398
  export interface Merchant {
641
399
  /**
642
400
  * ID assigned code each card acceptor, i.e. a merchant or a bank.
643
- * @type {string}
644
- * @memberof Merchant
645
401
  */
646
402
  'id'?: string;
647
403
  /**
648
404
  * Merchant name as received from the card scheme. For ATMs, this can be a street address or a bank branch number.
649
- * @type {string}
650
- * @memberof Merchant
651
405
  */
652
406
  'name'?: string;
653
407
  /**
654
408
  * The city where the transaction/withdrawal has occurred or where the merchant is registered.
655
- * @type {string}
656
- * @memberof Merchant
657
409
  */
658
410
  'city'?: string;
659
411
  /**
660
412
  * The country where the transaction/withdrawal has occurred or where the merchant is registered.
661
- * @type {string}
662
- * @memberof Merchant
663
413
  */
664
414
  'country'?: string;
665
415
  /**
666
416
  * The merchant\'s postal code.
667
- * @type {string}
668
- * @memberof Merchant
669
417
  */
670
418
  'zipCode'?: string;
671
419
  /**
672
420
  * Contains the merchant\'s street address.
673
- * @type {string}
674
- * @memberof Merchant
675
421
  */
676
422
  'address'?: string;
677
- /**
678
- *
679
- * @type {MerchantCategory}
680
- * @memberof Merchant
681
- */
682
423
  'category'?: MerchantCategory;
683
424
  /**
684
425
  * Uniquely ID assigned to each terminal used by the merchant.
685
- * @type {string}
686
- * @memberof Merchant
687
426
  */
688
427
  'terminalId'?: string;
689
428
  /**
690
429
  * The sub-merchant ID is used when merchant ID is not adequate to identify the merchant. Used when a merchant uses a payment facilitator.
691
- * @type {string}
692
- * @memberof Merchant
693
430
  */
694
431
  'subMerchantId'?: string;
695
432
  /**
696
433
  * Indicates whether the merchant is capable of accepting partial approval of an amount: - TRUE: Specifies `TRUE` if the merchant accepts partial approval. - FALSE: Specifies `FALSE` if the merchant does not accept partial approval.
697
- * @type {boolean}
698
- * @memberof Merchant
699
434
  */
700
435
  'partialApprovalCapable'?: boolean;
701
436
  /**
702
437
  * Unique ID assigned to the financial institution acting as the merchant\'s acquirer.
703
- * @type {string}
704
- * @memberof Merchant
705
438
  */
706
439
  'acquirerId'?: string;
707
440
  /**
708
441
  * The country of the merchant\'s acquirer — mention the ISO-3166-1 alpha-3 country code.
709
- * @type {string}
710
- * @memberof Merchant
711
442
  */
712
443
  'acquirerCountry'?: string;
713
444
  /**
714
445
  * Data an acquirer supplies in an acquirer-originated message, might be required for the issuer to return to the acquirer in a subsequent message.
715
- * @type {string}
716
- * @memberof Merchant
717
446
  */
718
447
  'acquirerReferenceData'?: string;
719
448
  }
720
- /**
721
- *
722
- * @export
723
- * @interface MerchantCategory
724
- */
725
449
  export interface MerchantCategory {
726
450
  /**
727
451
  * Merchant category code as per the card scheme classification. Categorisation is done based on the type of business or service the merchant provides.
728
- * @type {string}
729
- * @memberof MerchantCategory
730
452
  */
731
453
  'code'?: string;
732
454
  /**
733
455
  * Description of the Merchant Category Code (MCC).
734
- * @type {string}
735
- * @memberof MerchantCategory
736
456
  */
737
457
  'description'?: string;
738
458
  /**
739
459
  * Merchant Category Code (MCC) group as received from the scheme.
740
- * @type {string}
741
- * @memberof MerchantCategory
742
460
  */
743
461
  'group'?: string;
744
462
  }
745
463
  /**
746
464
  * Metadata relevant to the clearing file copy. <Note>As per the current implementation, we are using the `FINANCIAL` message category only.</Note>
747
- * @export
748
- * @enum {string}
749
465
  */
750
466
  export declare const MessageCategoryClearing: {
751
467
  readonly Financial: "FINANCIAL";
@@ -761,8 +477,6 @@ export declare const MessageCategoryClearing: {
761
477
  export type MessageCategoryClearing = typeof MessageCategoryClearing[keyof typeof MessageCategoryClearing];
762
478
  /**
763
479
  * Identifies the message function of the clearing message.
764
- * @export
765
- * @enum {string}
766
480
  */
767
481
  export declare const MessageFunctionClearing: {
768
482
  readonly Notification: "NOTIFICATION";
@@ -770,444 +484,235 @@ export declare const MessageFunctionClearing: {
770
484
  export type MessageFunctionClearing = typeof MessageFunctionClearing[keyof typeof MessageFunctionClearing];
771
485
  /**
772
486
  * Amount including currency.
773
- * @export
774
- * @interface Money
775
487
  */
776
488
  export interface Money {
777
- /**
778
- *
779
- * @type {number}
780
- * @memberof Money
781
- */
782
489
  'amount': number;
783
490
  /**
784
491
  * A valid ISO 4217 currency code
785
- * @type {string}
786
- * @memberof Money
787
492
  */
788
493
  'currency': string;
789
494
  }
790
- /**
791
- *
792
- * @export
793
- * @interface ProcessedTransaction
794
- */
795
495
  export interface ProcessedTransaction {
796
496
  /**
797
497
  * Enfuce generated code/number (6-digits)— returned to the merchant when authorisation is approved. In case of scheme advices, this is generated and transmitted by the scheme.
798
- * @type {string}
799
- * @memberof ProcessedTransaction
800
498
  */
801
499
  'authCode'?: string;
802
500
  /**
803
501
  * Number of days the authorisation is valid (applicable when merchants requests for extended authorisation period, longer than the default 7 days).
804
- * @type {number}
805
- * @memberof ProcessedTransaction
806
502
  */
807
503
  'authValidity'?: number;
808
504
  /**
809
505
  * Transaction amount in the currency of the ledger account (associated with the card). If any issuer transaction fee is applied (see the issuerTransactionFees field), the billingAmount also includes those fees.
810
- * @type {Money}
811
- * @memberof ProcessedTransaction
812
506
  */
813
507
  'billingAmount'?: Money;
814
508
  /**
815
509
  * The transaction amount in the local currency of the acquirer or the merchant, where the transaction occurred.
816
- * @type {Money}
817
- * @memberof ProcessedTransaction
818
510
  */
819
511
  'transactionAmount'?: Money;
820
512
  /**
821
513
  * The amount of funds transferred between the acquirer and the issuer, equal to the `transactionAmount`, in the settlement currency.
822
- * @type {Money}
823
- * @memberof ProcessedTransaction
824
514
  */
825
515
  'settlementAmount'?: Money;
826
516
  /**
827
517
  * Fee charged (for example, by the acquirer) for transaction activity.
828
- * @type {Money}
829
- * @memberof ProcessedTransaction
830
518
  */
831
519
  'acquirerTransactionFeeAmount'?: Money;
832
- /**
833
- *
834
- * @type {Array<TransactionFee>}
835
- * @memberof ProcessedTransaction
836
- */
837
520
  'issuerTransactionFees'?: Array<TransactionFee>;
838
- /**
839
- *
840
- * @type {Array<CardholderVerificationMethod>}
841
- * @memberof ProcessedTransaction
842
- */
843
521
  'cardholderVerificationMethods'?: Array<CardholderVerificationMethod>;
844
522
  /**
845
523
  * Merchant/acquirer generated transaction reference number.
846
- * @type {string}
847
- * @memberof ProcessedTransaction
848
524
  */
849
525
  'retrievalReferenceNumber'?: string;
850
- /**
851
- *
852
- * @type {CardEntryMode}
853
- * @memberof ProcessedTransaction
854
- */
855
526
  'cardEntryMode'?: CardEntryMode;
856
527
  /**
857
528
  * Indicates whether the cardholder is physically present during transaction.
858
- * @type {boolean}
859
- * @memberof ProcessedTransaction
860
529
  */
861
530
  'cardholderPresent'?: boolean;
862
531
  /**
863
532
  * Indicates whether the card is present at the point of service.
864
- * @type {boolean}
865
- * @memberof ProcessedTransaction
866
533
  */
867
534
  'cardPresent'?: boolean;
868
535
  /**
869
536
  * Indicates whether the transaction is a recurring payment or merchant initiated. This implies whether the cardholder has approved the merchant initiated transaction.
870
- * @type {boolean}
871
- * @memberof ProcessedTransaction
872
537
  */
873
538
  'merchantInitiated'?: boolean;
874
539
  /**
875
540
  * Date and time in the time zone where the transaction occurred.
876
- * @type {string}
877
- * @memberof ProcessedTransaction
878
541
  */
879
542
  'transactionDateTime'?: string;
880
543
  /**
881
544
  * This value is present only for recurring transaction, and it\'s value is first original authorisation request in the chain.
882
- * @type {string}
883
- * @memberof ProcessedTransaction
884
545
  */
885
546
  'originalTransactionId'?: string;
886
- /**
887
- *
888
- * @type {TransactionTypeClearing}
889
- * @memberof ProcessedTransaction
890
- */
891
547
  'transactionType'?: TransactionTypeClearing;
892
548
  /**
893
549
  * Contains previous amounts in a Financial message that has been corrected, in transaction currency.
894
- * @type {Money}
895
- * @memberof ProcessedTransaction
896
550
  */
897
551
  'originalAmount'?: Money;
898
552
  /**
899
553
  * Identifies the clearing systems processing date expressed in the local time zone of the clearing system.
900
- * @type {string}
901
- * @memberof ProcessedTransaction
902
554
  */
903
555
  'reconciliationDate'?: string;
904
556
  /**
905
557
  * Identifies a reconciliation period in a reconciliation date.
906
- * @type {string}
907
- * @memberof ProcessedTransaction
908
558
  */
909
559
  'reconciliationCycle'?: string;
910
560
  /**
911
561
  * Time when processed by Enfuce.
912
- * @type {string}
913
- * @memberof ProcessedTransaction
914
562
  */
915
563
  'processedDateTime'?: string;
916
- /**
917
- *
918
- * @type {InterchangeFee}
919
- * @memberof ProcessedTransaction
920
- */
921
564
  'interchangeFee'?: InterchangeFee;
922
- /**
923
- *
924
- * @type {ExchangeRates}
925
- * @memberof ProcessedTransaction
926
- */
927
565
  'exchangeRates'?: ExchangeRates;
928
566
  }
929
- /**
930
- *
931
- * @export
932
- * @interface Transaction
933
- */
934
567
  export interface Transaction {
935
568
  /**
936
569
  * Enfuce generated code/number (6-digits)— returned to the merchant when authorisation is approved. In case of scheme advices, this is generated and transmitted by the scheme.
937
- * @type {string}
938
- * @memberof Transaction
939
570
  */
940
571
  'authCode'?: string;
941
572
  /**
942
573
  * Number of days the authorisation is valid (applicable when merchants requests for extended authorisation period, longer than the default 7 days).
943
- * @type {number}
944
- * @memberof Transaction
945
574
  */
946
575
  'authValidity'?: number;
947
576
  /**
948
577
  * Transaction amount in the currency of the ledger account (associated with the card). If any issuer transaction fee is applied (see the issuerTransactionFees field), the billingAmount also includes those fees.
949
- * @type {Money}
950
- * @memberof Transaction
951
578
  */
952
579
  'billingAmount'?: Money;
953
580
  /**
954
581
  * The transaction amount in the local currency of the acquirer or the merchant, where the transaction occurred.
955
- * @type {Money}
956
- * @memberof Transaction
957
582
  */
958
583
  'transactionAmount'?: Money;
959
584
  /**
960
585
  * The amount of funds transferred between the acquirer and the issuer, equal to the `transactionAmount`, in the settlement currency.
961
- * @type {Money}
962
- * @memberof Transaction
963
586
  */
964
587
  'settlementAmount'?: Money;
965
588
  /**
966
589
  * Fee charged (for example, by the acquirer) for transaction activity.
967
- * @type {Money}
968
- * @memberof Transaction
969
590
  */
970
591
  'acquirerTransactionFeeAmount'?: Money;
971
- /**
972
- *
973
- * @type {Array<TransactionFee>}
974
- * @memberof Transaction
975
- */
976
592
  'issuerTransactionFees'?: Array<TransactionFee>;
977
- /**
978
- *
979
- * @type {Array<CardholderVerificationMethod>}
980
- * @memberof Transaction
981
- */
982
593
  'cardholderVerificationMethods'?: Array<CardholderVerificationMethod>;
983
594
  /**
984
595
  * Merchant/acquirer generated transaction reference number.
985
- * @type {string}
986
- * @memberof Transaction
987
596
  */
988
597
  'retrievalReferenceNumber'?: string;
989
- /**
990
- *
991
- * @type {CardEntryMode}
992
- * @memberof Transaction
993
- */
994
598
  'cardEntryMode'?: CardEntryMode;
995
599
  /**
996
600
  * Indicates whether the cardholder is physically present during transaction.
997
- * @type {boolean}
998
- * @memberof Transaction
999
601
  */
1000
602
  'cardholderPresent'?: boolean;
1001
603
  /**
1002
604
  * Indicates whether the card is present at the point of service.
1003
- * @type {boolean}
1004
- * @memberof Transaction
1005
605
  */
1006
606
  'cardPresent'?: boolean;
1007
607
  /**
1008
608
  * Indicates whether the transaction is a recurring payment or merchant initiated. This implies whether the cardholder has approved the merchant initiated transaction.
1009
- * @type {boolean}
1010
- * @memberof Transaction
1011
609
  */
1012
610
  'merchantInitiated'?: boolean;
1013
611
  /**
1014
612
  * Date and time in the time zone where the transaction occurred.
1015
- * @type {string}
1016
- * @memberof Transaction
1017
613
  */
1018
614
  'transactionDateTime'?: string;
1019
615
  /**
1020
616
  * This value is present only for recurring transaction, and it\'s value is first original authorisation request in the chain.
1021
- * @type {string}
1022
- * @memberof Transaction
1023
617
  */
1024
618
  'originalTransactionId'?: string;
1025
619
  }
1026
- /**
1027
- *
1028
- * @export
1029
- * @interface Transaction1
1030
- */
1031
620
  export interface Transaction1 {
1032
621
  /**
1033
622
  * Enfuce generated code/number (6-digits)— returned to the merchant when authorisation is approved. In case of scheme advices, this is generated and transmitted by the scheme.
1034
- * @type {string}
1035
- * @memberof Transaction1
1036
623
  */
1037
624
  'authCode'?: string;
1038
625
  /**
1039
626
  * Number of days the authorisation is valid (applicable when merchants requests for extended authorisation period, longer than the default 7 days).
1040
- * @type {number}
1041
- * @memberof Transaction1
1042
627
  */
1043
628
  'authValidity'?: number;
1044
629
  /**
1045
630
  * Transaction amount in the currency of the ledger account (associated with the card). If any issuer transaction fee is applied (see the issuerTransactionFees field), the billingAmount also includes those fees.
1046
- * @type {Money}
1047
- * @memberof Transaction1
1048
631
  */
1049
632
  'billingAmount'?: Money;
1050
633
  /**
1051
634
  * The transaction amount in the local currency of the acquirer or the merchant, where the transaction occurred.
1052
- * @type {Money}
1053
- * @memberof Transaction1
1054
635
  */
1055
636
  'transactionAmount'?: Money;
1056
637
  /**
1057
638
  * The amount of funds transferred between the acquirer and the issuer, equal to the `transactionAmount`, in the settlement currency.
1058
- * @type {Money}
1059
- * @memberof Transaction1
1060
639
  */
1061
640
  'settlementAmount'?: Money;
1062
641
  /**
1063
642
  * Fee charged (for example, by the acquirer) for transaction activity.
1064
- * @type {Money}
1065
- * @memberof Transaction1
1066
643
  */
1067
644
  'acquirerTransactionFeeAmount'?: Money;
1068
- /**
1069
- *
1070
- * @type {Array<TransactionFee>}
1071
- * @memberof Transaction1
1072
- */
1073
645
  'issuerTransactionFees'?: Array<TransactionFee>;
1074
- /**
1075
- *
1076
- * @type {Array<CardholderVerificationMethod>}
1077
- * @memberof Transaction1
1078
- */
1079
646
  'cardholderVerificationMethods'?: Array<CardholderVerificationMethod>;
1080
647
  /**
1081
648
  * Merchant/acquirer generated transaction reference number.
1082
- * @type {string}
1083
- * @memberof Transaction1
1084
649
  */
1085
650
  'retrievalReferenceNumber'?: string;
1086
- /**
1087
- *
1088
- * @type {CardEntryMode}
1089
- * @memberof Transaction1
1090
- */
1091
651
  'cardEntryMode'?: CardEntryMode;
1092
652
  /**
1093
653
  * Indicates whether the cardholder is physically present during transaction.
1094
- * @type {boolean}
1095
- * @memberof Transaction1
1096
654
  */
1097
655
  'cardholderPresent'?: boolean;
1098
656
  /**
1099
657
  * Indicates whether the card is present at the point of service.
1100
- * @type {boolean}
1101
- * @memberof Transaction1
1102
658
  */
1103
659
  'cardPresent'?: boolean;
1104
660
  /**
1105
661
  * Indicates whether the transaction is a recurring payment or merchant initiated. This implies whether the cardholder has approved the merchant initiated transaction.
1106
- * @type {boolean}
1107
- * @memberof Transaction1
1108
662
  */
1109
663
  'merchantInitiated'?: boolean;
1110
664
  /**
1111
665
  * Date and time in the time zone where the transaction occurred.
1112
- * @type {string}
1113
- * @memberof Transaction1
1114
666
  */
1115
667
  'transactionDateTime'?: string;
1116
668
  /**
1117
669
  * This value is present only for recurring transaction, and it\'s value is first original authorisation request in the chain.
1118
- * @type {string}
1119
- * @memberof Transaction1
1120
670
  */
1121
671
  'originalTransactionId'?: string;
1122
- /**
1123
- *
1124
- * @type {TransactionTypeClearing}
1125
- * @memberof Transaction1
1126
- */
1127
672
  'transactionType'?: TransactionTypeClearing;
1128
673
  /**
1129
674
  * Contains previous amounts in a Financial message that has been corrected, in transaction currency.
1130
- * @type {Money}
1131
- * @memberof Transaction1
1132
675
  */
1133
676
  'originalAmount'?: Money;
1134
677
  /**
1135
678
  * Identifies the clearing systems processing date expressed in the local time zone of the clearing system.
1136
- * @type {string}
1137
- * @memberof Transaction1
1138
679
  */
1139
680
  'reconciliationDate'?: string;
1140
681
  /**
1141
682
  * Identifies a reconciliation period in a reconciliation date.
1142
- * @type {string}
1143
- * @memberof Transaction1
1144
683
  */
1145
684
  'reconciliationCycle'?: string;
1146
685
  /**
1147
686
  * Time when processed by Enfuce.
1148
- * @type {string}
1149
- * @memberof Transaction1
1150
687
  */
1151
688
  'processedDateTime'?: string;
1152
- /**
1153
- *
1154
- * @type {InterchangeFee}
1155
- * @memberof Transaction1
1156
- */
1157
689
  'interchangeFee'?: InterchangeFee;
1158
- /**
1159
- *
1160
- * @type {ExchangeRates}
1161
- * @memberof Transaction1
1162
- */
1163
690
  'exchangeRates'?: ExchangeRates;
1164
691
  /**
1165
692
  * The amount (in ch billing currency) that the authorisation should be adjusted to in case a merchant makes an adjustment.
1166
- * @type {Money}
1167
- * @memberof Transaction1
1168
693
  */
1169
694
  'replacementAmount'?: Money;
1170
695
  /**
1171
696
  * The cashback amount received at clearing time.
1172
- * @type {Money}
1173
- * @memberof Transaction1
1174
697
  */
1175
698
  'cashbackAmount'?: Money;
1176
- /**
1177
- *
1178
- * @type {ClearingStatus}
1179
- * @memberof Transaction1
1180
- */
1181
699
  'clearingStatus'?: ClearingStatus;
1182
700
  /**
1183
701
  * Indicates if transaction was cleared in a single operation.
1184
- * @type {boolean}
1185
- * @memberof Transaction1
1186
702
  */
1187
703
  'partialClearingApplied'?: boolean;
1188
704
  /**
1189
705
  * Time of the authorization request.
1190
- * @type {string}
1191
- * @memberof Transaction1
1192
706
  */
1193
707
  'authorizationProcessedDateTime'?: string;
1194
708
  }
1195
- /**
1196
- *
1197
- * @export
1198
- * @interface TransactionFee
1199
- */
1200
709
  export interface TransactionFee {
1201
710
  /**
1202
711
  * Type of Issuer generated transaction fee in cardholder billing currency. Transaction based fees that are additional fees charged on top of the transaction.
1203
- * @type {string}
1204
- * @memberof TransactionFee
1205
712
  */
1206
713
  'type'?: TransactionFeeTypeEnum;
1207
714
  /**
1208
715
  * Transaction fee amount in cardholder billing currency.
1209
- * @type {Money}
1210
- * @memberof TransactionFee
1211
716
  */
1212
717
  'amount'?: Money;
1213
718
  }
@@ -1219,8 +724,6 @@ export declare const TransactionFeeTypeEnum: {
1219
724
  export type TransactionFeeTypeEnum = typeof TransactionFeeTypeEnum[keyof typeof TransactionFeeTypeEnum];
1220
725
  /**
1221
726
  * The transaction Type
1222
- * @export
1223
- * @enum {string}
1224
727
  */
1225
728
  export declare const TransactionTypeClearing: {
1226
729
  readonly Retail: "RETAIL";