@enfuce/nextgen-sdk 0.0.2 → 0.0.4

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