@enfuce/nextgen-sdk 0.0.1 → 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.
- package/README.md +44 -0
- package/dist/authorisation-control/api.d.ts +0 -302
- package/dist/authorisation-control/api.js +10 -28
- package/dist/authorisation-control/base.d.ts +0 -24
- package/dist/authorisation-control/base.js +0 -19
- package/dist/authorisation-control/common.d.ts +4 -35
- package/dist/authorisation-control/common.js +16 -38
- package/dist/authorisation-control/configuration.d.ts +24 -17
- package/dist/authorisation-control/configuration.js +3 -3
- package/dist/card/api.d.ts +41 -740
- package/dist/card/api.js +38 -105
- package/dist/card/base.d.ts +0 -24
- package/dist/card/base.js +0 -19
- package/dist/card/common.d.ts +4 -35
- package/dist/card/common.js +16 -38
- package/dist/card/configuration.d.ts +24 -17
- package/dist/card/configuration.js +3 -3
- package/dist/cardholder/api.d.ts +959 -686
- package/dist/cardholder/api.js +783 -73
- package/dist/cardholder/base.d.ts +0 -24
- package/dist/cardholder/base.js +0 -19
- package/dist/cardholder/common.d.ts +4 -35
- package/dist/cardholder/common.js +16 -38
- package/dist/cardholder/configuration.d.ts +24 -17
- package/dist/cardholder/configuration.js +3 -3
- package/dist/cards/api.d.ts +0 -7
- package/dist/cards/api.js +2 -9
- package/dist/cards/base.d.ts +0 -24
- package/dist/cards/base.js +0 -19
- package/dist/cards/common.d.ts +4 -35
- package/dist/cards/common.js +16 -38
- package/dist/cards/configuration.d.ts +24 -17
- package/dist/cards/configuration.js +3 -3
- package/dist/clearing-file-copy/api.d.ts +0 -497
- package/dist/clearing-file-copy/api.js +12 -26
- package/dist/clearing-file-copy/base.d.ts +0 -24
- package/dist/clearing-file-copy/base.js +0 -19
- package/dist/clearing-file-copy/common.d.ts +4 -35
- package/dist/clearing-file-copy/common.js +16 -38
- package/dist/clearing-file-copy/configuration.d.ts +24 -17
- package/dist/clearing-file-copy/configuration.js +3 -3
- package/dist/esm/authorisation-control/api.d.ts +0 -302
- package/dist/esm/authorisation-control/api.js +10 -28
- package/dist/esm/authorisation-control/base.d.ts +0 -24
- package/dist/esm/authorisation-control/base.js +0 -19
- package/dist/esm/authorisation-control/common.d.ts +4 -35
- package/dist/esm/authorisation-control/common.js +14 -37
- package/dist/esm/authorisation-control/configuration.d.ts +24 -17
- package/dist/esm/authorisation-control/configuration.js +3 -3
- package/dist/esm/card/api.d.ts +41 -740
- package/dist/esm/card/api.js +38 -105
- package/dist/esm/card/base.d.ts +0 -24
- package/dist/esm/card/base.js +0 -19
- package/dist/esm/card/common.d.ts +4 -35
- package/dist/esm/card/common.js +14 -37
- package/dist/esm/card/configuration.d.ts +24 -17
- package/dist/esm/card/configuration.js +3 -3
- package/dist/esm/cardholder/api.d.ts +959 -686
- package/dist/esm/cardholder/api.js +782 -72
- package/dist/esm/cardholder/base.d.ts +0 -24
- package/dist/esm/cardholder/base.js +0 -19
- package/dist/esm/cardholder/common.d.ts +4 -35
- package/dist/esm/cardholder/common.js +14 -37
- package/dist/esm/cardholder/configuration.d.ts +24 -17
- package/dist/esm/cardholder/configuration.js +3 -3
- package/dist/esm/cards/api.d.ts +0 -7
- package/dist/esm/cards/api.js +2 -9
- package/dist/esm/cards/base.d.ts +0 -24
- package/dist/esm/cards/base.js +0 -19
- package/dist/esm/cards/common.d.ts +4 -35
- package/dist/esm/cards/common.js +14 -37
- package/dist/esm/cards/configuration.d.ts +24 -17
- package/dist/esm/cards/configuration.js +3 -3
- package/dist/esm/clearing-file-copy/api.d.ts +0 -497
- package/dist/esm/clearing-file-copy/api.js +12 -26
- package/dist/esm/clearing-file-copy/base.d.ts +0 -24
- package/dist/esm/clearing-file-copy/base.js +0 -19
- package/dist/esm/clearing-file-copy/common.d.ts +4 -35
- package/dist/esm/clearing-file-copy/common.js +14 -37
- package/dist/esm/clearing-file-copy/configuration.d.ts +24 -17
- package/dist/esm/clearing-file-copy/configuration.js +3 -3
- package/dist/esm/issuer-events/api.d.ts +639 -601
- package/dist/esm/issuer-events/api.js +520 -54
- package/dist/esm/issuer-events/base.d.ts +0 -24
- package/dist/esm/issuer-events/base.js +0 -19
- package/dist/esm/issuer-events/common.d.ts +4 -35
- package/dist/esm/issuer-events/common.js +14 -37
- package/dist/esm/issuer-events/configuration.d.ts +24 -17
- package/dist/esm/issuer-events/configuration.js +3 -3
- package/dist/esm/pin/api.d.ts +0 -76
- package/dist/esm/pin/api.js +3 -15
- package/dist/esm/pin/base.d.ts +0 -24
- package/dist/esm/pin/base.js +0 -19
- package/dist/esm/pin/common.d.ts +4 -35
- package/dist/esm/pin/common.js +14 -37
- package/dist/esm/pin/configuration.d.ts +24 -17
- package/dist/esm/pin/configuration.js +3 -3
- package/dist/esm/threeds/api.d.ts +0 -18
- package/dist/esm/threeds/api.js +1 -8
- package/dist/esm/threeds/base.d.ts +0 -24
- package/dist/esm/threeds/base.js +0 -19
- package/dist/esm/threeds/common.d.ts +4 -35
- package/dist/esm/threeds/common.js +14 -37
- package/dist/esm/threeds/configuration.d.ts +24 -17
- package/dist/esm/threeds/configuration.js +3 -3
- package/dist/esm/threeds-oob/api.d.ts +0 -90
- package/dist/esm/threeds-oob/api.js +2 -9
- package/dist/esm/threeds-oob/base.d.ts +0 -24
- package/dist/esm/threeds-oob/base.js +0 -19
- package/dist/esm/threeds-oob/common.d.ts +4 -35
- package/dist/esm/threeds-oob/common.js +14 -37
- package/dist/esm/threeds-oob/configuration.d.ts +24 -17
- package/dist/esm/threeds-oob/configuration.js +3 -3
- package/dist/esm/transaction-event/api.d.ts +2 -453
- package/dist/esm/transaction-event/api.js +13 -28
- package/dist/esm/transaction-event/base.d.ts +0 -24
- package/dist/esm/transaction-event/base.js +0 -19
- package/dist/esm/transaction-event/common.d.ts +4 -35
- package/dist/esm/transaction-event/common.js +14 -37
- package/dist/esm/transaction-event/configuration.d.ts +24 -17
- package/dist/esm/transaction-event/configuration.js +3 -3
- package/dist/esm/wallet/api.d.ts +0 -342
- package/dist/esm/wallet/api.js +29 -83
- package/dist/esm/wallet/base.d.ts +0 -24
- package/dist/esm/wallet/base.js +0 -19
- package/dist/esm/wallet/common.d.ts +4 -35
- package/dist/esm/wallet/common.js +14 -37
- package/dist/esm/wallet/configuration.d.ts +24 -17
- package/dist/esm/wallet/configuration.js +3 -3
- package/dist/issuer-events/api.d.ts +639 -601
- package/dist/issuer-events/api.js +521 -55
- package/dist/issuer-events/base.d.ts +0 -24
- package/dist/issuer-events/base.js +0 -19
- package/dist/issuer-events/common.d.ts +4 -35
- package/dist/issuer-events/common.js +16 -38
- package/dist/issuer-events/configuration.d.ts +24 -17
- package/dist/issuer-events/configuration.js +3 -3
- package/dist/pin/api.d.ts +0 -76
- package/dist/pin/api.js +3 -15
- package/dist/pin/base.d.ts +0 -24
- package/dist/pin/base.js +0 -19
- package/dist/pin/common.d.ts +4 -35
- package/dist/pin/common.js +16 -38
- package/dist/pin/configuration.d.ts +24 -17
- package/dist/pin/configuration.js +3 -3
- package/dist/threeds/api.d.ts +0 -18
- package/dist/threeds/api.js +1 -8
- package/dist/threeds/base.d.ts +0 -24
- package/dist/threeds/base.js +0 -19
- package/dist/threeds/common.d.ts +4 -35
- package/dist/threeds/common.js +16 -38
- package/dist/threeds/configuration.d.ts +24 -17
- package/dist/threeds/configuration.js +3 -3
- package/dist/threeds-oob/api.d.ts +0 -90
- package/dist/threeds-oob/api.js +2 -9
- package/dist/threeds-oob/base.d.ts +0 -24
- package/dist/threeds-oob/base.js +0 -19
- package/dist/threeds-oob/common.d.ts +4 -35
- package/dist/threeds-oob/common.js +16 -38
- package/dist/threeds-oob/configuration.d.ts +24 -17
- package/dist/threeds-oob/configuration.js +3 -3
- package/dist/transaction-event/api.d.ts +2 -453
- package/dist/transaction-event/api.js +13 -28
- package/dist/transaction-event/base.d.ts +0 -24
- package/dist/transaction-event/base.js +0 -19
- package/dist/transaction-event/common.d.ts +4 -35
- package/dist/transaction-event/common.js +16 -38
- package/dist/transaction-event/configuration.d.ts +24 -17
- package/dist/transaction-event/configuration.js +3 -3
- package/dist/wallet/api.d.ts +0 -342
- package/dist/wallet/api.js +29 -83
- package/dist/wallet/base.d.ts +0 -24
- package/dist/wallet/base.js +0 -19
- package/dist/wallet/common.d.ts +4 -35
- package/dist/wallet/common.js +16 -38
- package/dist/wallet/configuration.d.ts +24 -17
- package/dist/wallet/configuration.js +3 -3
- package/package.json +5 -2
- package/src/authorisation-control/api.ts +11 -314
- package/src/authorisation-control/base.ts +0 -24
- package/src/authorisation-control/common.ts +15 -38
- package/src/authorisation-control/configuration.ts +26 -20
- package/src/card/api.ts +80 -786
- package/src/card/base.ts +0 -24
- package/src/card/common.ts +15 -38
- package/src/card/configuration.ts +26 -20
- package/src/cardholder/api.ts +987 -714
- package/src/cardholder/base.ts +0 -24
- package/src/cardholder/common.ts +15 -38
- package/src/cardholder/configuration.ts +26 -20
- package/src/cards/api.ts +3 -11
- package/src/cards/base.ts +0 -24
- package/src/cards/common.ts +15 -38
- package/src/cards/configuration.ts +26 -20
- package/src/clearing-file-copy/api.ts +13 -510
- package/src/clearing-file-copy/base.ts +0 -24
- package/src/clearing-file-copy/common.ts +15 -38
- package/src/clearing-file-copy/configuration.ts +26 -20
- package/src/issuer-events/api.ts +661 -628
- package/src/issuer-events/base.ts +0 -24
- package/src/issuer-events/common.ts +15 -38
- package/src/issuer-events/configuration.ts +26 -20
- package/src/pin/api.ts +4 -83
- package/src/pin/base.ts +0 -24
- package/src/pin/common.ts +15 -38
- package/src/pin/configuration.ts +26 -20
- package/src/threeds/api.ts +2 -22
- package/src/threeds/base.ts +0 -24
- package/src/threeds/common.ts +15 -38
- package/src/threeds/configuration.ts +26 -20
- package/src/threeds-oob/api.ts +3 -95
- package/src/threeds-oob/base.ts +0 -24
- package/src/threeds-oob/common.ts +15 -38
- package/src/threeds-oob/configuration.ts +26 -20
- package/src/transaction-event/api.ts +14 -465
- package/src/transaction-event/base.ts +0 -24
- package/src/transaction-event/common.ts +15 -38
- package/src/transaction-event/configuration.ts +26 -20
- package/src/wallet/api.ts +30 -377
- package/src/wallet/base.ts +0 -24
- package/src/wallet/common.ts +15 -38
- package/src/wallet/configuration.ts +26 -20
|
@@ -9,167 +9,98 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
/**
|
|
13
|
-
*
|
|
14
|
-
* @export
|
|
15
|
-
* @interface ApprovedTransaction
|
|
16
|
-
*/
|
|
17
12
|
export interface ApprovedTransaction {
|
|
18
13
|
/**
|
|
19
14
|
* 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.
|
|
20
|
-
* @type {string}
|
|
21
|
-
* @memberof ApprovedTransaction
|
|
22
15
|
*/
|
|
23
16
|
'authCode'?: string;
|
|
24
17
|
/**
|
|
25
18
|
* Number of days the authorisation is valid (applicable when merchants requests for extended authorisation period, longer than the default 7 days).
|
|
26
|
-
* @type {number}
|
|
27
|
-
* @memberof ApprovedTransaction
|
|
28
19
|
*/
|
|
29
20
|
'authValidity'?: number;
|
|
30
21
|
/**
|
|
31
22
|
* 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.
|
|
32
|
-
* @type {Money}
|
|
33
|
-
* @memberof ApprovedTransaction
|
|
34
23
|
*/
|
|
35
24
|
'billingAmount'?: Money;
|
|
36
25
|
/**
|
|
37
26
|
* The transaction amount in the local currency of the acquirer or the merchant, where the transaction occurred.
|
|
38
|
-
* @type {Money}
|
|
39
|
-
* @memberof ApprovedTransaction
|
|
40
27
|
*/
|
|
41
28
|
'transactionAmount'?: Money;
|
|
42
29
|
/**
|
|
43
30
|
* The amount of funds transferred between the acquirer and the issuer, equal to the `transactionAmount`, in the settlement currency.
|
|
44
|
-
* @type {Money}
|
|
45
|
-
* @memberof ApprovedTransaction
|
|
46
31
|
*/
|
|
47
32
|
'settlementAmount'?: Money;
|
|
48
33
|
/**
|
|
49
34
|
* Fee charged (for example, by the acquirer) for transaction activity.
|
|
50
|
-
* @type {Money}
|
|
51
|
-
* @memberof ApprovedTransaction
|
|
52
35
|
*/
|
|
53
36
|
'acquirerTransactionFeeAmount'?: Money;
|
|
54
|
-
/**
|
|
55
|
-
*
|
|
56
|
-
* @type {Array<TransactionFee>}
|
|
57
|
-
* @memberof ApprovedTransaction
|
|
58
|
-
*/
|
|
59
37
|
'issuerTransactionFees'?: Array<TransactionFee>;
|
|
60
|
-
/**
|
|
61
|
-
*
|
|
62
|
-
* @type {Array<CardholderVerificationMethod>}
|
|
63
|
-
* @memberof ApprovedTransaction
|
|
64
|
-
*/
|
|
65
38
|
'cardholderVerificationMethods'?: Array<CardholderVerificationMethod>;
|
|
66
39
|
/**
|
|
67
40
|
* Merchant/acquirer generated transaction reference number.
|
|
68
|
-
* @type {string}
|
|
69
|
-
* @memberof ApprovedTransaction
|
|
70
41
|
*/
|
|
71
42
|
'retrievalReferenceNumber'?: string;
|
|
72
|
-
/**
|
|
73
|
-
*
|
|
74
|
-
* @type {CardEntryMode}
|
|
75
|
-
* @memberof ApprovedTransaction
|
|
76
|
-
*/
|
|
77
43
|
'cardEntryMode'?: CardEntryMode;
|
|
78
44
|
/**
|
|
79
45
|
* Indicates whether the cardholder is physically present during transaction.
|
|
80
|
-
* @type {boolean}
|
|
81
|
-
* @memberof ApprovedTransaction
|
|
82
46
|
*/
|
|
83
47
|
'cardholderPresent'?: boolean;
|
|
84
48
|
/**
|
|
85
49
|
* Indicates whether the card is present at the point of service.
|
|
86
|
-
* @type {boolean}
|
|
87
|
-
* @memberof ApprovedTransaction
|
|
88
50
|
*/
|
|
89
51
|
'cardPresent'?: boolean;
|
|
90
52
|
/**
|
|
91
53
|
* Indicates whether the transaction is a recurring payment or merchant initiated. This implies whether the cardholder has approved the merchant initiated transaction.
|
|
92
|
-
* @type {boolean}
|
|
93
|
-
* @memberof ApprovedTransaction
|
|
94
54
|
*/
|
|
95
55
|
'merchantInitiated'?: boolean;
|
|
96
56
|
/**
|
|
97
57
|
* Date and time in the time zone where the transaction occurred.
|
|
98
|
-
* @type {string}
|
|
99
|
-
* @memberof ApprovedTransaction
|
|
100
58
|
*/
|
|
101
59
|
'transactionDateTime'?: string;
|
|
102
60
|
/**
|
|
103
61
|
* This value is present only for recurring transaction, and it\'s value is first original authorisation request in the chain.
|
|
104
|
-
* @type {string}
|
|
105
|
-
* @memberof ApprovedTransaction
|
|
106
62
|
*/
|
|
107
63
|
'originalTransactionId'?: string;
|
|
108
|
-
/**
|
|
109
|
-
*
|
|
110
|
-
* @type {TransactionType}
|
|
111
|
-
* @memberof ApprovedTransaction
|
|
112
|
-
*/
|
|
113
64
|
'transactionType'?: TransactionType;
|
|
114
65
|
/**
|
|
115
66
|
* Amount approved at the current payment processing stage; the amount might be further reduced in the subsequent stages, when the Ledger performs additional validations. If any issuer transaction fee is applied (see the issuerTransactionFees field), the approvedAmount also includes those fees.
|
|
116
|
-
* @type {Money}
|
|
117
|
-
* @memberof ApprovedTransaction
|
|
118
67
|
*/
|
|
119
68
|
'approvedAmount'?: Money;
|
|
120
69
|
/**
|
|
121
70
|
* Time when processed by Enfuce.
|
|
122
|
-
* @type {string}
|
|
123
|
-
* @memberof ApprovedTransaction
|
|
124
71
|
*/
|
|
125
72
|
'processedDateTime'?: string;
|
|
126
73
|
}
|
|
127
74
|
/**
|
|
128
75
|
* Information about the card used for the payment.
|
|
129
|
-
* @export
|
|
130
|
-
* @interface Card
|
|
131
76
|
*/
|
|
132
77
|
export interface Card {
|
|
133
78
|
/**
|
|
134
79
|
* Enfuce generated unique ID assigned to each card used — enables you to identify the card that you must authorise.
|
|
135
|
-
* @type {string}
|
|
136
|
-
* @memberof Card
|
|
137
80
|
*/
|
|
138
81
|
'id'?: string;
|
|
139
82
|
/**
|
|
140
83
|
* Card expiration date as received in the scheme message.
|
|
141
|
-
* @type {Expiration}
|
|
142
|
-
* @memberof Card
|
|
143
84
|
*/
|
|
144
85
|
'expirationDate'?: Expiration;
|
|
145
86
|
/**
|
|
146
87
|
* Card sequence number as received in the scheme message.
|
|
147
|
-
* @type {number}
|
|
148
|
-
* @memberof Card
|
|
149
88
|
*/
|
|
150
89
|
'sequenceNumber'?: number;
|
|
151
90
|
/**
|
|
152
91
|
* Ledger provided account ID associated with the card.
|
|
153
|
-
* @type {string}
|
|
154
|
-
* @memberof Card
|
|
155
92
|
*/
|
|
156
93
|
'accountId'?: string;
|
|
157
94
|
/**
|
|
158
95
|
* Unique ID of the cardholder associated with the card.
|
|
159
|
-
* @type {string}
|
|
160
|
-
* @memberof Card
|
|
161
96
|
*/
|
|
162
97
|
'cardholderId'?: string;
|
|
163
98
|
/**
|
|
164
99
|
* Information about any parent card group associated with the card.
|
|
165
|
-
* @type {Array<CardGroupsInner>}
|
|
166
|
-
* @memberof Card
|
|
167
100
|
*/
|
|
168
101
|
'groups'?: Array<CardGroupsInner>;
|
|
169
102
|
/**
|
|
170
103
|
* The type of card application used for the transaction.
|
|
171
|
-
* @type {string}
|
|
172
|
-
* @memberof Card
|
|
173
104
|
*/
|
|
174
105
|
'applicationSelection'?: CardApplicationSelectionEnum;
|
|
175
106
|
}
|
|
@@ -180,8 +111,6 @@ export declare const CardApplicationSelectionEnum: {
|
|
|
180
111
|
export type CardApplicationSelectionEnum = typeof CardApplicationSelectionEnum[keyof typeof CardApplicationSelectionEnum];
|
|
181
112
|
/**
|
|
182
113
|
* Describes how the card credentials were captured.
|
|
183
|
-
* @export
|
|
184
|
-
* @enum {string}
|
|
185
114
|
*/
|
|
186
115
|
export declare const CardEntryMode: {
|
|
187
116
|
readonly Chip: "CHIP";
|
|
@@ -195,23 +124,14 @@ export declare const CardEntryMode: {
|
|
|
195
124
|
readonly Unknown: "UNKNOWN";
|
|
196
125
|
};
|
|
197
126
|
export type CardEntryMode = typeof CardEntryMode[keyof typeof CardEntryMode];
|
|
198
|
-
/**
|
|
199
|
-
*
|
|
200
|
-
* @export
|
|
201
|
-
* @interface CardGroupsInner
|
|
202
|
-
*/
|
|
203
127
|
export interface CardGroupsInner {
|
|
204
128
|
/**
|
|
205
129
|
* Unique ID assigned to the parent card group.
|
|
206
|
-
* @type {string}
|
|
207
|
-
* @memberof CardGroupsInner
|
|
208
130
|
*/
|
|
209
131
|
'groupId': string;
|
|
210
132
|
}
|
|
211
133
|
/**
|
|
212
134
|
* 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.
|
|
213
|
-
* @export
|
|
214
|
-
* @enum {string}
|
|
215
135
|
*/
|
|
216
136
|
export declare const CardholderVerificationMethod: {
|
|
217
137
|
readonly PinVerifiedByCard: "PIN_VERIFIED_BY_CARD";
|
|
@@ -225,8 +145,6 @@ export declare const CardholderVerificationMethod: {
|
|
|
225
145
|
export type CardholderVerificationMethod = typeof CardholderVerificationMethod[keyof typeof CardholderVerificationMethod];
|
|
226
146
|
/**
|
|
227
147
|
* The status of the transaction. CLEARED means that the transaction has been fully cleared, PARTIALLY_CLEARED means that the transaction is partially cleared.
|
|
228
|
-
* @export
|
|
229
|
-
* @enum {string}
|
|
230
148
|
*/
|
|
231
149
|
export declare const ClearingStatus: {
|
|
232
150
|
readonly Cleared: "CLEARED";
|
|
@@ -235,65 +153,36 @@ export declare const ClearingStatus: {
|
|
|
235
153
|
export type ClearingStatus = typeof ClearingStatus[keyof typeof ClearingStatus];
|
|
236
154
|
/**
|
|
237
155
|
* Field that contains exchange rates for the transaction, it is null if both currencies are the same.
|
|
238
|
-
* @export
|
|
239
|
-
* @interface ExchangeRates
|
|
240
156
|
*/
|
|
241
157
|
export interface ExchangeRates {
|
|
242
158
|
/**
|
|
243
159
|
* European Central Bank exchange rate.
|
|
244
|
-
* @type {number}
|
|
245
|
-
* @memberof ExchangeRates
|
|
246
160
|
*/
|
|
247
161
|
'ecbRate'?: number;
|
|
248
162
|
}
|
|
249
|
-
/**
|
|
250
|
-
*
|
|
251
|
-
* @export
|
|
252
|
-
* @interface Expiration
|
|
253
|
-
*/
|
|
254
163
|
export interface Expiration {
|
|
255
164
|
/**
|
|
256
165
|
* Expiration year in YYYY format.
|
|
257
|
-
* @type {number}
|
|
258
|
-
* @memberof Expiration
|
|
259
166
|
*/
|
|
260
167
|
'year': number;
|
|
261
168
|
/**
|
|
262
169
|
* Expiration month in MM format.
|
|
263
|
-
* @type {number}
|
|
264
|
-
* @memberof Expiration
|
|
265
170
|
*/
|
|
266
171
|
'month': number;
|
|
267
172
|
}
|
|
268
173
|
/**
|
|
269
174
|
* Interchange calculated by the scheme for the transaction.
|
|
270
|
-
* @export
|
|
271
|
-
* @interface InterchangeFee
|
|
272
175
|
*/
|
|
273
176
|
export interface InterchangeFee {
|
|
274
|
-
/**
|
|
275
|
-
*
|
|
276
|
-
* @type {number}
|
|
277
|
-
* @memberof InterchangeFee
|
|
278
|
-
*/
|
|
279
177
|
'amount': number;
|
|
280
178
|
/**
|
|
281
179
|
* A valid ISO 4217 currency code
|
|
282
|
-
* @type {string}
|
|
283
|
-
* @memberof InterchangeFee
|
|
284
180
|
*/
|
|
285
181
|
'currency': string;
|
|
286
|
-
/**
|
|
287
|
-
*
|
|
288
|
-
* @type {InterchangeFeeDirection}
|
|
289
|
-
* @memberof InterchangeFee
|
|
290
|
-
*/
|
|
291
182
|
'direction': InterchangeFeeDirection;
|
|
292
183
|
}
|
|
293
184
|
/**
|
|
294
185
|
* Specifies if the interchange fee amount is a credit or a debit for the cardholder.
|
|
295
|
-
* @export
|
|
296
|
-
* @enum {string}
|
|
297
186
|
*/
|
|
298
187
|
export declare const InterchangeFeeDirection: {
|
|
299
188
|
readonly Credit: "CREDIT";
|
|
@@ -301,120 +190,73 @@ export declare const InterchangeFeeDirection: {
|
|
|
301
190
|
readonly Unknown: "UNKNOWN";
|
|
302
191
|
};
|
|
303
192
|
export type InterchangeFeeDirection = typeof InterchangeFeeDirection[keyof typeof InterchangeFeeDirection];
|
|
304
|
-
/**
|
|
305
|
-
*
|
|
306
|
-
* @export
|
|
307
|
-
* @interface Merchant
|
|
308
|
-
*/
|
|
309
193
|
export interface Merchant {
|
|
310
194
|
/**
|
|
311
195
|
* ID assigned code each card acceptor, i.e. a merchant or a bank.
|
|
312
|
-
* @type {string}
|
|
313
|
-
* @memberof Merchant
|
|
314
196
|
*/
|
|
315
197
|
'id'?: string;
|
|
316
198
|
/**
|
|
317
199
|
* Merchant name as received from the card scheme. For ATMs, this can be a street address or a bank branch number.
|
|
318
|
-
* @type {string}
|
|
319
|
-
* @memberof Merchant
|
|
320
200
|
*/
|
|
321
201
|
'name'?: string;
|
|
322
202
|
/**
|
|
323
203
|
* The city where the transaction/withdrawal has occurred or where the merchant is registered.
|
|
324
|
-
* @type {string}
|
|
325
|
-
* @memberof Merchant
|
|
326
204
|
*/
|
|
327
205
|
'city'?: string;
|
|
328
206
|
/**
|
|
329
207
|
* The country where the transaction/withdrawal has occurred or where the merchant is registered.
|
|
330
|
-
* @type {string}
|
|
331
|
-
* @memberof Merchant
|
|
332
208
|
*/
|
|
333
209
|
'country'?: string;
|
|
334
210
|
/**
|
|
335
211
|
* The merchant\'s postal code.
|
|
336
|
-
* @type {string}
|
|
337
|
-
* @memberof Merchant
|
|
338
212
|
*/
|
|
339
213
|
'zipCode'?: string;
|
|
340
214
|
/**
|
|
341
215
|
* Contains the merchant\'s street address.
|
|
342
|
-
* @type {string}
|
|
343
|
-
* @memberof Merchant
|
|
344
216
|
*/
|
|
345
217
|
'address'?: string;
|
|
346
|
-
/**
|
|
347
|
-
*
|
|
348
|
-
* @type {MerchantCategory}
|
|
349
|
-
* @memberof Merchant
|
|
350
|
-
*/
|
|
351
218
|
'category'?: MerchantCategory;
|
|
352
219
|
/**
|
|
353
220
|
* Uniquely ID assigned to each terminal used by the merchant.
|
|
354
|
-
* @type {string}
|
|
355
|
-
* @memberof Merchant
|
|
356
221
|
*/
|
|
357
222
|
'terminalId'?: string;
|
|
358
223
|
/**
|
|
359
224
|
* The sub-merchant ID is used when merchant ID is not adequate to identify the merchant. Used when a merchant uses a payment facilitator.
|
|
360
|
-
* @type {string}
|
|
361
|
-
* @memberof Merchant
|
|
362
225
|
*/
|
|
363
226
|
'subMerchantId'?: string;
|
|
364
227
|
/**
|
|
365
228
|
* 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.
|
|
366
|
-
* @type {boolean}
|
|
367
|
-
* @memberof Merchant
|
|
368
229
|
*/
|
|
369
230
|
'partialApprovalCapable'?: boolean;
|
|
370
231
|
/**
|
|
371
232
|
* Unique ID assigned to the financial institution acting as the merchant\'s acquirer.
|
|
372
|
-
* @type {string}
|
|
373
|
-
* @memberof Merchant
|
|
374
233
|
*/
|
|
375
234
|
'acquirerId'?: string;
|
|
376
235
|
/**
|
|
377
236
|
* The country of the merchant\'s acquirer — mention the ISO-3166-1 alpha-3 country code.
|
|
378
|
-
* @type {string}
|
|
379
|
-
* @memberof Merchant
|
|
380
237
|
*/
|
|
381
238
|
'acquirerCountry'?: string;
|
|
382
239
|
/**
|
|
383
240
|
* Data an acquirer supplies in an acquirer-originated message, might be required for the issuer to return to the acquirer in a subsequent message.
|
|
384
|
-
* @type {string}
|
|
385
|
-
* @memberof Merchant
|
|
386
241
|
*/
|
|
387
242
|
'acquirerReferenceData'?: string;
|
|
388
243
|
}
|
|
389
|
-
/**
|
|
390
|
-
*
|
|
391
|
-
* @export
|
|
392
|
-
* @interface MerchantCategory
|
|
393
|
-
*/
|
|
394
244
|
export interface MerchantCategory {
|
|
395
245
|
/**
|
|
396
246
|
* Merchant category code as per the card scheme classification. Categorisation is done based on the type of business or service the merchant provides.
|
|
397
|
-
* @type {string}
|
|
398
|
-
* @memberof MerchantCategory
|
|
399
247
|
*/
|
|
400
248
|
'code'?: string;
|
|
401
249
|
/**
|
|
402
250
|
* Description of the Merchant Category Code (MCC).
|
|
403
|
-
* @type {string}
|
|
404
|
-
* @memberof MerchantCategory
|
|
405
251
|
*/
|
|
406
252
|
'description'?: string;
|
|
407
253
|
/**
|
|
408
254
|
* Merchant Category Code (MCC) group as received from the scheme.
|
|
409
|
-
* @type {string}
|
|
410
|
-
* @memberof MerchantCategory
|
|
411
255
|
*/
|
|
412
256
|
'group'?: string;
|
|
413
257
|
}
|
|
414
258
|
/**
|
|
415
|
-
* Message category sent in the transaction event webhook. Possible enums: - INITIAL_AUTHORIZATION: Initial authorisation of the card payment. - INCREMENTAL_AUTHORIZATION: Additional authorisation for a previously authorised transaction. - DECLINED_AUTHORIZATION: Scheme declined the transaction on behalf of Enfuce in the STIP mode. - ADJUSTMENT: Corrections to a previously authorised transaction. - REVERSAL: Reversal of a previously authorised transaction. - BALANCE_INQUIRY: Enquiring about the current balance of the funding account from the external application. - PIN_MANAGEMENT: Request to change the card PIN. - PIN_MANAGEMENT_REVERSAL: Reversal of a pin change request. - FINANCIAL: Clearing message of batch payments. - PURGE_AUTHORIZATION: Excluded authorisations are purged after a specific period. - VOID_AUTHORIZATION: When an initial authorisation or an incremental authorisation request times out, a `VOID_AUTHORIZATION` message is generated.
|
|
416
|
-
* @export
|
|
417
|
-
* @enum {string}
|
|
259
|
+
* Message category sent in the transaction event webhook. Possible enums: - INITIAL_AUTHORIZATION: Initial authorisation of the card payment. - INCREMENTAL_AUTHORIZATION: Additional authorisation for a previously authorised transaction. - DECLINED_AUTHORIZATION: Scheme declined the transaction on behalf of Enfuce in the STIP mode. - ADJUSTMENT: Corrections to a previously authorised transaction. - REVERSAL: Reversal of a previously authorised transaction. - BALANCE_INQUIRY: Enquiring about the current balance of the funding account from the external application. - PIN_MANAGEMENT: Request to change the card PIN. - PIN_MANAGEMENT_REVERSAL: Reversal of a pin change request. - FINANCIAL: Clearing message of batch payments. - PURGE_AUTHORIZATION: Excluded authorisations are purged after a specific period. - VOID_AUTHORIZATION: When an initial authorisation or an incremental authorisation request times out, a `VOID_AUTHORIZATION` message is generated. - ACCOUNT_STATUS_INQUIRY: When an account status is requested.
|
|
418
260
|
*/
|
|
419
261
|
export declare const MessageCategoryTransactionEvent: {
|
|
420
262
|
readonly InitialAuthorization: "INITIAL_AUTHORIZATION";
|
|
@@ -436,12 +278,11 @@ export declare const MessageCategoryTransactionEvent: {
|
|
|
436
278
|
readonly Representment: "REPRESENTMENT";
|
|
437
279
|
readonly RepresentmentReversal: "REPRESENTMENT_REVERSAL";
|
|
438
280
|
readonly DocumentRequest: "DOCUMENT_REQUEST";
|
|
281
|
+
readonly AccountStatusInquiry: "ACCOUNT_STATUS_INQUIRY";
|
|
439
282
|
};
|
|
440
283
|
export type MessageCategoryTransactionEvent = typeof MessageCategoryTransactionEvent[keyof typeof MessageCategoryTransactionEvent];
|
|
441
284
|
/**
|
|
442
285
|
* Identifies the message function of the transaction event.
|
|
443
|
-
* @export
|
|
444
|
-
* @enum {string}
|
|
445
286
|
*/
|
|
446
287
|
export declare const MessageFunctionTransactionEvent: {
|
|
447
288
|
readonly Request: "REQUEST";
|
|
@@ -452,178 +293,93 @@ export declare const MessageFunctionTransactionEvent: {
|
|
|
452
293
|
export type MessageFunctionTransactionEvent = typeof MessageFunctionTransactionEvent[keyof typeof MessageFunctionTransactionEvent];
|
|
453
294
|
/**
|
|
454
295
|
* Amount including currency.
|
|
455
|
-
* @export
|
|
456
|
-
* @interface Money
|
|
457
296
|
*/
|
|
458
297
|
export interface Money {
|
|
459
|
-
/**
|
|
460
|
-
*
|
|
461
|
-
* @type {number}
|
|
462
|
-
* @memberof Money
|
|
463
|
-
*/
|
|
464
298
|
'amount': number;
|
|
465
299
|
/**
|
|
466
300
|
* A valid ISO 4217 currency code
|
|
467
|
-
* @type {string}
|
|
468
|
-
* @memberof Money
|
|
469
301
|
*/
|
|
470
302
|
'currency': string;
|
|
471
303
|
}
|
|
472
|
-
/**
|
|
473
|
-
*
|
|
474
|
-
* @export
|
|
475
|
-
* @interface ProcessedTransaction
|
|
476
|
-
*/
|
|
477
304
|
export interface ProcessedTransaction {
|
|
478
305
|
/**
|
|
479
306
|
* 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.
|
|
480
|
-
* @type {string}
|
|
481
|
-
* @memberof ProcessedTransaction
|
|
482
307
|
*/
|
|
483
308
|
'authCode'?: string;
|
|
484
309
|
/**
|
|
485
310
|
* Number of days the authorisation is valid (applicable when merchants requests for extended authorisation period, longer than the default 7 days).
|
|
486
|
-
* @type {number}
|
|
487
|
-
* @memberof ProcessedTransaction
|
|
488
311
|
*/
|
|
489
312
|
'authValidity'?: number;
|
|
490
313
|
/**
|
|
491
314
|
* 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.
|
|
492
|
-
* @type {Money}
|
|
493
|
-
* @memberof ProcessedTransaction
|
|
494
315
|
*/
|
|
495
316
|
'billingAmount'?: Money;
|
|
496
317
|
/**
|
|
497
318
|
* The transaction amount in the local currency of the acquirer or the merchant, where the transaction occurred.
|
|
498
|
-
* @type {Money}
|
|
499
|
-
* @memberof ProcessedTransaction
|
|
500
319
|
*/
|
|
501
320
|
'transactionAmount'?: Money;
|
|
502
321
|
/**
|
|
503
322
|
* The amount of funds transferred between the acquirer and the issuer, equal to the `transactionAmount`, in the settlement currency.
|
|
504
|
-
* @type {Money}
|
|
505
|
-
* @memberof ProcessedTransaction
|
|
506
323
|
*/
|
|
507
324
|
'settlementAmount'?: Money;
|
|
508
325
|
/**
|
|
509
326
|
* Fee charged (for example, by the acquirer) for transaction activity.
|
|
510
|
-
* @type {Money}
|
|
511
|
-
* @memberof ProcessedTransaction
|
|
512
327
|
*/
|
|
513
328
|
'acquirerTransactionFeeAmount'?: Money;
|
|
514
|
-
/**
|
|
515
|
-
*
|
|
516
|
-
* @type {Array<TransactionFee>}
|
|
517
|
-
* @memberof ProcessedTransaction
|
|
518
|
-
*/
|
|
519
329
|
'issuerTransactionFees'?: Array<TransactionFee>;
|
|
520
|
-
/**
|
|
521
|
-
*
|
|
522
|
-
* @type {Array<CardholderVerificationMethod>}
|
|
523
|
-
* @memberof ProcessedTransaction
|
|
524
|
-
*/
|
|
525
330
|
'cardholderVerificationMethods'?: Array<CardholderVerificationMethod>;
|
|
526
331
|
/**
|
|
527
332
|
* Merchant/acquirer generated transaction reference number.
|
|
528
|
-
* @type {string}
|
|
529
|
-
* @memberof ProcessedTransaction
|
|
530
333
|
*/
|
|
531
334
|
'retrievalReferenceNumber'?: string;
|
|
532
|
-
/**
|
|
533
|
-
*
|
|
534
|
-
* @type {CardEntryMode}
|
|
535
|
-
* @memberof ProcessedTransaction
|
|
536
|
-
*/
|
|
537
335
|
'cardEntryMode'?: CardEntryMode;
|
|
538
336
|
/**
|
|
539
337
|
* Indicates whether the cardholder is physically present during transaction.
|
|
540
|
-
* @type {boolean}
|
|
541
|
-
* @memberof ProcessedTransaction
|
|
542
338
|
*/
|
|
543
339
|
'cardholderPresent'?: boolean;
|
|
544
340
|
/**
|
|
545
341
|
* Indicates whether the card is present at the point of service.
|
|
546
|
-
* @type {boolean}
|
|
547
|
-
* @memberof ProcessedTransaction
|
|
548
342
|
*/
|
|
549
343
|
'cardPresent'?: boolean;
|
|
550
344
|
/**
|
|
551
345
|
* Indicates whether the transaction is a recurring payment or merchant initiated. This implies whether the cardholder has approved the merchant initiated transaction.
|
|
552
|
-
* @type {boolean}
|
|
553
|
-
* @memberof ProcessedTransaction
|
|
554
346
|
*/
|
|
555
347
|
'merchantInitiated'?: boolean;
|
|
556
348
|
/**
|
|
557
349
|
* Date and time in the time zone where the transaction occurred.
|
|
558
|
-
* @type {string}
|
|
559
|
-
* @memberof ProcessedTransaction
|
|
560
350
|
*/
|
|
561
351
|
'transactionDateTime'?: string;
|
|
562
352
|
/**
|
|
563
353
|
* This value is present only for recurring transaction, and it\'s value is first original authorisation request in the chain.
|
|
564
|
-
* @type {string}
|
|
565
|
-
* @memberof ProcessedTransaction
|
|
566
354
|
*/
|
|
567
355
|
'originalTransactionId'?: string;
|
|
568
|
-
/**
|
|
569
|
-
*
|
|
570
|
-
* @type {TransactionTypeClearing}
|
|
571
|
-
* @memberof ProcessedTransaction
|
|
572
|
-
*/
|
|
573
356
|
'transactionType'?: TransactionTypeClearing;
|
|
574
357
|
/**
|
|
575
358
|
* Contains previous amounts in a Financial message that has been corrected, in transaction currency.
|
|
576
|
-
* @type {Money}
|
|
577
|
-
* @memberof ProcessedTransaction
|
|
578
359
|
*/
|
|
579
360
|
'originalAmount'?: Money;
|
|
580
361
|
/**
|
|
581
362
|
* Identifies the clearing systems processing date expressed in the local time zone of the clearing system.
|
|
582
|
-
* @type {string}
|
|
583
|
-
* @memberof ProcessedTransaction
|
|
584
363
|
*/
|
|
585
364
|
'reconciliationDate'?: string;
|
|
586
365
|
/**
|
|
587
366
|
* Identifies a reconciliation period in a reconciliation date.
|
|
588
|
-
* @type {string}
|
|
589
|
-
* @memberof ProcessedTransaction
|
|
590
367
|
*/
|
|
591
368
|
'reconciliationCycle'?: string;
|
|
592
369
|
/**
|
|
593
370
|
* Time when processed by Enfuce.
|
|
594
|
-
* @type {string}
|
|
595
|
-
* @memberof ProcessedTransaction
|
|
596
371
|
*/
|
|
597
372
|
'processedDateTime'?: string;
|
|
598
|
-
/**
|
|
599
|
-
*
|
|
600
|
-
* @type {InterchangeFee}
|
|
601
|
-
* @memberof ProcessedTransaction
|
|
602
|
-
*/
|
|
603
373
|
'interchangeFee'?: InterchangeFee;
|
|
604
|
-
/**
|
|
605
|
-
*
|
|
606
|
-
* @type {ExchangeRates}
|
|
607
|
-
* @memberof ProcessedTransaction
|
|
608
|
-
*/
|
|
609
374
|
'exchangeRates'?: ExchangeRates;
|
|
610
375
|
}
|
|
611
376
|
/**
|
|
612
377
|
* Information about the token associated with the card.
|
|
613
|
-
* @export
|
|
614
|
-
* @interface Token
|
|
615
378
|
*/
|
|
616
379
|
export interface Token {
|
|
617
|
-
/**
|
|
618
|
-
*
|
|
619
|
-
* @type {string}
|
|
620
|
-
* @memberof Token
|
|
621
|
-
*/
|
|
622
380
|
'id'?: string;
|
|
623
381
|
/**
|
|
624
382
|
* Identifies the specific digital wallet.
|
|
625
|
-
* @type {string}
|
|
626
|
-
* @memberof Token
|
|
627
383
|
*/
|
|
628
384
|
'walletIdentifier'?: TokenWalletIdentifierEnum;
|
|
629
385
|
}
|
|
@@ -635,392 +391,189 @@ export declare const TokenWalletIdentifierEnum: {
|
|
|
635
391
|
readonly RemoteCommercePrograms: "REMOTE_COMMERCE_PROGRAMS";
|
|
636
392
|
};
|
|
637
393
|
export type TokenWalletIdentifierEnum = typeof TokenWalletIdentifierEnum[keyof typeof TokenWalletIdentifierEnum];
|
|
638
|
-
/**
|
|
639
|
-
*
|
|
640
|
-
* @export
|
|
641
|
-
* @interface Transaction
|
|
642
|
-
*/
|
|
643
394
|
export interface Transaction {
|
|
644
395
|
/**
|
|
645
396
|
* 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.
|
|
646
|
-
* @type {string}
|
|
647
|
-
* @memberof Transaction
|
|
648
397
|
*/
|
|
649
398
|
'authCode'?: string;
|
|
650
399
|
/**
|
|
651
400
|
* Number of days the authorisation is valid (applicable when merchants requests for extended authorisation period, longer than the default 7 days).
|
|
652
|
-
* @type {number}
|
|
653
|
-
* @memberof Transaction
|
|
654
401
|
*/
|
|
655
402
|
'authValidity'?: number;
|
|
656
403
|
/**
|
|
657
404
|
* 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.
|
|
658
|
-
* @type {Money}
|
|
659
|
-
* @memberof Transaction
|
|
660
405
|
*/
|
|
661
406
|
'billingAmount'?: Money;
|
|
662
407
|
/**
|
|
663
408
|
* The transaction amount in the local currency of the acquirer or the merchant, where the transaction occurred.
|
|
664
|
-
* @type {Money}
|
|
665
|
-
* @memberof Transaction
|
|
666
409
|
*/
|
|
667
410
|
'transactionAmount'?: Money;
|
|
668
411
|
/**
|
|
669
412
|
* The amount of funds transferred between the acquirer and the issuer, equal to the `transactionAmount`, in the settlement currency.
|
|
670
|
-
* @type {Money}
|
|
671
|
-
* @memberof Transaction
|
|
672
413
|
*/
|
|
673
414
|
'settlementAmount'?: Money;
|
|
674
415
|
/**
|
|
675
416
|
* Fee charged (for example, by the acquirer) for transaction activity.
|
|
676
|
-
* @type {Money}
|
|
677
|
-
* @memberof Transaction
|
|
678
417
|
*/
|
|
679
418
|
'acquirerTransactionFeeAmount'?: Money;
|
|
680
|
-
/**
|
|
681
|
-
*
|
|
682
|
-
* @type {Array<TransactionFee>}
|
|
683
|
-
* @memberof Transaction
|
|
684
|
-
*/
|
|
685
419
|
'issuerTransactionFees'?: Array<TransactionFee>;
|
|
686
|
-
/**
|
|
687
|
-
*
|
|
688
|
-
* @type {Array<CardholderVerificationMethod>}
|
|
689
|
-
* @memberof Transaction
|
|
690
|
-
*/
|
|
691
420
|
'cardholderVerificationMethods'?: Array<CardholderVerificationMethod>;
|
|
692
421
|
/**
|
|
693
422
|
* Merchant/acquirer generated transaction reference number.
|
|
694
|
-
* @type {string}
|
|
695
|
-
* @memberof Transaction
|
|
696
423
|
*/
|
|
697
424
|
'retrievalReferenceNumber'?: string;
|
|
698
|
-
/**
|
|
699
|
-
*
|
|
700
|
-
* @type {CardEntryMode}
|
|
701
|
-
* @memberof Transaction
|
|
702
|
-
*/
|
|
703
425
|
'cardEntryMode'?: CardEntryMode;
|
|
704
426
|
/**
|
|
705
427
|
* Indicates whether the cardholder is physically present during transaction.
|
|
706
|
-
* @type {boolean}
|
|
707
|
-
* @memberof Transaction
|
|
708
428
|
*/
|
|
709
429
|
'cardholderPresent'?: boolean;
|
|
710
430
|
/**
|
|
711
431
|
* Indicates whether the card is present at the point of service.
|
|
712
|
-
* @type {boolean}
|
|
713
|
-
* @memberof Transaction
|
|
714
432
|
*/
|
|
715
433
|
'cardPresent'?: boolean;
|
|
716
434
|
/**
|
|
717
435
|
* Indicates whether the transaction is a recurring payment or merchant initiated. This implies whether the cardholder has approved the merchant initiated transaction.
|
|
718
|
-
* @type {boolean}
|
|
719
|
-
* @memberof Transaction
|
|
720
436
|
*/
|
|
721
437
|
'merchantInitiated'?: boolean;
|
|
722
438
|
/**
|
|
723
439
|
* Date and time in the time zone where the transaction occurred.
|
|
724
|
-
* @type {string}
|
|
725
|
-
* @memberof Transaction
|
|
726
440
|
*/
|
|
727
441
|
'transactionDateTime'?: string;
|
|
728
442
|
/**
|
|
729
443
|
* This value is present only for recurring transaction, and it\'s value is first original authorisation request in the chain.
|
|
730
|
-
* @type {string}
|
|
731
|
-
* @memberof Transaction
|
|
732
444
|
*/
|
|
733
445
|
'originalTransactionId'?: string;
|
|
734
446
|
}
|
|
735
|
-
/**
|
|
736
|
-
*
|
|
737
|
-
* @export
|
|
738
|
-
* @interface TransactionEvent
|
|
739
|
-
*/
|
|
740
447
|
export interface TransactionEvent {
|
|
741
448
|
/**
|
|
742
449
|
* Unique system generated ID assigned to each event in the payment processing workflow. For example, an ID assigned to the initial authorisation event.
|
|
743
|
-
* @type {string}
|
|
744
|
-
* @memberof TransactionEvent
|
|
745
450
|
*/
|
|
746
451
|
'id'?: string;
|
|
747
452
|
/**
|
|
748
453
|
* Unique ID assigned to VOID_AUTHORIZATION message category — applicable only for VOID_AUTHORIZATION.
|
|
749
|
-
* @type {string}
|
|
750
|
-
* @memberof TransactionEvent
|
|
751
454
|
*/
|
|
752
455
|
'referenceTransactionEventId'?: string;
|
|
753
456
|
/**
|
|
754
457
|
* 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`.
|
|
755
|
-
* @type {string}
|
|
756
|
-
* @memberof TransactionEvent
|
|
757
458
|
*/
|
|
758
459
|
'transactionId'?: string;
|
|
759
|
-
/**
|
|
760
|
-
*
|
|
761
|
-
* @type {MessageCategoryTransactionEvent}
|
|
762
|
-
* @memberof TransactionEvent
|
|
763
|
-
*/
|
|
764
460
|
'messageCategory'?: MessageCategoryTransactionEvent;
|
|
765
|
-
/**
|
|
766
|
-
*
|
|
767
|
-
* @type {MessageFunctionTransactionEvent}
|
|
768
|
-
* @memberof TransactionEvent
|
|
769
|
-
*/
|
|
770
461
|
'messageFunction'?: MessageFunctionTransactionEvent;
|
|
771
|
-
/**
|
|
772
|
-
*
|
|
773
|
-
* @type {ClearingStatus}
|
|
774
|
-
* @memberof TransactionEvent
|
|
775
|
-
*/
|
|
776
462
|
'clearingStatus'?: ClearingStatus;
|
|
777
|
-
/**
|
|
778
|
-
*
|
|
779
|
-
* @type {Card}
|
|
780
|
-
* @memberof TransactionEvent
|
|
781
|
-
*/
|
|
782
463
|
'card'?: Card;
|
|
783
|
-
/**
|
|
784
|
-
*
|
|
785
|
-
* @type {Merchant}
|
|
786
|
-
* @memberof TransactionEvent
|
|
787
|
-
*/
|
|
788
464
|
'merchant'?: Merchant;
|
|
789
|
-
/**
|
|
790
|
-
*
|
|
791
|
-
* @type {TransactionEventTransaction}
|
|
792
|
-
* @memberof TransactionEvent
|
|
793
|
-
*/
|
|
794
465
|
'transaction'?: TransactionEventTransaction;
|
|
795
|
-
/**
|
|
796
|
-
*
|
|
797
|
-
* @type {Token}
|
|
798
|
-
* @memberof TransactionEvent
|
|
799
|
-
*/
|
|
800
466
|
'token'?: Token;
|
|
801
467
|
}
|
|
802
|
-
/**
|
|
803
|
-
*
|
|
804
|
-
* @export
|
|
805
|
-
* @interface TransactionEventMetadata
|
|
806
|
-
*/
|
|
807
468
|
export interface TransactionEventMetadata {
|
|
808
469
|
/**
|
|
809
470
|
* Unique system generated ID assigned to each event in the payment processing workflow. For example, an ID assigned to the initial authorisation event.
|
|
810
|
-
* @type {string}
|
|
811
|
-
* @memberof TransactionEventMetadata
|
|
812
471
|
*/
|
|
813
472
|
'id'?: string;
|
|
814
473
|
/**
|
|
815
474
|
* Unique ID assigned to VOID_AUTHORIZATION message category — applicable only for VOID_AUTHORIZATION.
|
|
816
|
-
* @type {string}
|
|
817
|
-
* @memberof TransactionEventMetadata
|
|
818
475
|
*/
|
|
819
476
|
'referenceTransactionEventId'?: string;
|
|
820
477
|
/**
|
|
821
478
|
* 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`.
|
|
822
|
-
* @type {string}
|
|
823
|
-
* @memberof TransactionEventMetadata
|
|
824
479
|
*/
|
|
825
480
|
'transactionId'?: string;
|
|
826
|
-
/**
|
|
827
|
-
*
|
|
828
|
-
* @type {MessageCategoryTransactionEvent}
|
|
829
|
-
* @memberof TransactionEventMetadata
|
|
830
|
-
*/
|
|
831
481
|
'messageCategory'?: MessageCategoryTransactionEvent;
|
|
832
|
-
/**
|
|
833
|
-
*
|
|
834
|
-
* @type {MessageFunctionTransactionEvent}
|
|
835
|
-
* @memberof TransactionEventMetadata
|
|
836
|
-
*/
|
|
837
482
|
'messageFunction'?: MessageFunctionTransactionEvent;
|
|
838
|
-
/**
|
|
839
|
-
*
|
|
840
|
-
* @type {ClearingStatus}
|
|
841
|
-
* @memberof TransactionEventMetadata
|
|
842
|
-
*/
|
|
843
483
|
'clearingStatus'?: ClearingStatus;
|
|
844
484
|
}
|
|
845
|
-
/**
|
|
846
|
-
*
|
|
847
|
-
* @export
|
|
848
|
-
* @interface TransactionEventTransaction
|
|
849
|
-
*/
|
|
850
485
|
export interface TransactionEventTransaction {
|
|
851
486
|
/**
|
|
852
487
|
* 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.
|
|
853
|
-
* @type {string}
|
|
854
|
-
* @memberof TransactionEventTransaction
|
|
855
488
|
*/
|
|
856
489
|
'authCode'?: string;
|
|
857
490
|
/**
|
|
858
491
|
* Number of days the authorisation is valid (applicable when merchants requests for extended authorisation period, longer than the default 7 days).
|
|
859
|
-
* @type {number}
|
|
860
|
-
* @memberof TransactionEventTransaction
|
|
861
492
|
*/
|
|
862
493
|
'authValidity'?: number;
|
|
863
494
|
/**
|
|
864
495
|
* 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.
|
|
865
|
-
* @type {Money}
|
|
866
|
-
* @memberof TransactionEventTransaction
|
|
867
496
|
*/
|
|
868
497
|
'billingAmount'?: Money;
|
|
869
498
|
/**
|
|
870
499
|
* The transaction amount in the local currency of the acquirer or the merchant, where the transaction occurred.
|
|
871
|
-
* @type {Money}
|
|
872
|
-
* @memberof TransactionEventTransaction
|
|
873
500
|
*/
|
|
874
501
|
'transactionAmount'?: Money;
|
|
875
502
|
/**
|
|
876
503
|
* The amount of funds transferred between the acquirer and the issuer, equal to the `transactionAmount`, in the settlement currency.
|
|
877
|
-
* @type {Money}
|
|
878
|
-
* @memberof TransactionEventTransaction
|
|
879
504
|
*/
|
|
880
505
|
'settlementAmount'?: Money;
|
|
881
506
|
/**
|
|
882
507
|
* Fee charged (for example, by the acquirer) for transaction activity.
|
|
883
|
-
* @type {Money}
|
|
884
|
-
* @memberof TransactionEventTransaction
|
|
885
508
|
*/
|
|
886
509
|
'acquirerTransactionFeeAmount'?: Money;
|
|
887
|
-
/**
|
|
888
|
-
*
|
|
889
|
-
* @type {Array<TransactionFee>}
|
|
890
|
-
* @memberof TransactionEventTransaction
|
|
891
|
-
*/
|
|
892
510
|
'issuerTransactionFees'?: Array<TransactionFee>;
|
|
893
|
-
/**
|
|
894
|
-
*
|
|
895
|
-
* @type {Array<CardholderVerificationMethod>}
|
|
896
|
-
* @memberof TransactionEventTransaction
|
|
897
|
-
*/
|
|
898
511
|
'cardholderVerificationMethods'?: Array<CardholderVerificationMethod>;
|
|
899
512
|
/**
|
|
900
513
|
* Merchant/acquirer generated transaction reference number.
|
|
901
|
-
* @type {string}
|
|
902
|
-
* @memberof TransactionEventTransaction
|
|
903
514
|
*/
|
|
904
515
|
'retrievalReferenceNumber'?: string;
|
|
905
|
-
/**
|
|
906
|
-
*
|
|
907
|
-
* @type {CardEntryMode}
|
|
908
|
-
* @memberof TransactionEventTransaction
|
|
909
|
-
*/
|
|
910
516
|
'cardEntryMode'?: CardEntryMode;
|
|
911
517
|
/**
|
|
912
518
|
* Indicates whether the cardholder is physically present during transaction.
|
|
913
|
-
* @type {boolean}
|
|
914
|
-
* @memberof TransactionEventTransaction
|
|
915
519
|
*/
|
|
916
520
|
'cardholderPresent'?: boolean;
|
|
917
521
|
/**
|
|
918
522
|
* Indicates whether the card is present at the point of service.
|
|
919
|
-
* @type {boolean}
|
|
920
|
-
* @memberof TransactionEventTransaction
|
|
921
523
|
*/
|
|
922
524
|
'cardPresent'?: boolean;
|
|
923
525
|
/**
|
|
924
526
|
* Indicates whether the transaction is a recurring payment or merchant initiated. This implies whether the cardholder has approved the merchant initiated transaction.
|
|
925
|
-
* @type {boolean}
|
|
926
|
-
* @memberof TransactionEventTransaction
|
|
927
527
|
*/
|
|
928
528
|
'merchantInitiated'?: boolean;
|
|
929
529
|
/**
|
|
930
530
|
* Date and time in the time zone where the transaction occurred.
|
|
931
|
-
* @type {string}
|
|
932
|
-
* @memberof TransactionEventTransaction
|
|
933
531
|
*/
|
|
934
532
|
'transactionDateTime'?: string;
|
|
935
533
|
/**
|
|
936
534
|
* This value is present only for recurring transaction, and it\'s value is first original authorisation request in the chain.
|
|
937
|
-
* @type {string}
|
|
938
|
-
* @memberof TransactionEventTransaction
|
|
939
535
|
*/
|
|
940
536
|
'originalTransactionId'?: string;
|
|
941
|
-
/**
|
|
942
|
-
*
|
|
943
|
-
* @type {TransactionTypeClearing}
|
|
944
|
-
* @memberof TransactionEventTransaction
|
|
945
|
-
*/
|
|
946
537
|
'transactionType'?: TransactionTypeClearing;
|
|
947
538
|
/**
|
|
948
539
|
* Amount approved at the current payment processing stage; the amount might be further reduced in the subsequent stages, when the Ledger performs additional validations. If any issuer transaction fee is applied (see the issuerTransactionFees field), the approvedAmount also includes those fees.
|
|
949
|
-
* @type {Money}
|
|
950
|
-
* @memberof TransactionEventTransaction
|
|
951
540
|
*/
|
|
952
541
|
'approvedAmount'?: Money;
|
|
953
542
|
/**
|
|
954
543
|
* Time when processed by Enfuce.
|
|
955
|
-
* @type {string}
|
|
956
|
-
* @memberof TransactionEventTransaction
|
|
957
544
|
*/
|
|
958
545
|
'processedDateTime'?: string;
|
|
959
546
|
/**
|
|
960
547
|
* Contains previous amounts in a Financial message that has been corrected, in transaction currency.
|
|
961
|
-
* @type {Money}
|
|
962
|
-
* @memberof TransactionEventTransaction
|
|
963
548
|
*/
|
|
964
549
|
'originalAmount'?: Money;
|
|
965
550
|
/**
|
|
966
551
|
* Identifies the clearing systems processing date expressed in the local time zone of the clearing system.
|
|
967
|
-
* @type {string}
|
|
968
|
-
* @memberof TransactionEventTransaction
|
|
969
552
|
*/
|
|
970
553
|
'reconciliationDate'?: string;
|
|
971
554
|
/**
|
|
972
555
|
* Identifies a reconciliation period in a reconciliation date.
|
|
973
|
-
* @type {string}
|
|
974
|
-
* @memberof TransactionEventTransaction
|
|
975
556
|
*/
|
|
976
557
|
'reconciliationCycle'?: string;
|
|
977
|
-
/**
|
|
978
|
-
*
|
|
979
|
-
* @type {InterchangeFee}
|
|
980
|
-
* @memberof TransactionEventTransaction
|
|
981
|
-
*/
|
|
982
558
|
'interchangeFee'?: InterchangeFee;
|
|
983
|
-
/**
|
|
984
|
-
*
|
|
985
|
-
* @type {ExchangeRates}
|
|
986
|
-
* @memberof TransactionEventTransaction
|
|
987
|
-
*/
|
|
988
559
|
'exchangeRates'?: ExchangeRates;
|
|
989
|
-
/**
|
|
990
|
-
*
|
|
991
|
-
* @type {ClearingStatus}
|
|
992
|
-
* @memberof TransactionEventTransaction
|
|
993
|
-
*/
|
|
994
560
|
'clearingStatus'?: ClearingStatus;
|
|
995
561
|
/**
|
|
996
562
|
* Indicates if transaction was cleared in a single operation.
|
|
997
|
-
* @type {boolean}
|
|
998
|
-
* @memberof TransactionEventTransaction
|
|
999
563
|
*/
|
|
1000
564
|
'partialClearingApplied'?: boolean;
|
|
1001
565
|
/**
|
|
1002
566
|
* Response to the authorisation. Indicates to the merchant if the authorisation was approved or declined. Supports alphanumeric codes (e.g., Visa N7).
|
|
1003
|
-
* @type {string}
|
|
1004
|
-
* @memberof TransactionEventTransaction
|
|
1005
567
|
*/
|
|
1006
568
|
'responseCode'?: string;
|
|
1007
569
|
}
|
|
1008
|
-
/**
|
|
1009
|
-
*
|
|
1010
|
-
* @export
|
|
1011
|
-
* @interface TransactionFee
|
|
1012
|
-
*/
|
|
1013
570
|
export interface TransactionFee {
|
|
1014
571
|
/**
|
|
1015
572
|
* Type of Issuer generated transaction fee in cardholder billing currency. Transaction based fees that are additional fees charged on top of the transaction.
|
|
1016
|
-
* @type {string}
|
|
1017
|
-
* @memberof TransactionFee
|
|
1018
573
|
*/
|
|
1019
574
|
'type'?: TransactionFeeTypeEnum;
|
|
1020
575
|
/**
|
|
1021
576
|
* Transaction fee amount in cardholder billing currency.
|
|
1022
|
-
* @type {Money}
|
|
1023
|
-
* @memberof TransactionFee
|
|
1024
577
|
*/
|
|
1025
578
|
'amount'?: Money;
|
|
1026
579
|
}
|
|
@@ -1032,8 +585,6 @@ export declare const TransactionFeeTypeEnum: {
|
|
|
1032
585
|
export type TransactionFeeTypeEnum = typeof TransactionFeeTypeEnum[keyof typeof TransactionFeeTypeEnum];
|
|
1033
586
|
/**
|
|
1034
587
|
* The transaction Type
|
|
1035
|
-
* @export
|
|
1036
|
-
* @enum {string}
|
|
1037
588
|
*/
|
|
1038
589
|
export declare const TransactionType: {
|
|
1039
590
|
readonly Retail: "RETAIL";
|
|
@@ -1056,8 +607,6 @@ export declare const TransactionType: {
|
|
|
1056
607
|
export type TransactionType = typeof TransactionType[keyof typeof TransactionType];
|
|
1057
608
|
/**
|
|
1058
609
|
* The transaction Type
|
|
1059
|
-
* @export
|
|
1060
|
-
* @enum {string}
|
|
1061
610
|
*/
|
|
1062
611
|
export declare const TransactionTypeClearing: {
|
|
1063
612
|
readonly Retail: "RETAIL";
|