@enfuce/nextgen-sdk 0.0.2 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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 +0 -452
- package/dist/esm/transaction-event/api.js +11 -27
- 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 +0 -452
- package/dist/transaction-event/api.js +11 -27
- 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 +2 -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 +12 -464
- 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
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.
|
|
416
|
-
* @export
|
|
417
|
-
* @enum {string}
|
|
418
260
|
*/
|
|
419
261
|
export declare const MessageCategoryTransactionEvent: {
|
|
420
262
|
readonly InitialAuthorization: "INITIAL_AUTHORIZATION";
|
|
@@ -441,8 +283,6 @@ export declare const MessageCategoryTransactionEvent: {
|
|
|
441
283
|
export type MessageCategoryTransactionEvent = typeof MessageCategoryTransactionEvent[keyof typeof MessageCategoryTransactionEvent];
|
|
442
284
|
/**
|
|
443
285
|
* Identifies the message function of the transaction event.
|
|
444
|
-
* @export
|
|
445
|
-
* @enum {string}
|
|
446
286
|
*/
|
|
447
287
|
export declare const MessageFunctionTransactionEvent: {
|
|
448
288
|
readonly Request: "REQUEST";
|
|
@@ -453,178 +293,93 @@ export declare const MessageFunctionTransactionEvent: {
|
|
|
453
293
|
export type MessageFunctionTransactionEvent = typeof MessageFunctionTransactionEvent[keyof typeof MessageFunctionTransactionEvent];
|
|
454
294
|
/**
|
|
455
295
|
* Amount including currency.
|
|
456
|
-
* @export
|
|
457
|
-
* @interface Money
|
|
458
296
|
*/
|
|
459
297
|
export interface Money {
|
|
460
|
-
/**
|
|
461
|
-
*
|
|
462
|
-
* @type {number}
|
|
463
|
-
* @memberof Money
|
|
464
|
-
*/
|
|
465
298
|
'amount': number;
|
|
466
299
|
/**
|
|
467
300
|
* A valid ISO 4217 currency code
|
|
468
|
-
* @type {string}
|
|
469
|
-
* @memberof Money
|
|
470
301
|
*/
|
|
471
302
|
'currency': string;
|
|
472
303
|
}
|
|
473
|
-
/**
|
|
474
|
-
*
|
|
475
|
-
* @export
|
|
476
|
-
* @interface ProcessedTransaction
|
|
477
|
-
*/
|
|
478
304
|
export interface ProcessedTransaction {
|
|
479
305
|
/**
|
|
480
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.
|
|
481
|
-
* @type {string}
|
|
482
|
-
* @memberof ProcessedTransaction
|
|
483
307
|
*/
|
|
484
308
|
'authCode'?: string;
|
|
485
309
|
/**
|
|
486
310
|
* Number of days the authorisation is valid (applicable when merchants requests for extended authorisation period, longer than the default 7 days).
|
|
487
|
-
* @type {number}
|
|
488
|
-
* @memberof ProcessedTransaction
|
|
489
311
|
*/
|
|
490
312
|
'authValidity'?: number;
|
|
491
313
|
/**
|
|
492
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.
|
|
493
|
-
* @type {Money}
|
|
494
|
-
* @memberof ProcessedTransaction
|
|
495
315
|
*/
|
|
496
316
|
'billingAmount'?: Money;
|
|
497
317
|
/**
|
|
498
318
|
* The transaction amount in the local currency of the acquirer or the merchant, where the transaction occurred.
|
|
499
|
-
* @type {Money}
|
|
500
|
-
* @memberof ProcessedTransaction
|
|
501
319
|
*/
|
|
502
320
|
'transactionAmount'?: Money;
|
|
503
321
|
/**
|
|
504
322
|
* The amount of funds transferred between the acquirer and the issuer, equal to the `transactionAmount`, in the settlement currency.
|
|
505
|
-
* @type {Money}
|
|
506
|
-
* @memberof ProcessedTransaction
|
|
507
323
|
*/
|
|
508
324
|
'settlementAmount'?: Money;
|
|
509
325
|
/**
|
|
510
326
|
* Fee charged (for example, by the acquirer) for transaction activity.
|
|
511
|
-
* @type {Money}
|
|
512
|
-
* @memberof ProcessedTransaction
|
|
513
327
|
*/
|
|
514
328
|
'acquirerTransactionFeeAmount'?: Money;
|
|
515
|
-
/**
|
|
516
|
-
*
|
|
517
|
-
* @type {Array<TransactionFee>}
|
|
518
|
-
* @memberof ProcessedTransaction
|
|
519
|
-
*/
|
|
520
329
|
'issuerTransactionFees'?: Array<TransactionFee>;
|
|
521
|
-
/**
|
|
522
|
-
*
|
|
523
|
-
* @type {Array<CardholderVerificationMethod>}
|
|
524
|
-
* @memberof ProcessedTransaction
|
|
525
|
-
*/
|
|
526
330
|
'cardholderVerificationMethods'?: Array<CardholderVerificationMethod>;
|
|
527
331
|
/**
|
|
528
332
|
* Merchant/acquirer generated transaction reference number.
|
|
529
|
-
* @type {string}
|
|
530
|
-
* @memberof ProcessedTransaction
|
|
531
333
|
*/
|
|
532
334
|
'retrievalReferenceNumber'?: string;
|
|
533
|
-
/**
|
|
534
|
-
*
|
|
535
|
-
* @type {CardEntryMode}
|
|
536
|
-
* @memberof ProcessedTransaction
|
|
537
|
-
*/
|
|
538
335
|
'cardEntryMode'?: CardEntryMode;
|
|
539
336
|
/**
|
|
540
337
|
* Indicates whether the cardholder is physically present during transaction.
|
|
541
|
-
* @type {boolean}
|
|
542
|
-
* @memberof ProcessedTransaction
|
|
543
338
|
*/
|
|
544
339
|
'cardholderPresent'?: boolean;
|
|
545
340
|
/**
|
|
546
341
|
* Indicates whether the card is present at the point of service.
|
|
547
|
-
* @type {boolean}
|
|
548
|
-
* @memberof ProcessedTransaction
|
|
549
342
|
*/
|
|
550
343
|
'cardPresent'?: boolean;
|
|
551
344
|
/**
|
|
552
345
|
* Indicates whether the transaction is a recurring payment or merchant initiated. This implies whether the cardholder has approved the merchant initiated transaction.
|
|
553
|
-
* @type {boolean}
|
|
554
|
-
* @memberof ProcessedTransaction
|
|
555
346
|
*/
|
|
556
347
|
'merchantInitiated'?: boolean;
|
|
557
348
|
/**
|
|
558
349
|
* Date and time in the time zone where the transaction occurred.
|
|
559
|
-
* @type {string}
|
|
560
|
-
* @memberof ProcessedTransaction
|
|
561
350
|
*/
|
|
562
351
|
'transactionDateTime'?: string;
|
|
563
352
|
/**
|
|
564
353
|
* This value is present only for recurring transaction, and it\'s value is first original authorisation request in the chain.
|
|
565
|
-
* @type {string}
|
|
566
|
-
* @memberof ProcessedTransaction
|
|
567
354
|
*/
|
|
568
355
|
'originalTransactionId'?: string;
|
|
569
|
-
/**
|
|
570
|
-
*
|
|
571
|
-
* @type {TransactionTypeClearing}
|
|
572
|
-
* @memberof ProcessedTransaction
|
|
573
|
-
*/
|
|
574
356
|
'transactionType'?: TransactionTypeClearing;
|
|
575
357
|
/**
|
|
576
358
|
* Contains previous amounts in a Financial message that has been corrected, in transaction currency.
|
|
577
|
-
* @type {Money}
|
|
578
|
-
* @memberof ProcessedTransaction
|
|
579
359
|
*/
|
|
580
360
|
'originalAmount'?: Money;
|
|
581
361
|
/**
|
|
582
362
|
* Identifies the clearing systems processing date expressed in the local time zone of the clearing system.
|
|
583
|
-
* @type {string}
|
|
584
|
-
* @memberof ProcessedTransaction
|
|
585
363
|
*/
|
|
586
364
|
'reconciliationDate'?: string;
|
|
587
365
|
/**
|
|
588
366
|
* Identifies a reconciliation period in a reconciliation date.
|
|
589
|
-
* @type {string}
|
|
590
|
-
* @memberof ProcessedTransaction
|
|
591
367
|
*/
|
|
592
368
|
'reconciliationCycle'?: string;
|
|
593
369
|
/**
|
|
594
370
|
* Time when processed by Enfuce.
|
|
595
|
-
* @type {string}
|
|
596
|
-
* @memberof ProcessedTransaction
|
|
597
371
|
*/
|
|
598
372
|
'processedDateTime'?: string;
|
|
599
|
-
/**
|
|
600
|
-
*
|
|
601
|
-
* @type {InterchangeFee}
|
|
602
|
-
* @memberof ProcessedTransaction
|
|
603
|
-
*/
|
|
604
373
|
'interchangeFee'?: InterchangeFee;
|
|
605
|
-
/**
|
|
606
|
-
*
|
|
607
|
-
* @type {ExchangeRates}
|
|
608
|
-
* @memberof ProcessedTransaction
|
|
609
|
-
*/
|
|
610
374
|
'exchangeRates'?: ExchangeRates;
|
|
611
375
|
}
|
|
612
376
|
/**
|
|
613
377
|
* Information about the token associated with the card.
|
|
614
|
-
* @export
|
|
615
|
-
* @interface Token
|
|
616
378
|
*/
|
|
617
379
|
export interface Token {
|
|
618
|
-
/**
|
|
619
|
-
*
|
|
620
|
-
* @type {string}
|
|
621
|
-
* @memberof Token
|
|
622
|
-
*/
|
|
623
380
|
'id'?: string;
|
|
624
381
|
/**
|
|
625
382
|
* Identifies the specific digital wallet.
|
|
626
|
-
* @type {string}
|
|
627
|
-
* @memberof Token
|
|
628
383
|
*/
|
|
629
384
|
'walletIdentifier'?: TokenWalletIdentifierEnum;
|
|
630
385
|
}
|
|
@@ -636,392 +391,189 @@ export declare const TokenWalletIdentifierEnum: {
|
|
|
636
391
|
readonly RemoteCommercePrograms: "REMOTE_COMMERCE_PROGRAMS";
|
|
637
392
|
};
|
|
638
393
|
export type TokenWalletIdentifierEnum = typeof TokenWalletIdentifierEnum[keyof typeof TokenWalletIdentifierEnum];
|
|
639
|
-
/**
|
|
640
|
-
*
|
|
641
|
-
* @export
|
|
642
|
-
* @interface Transaction
|
|
643
|
-
*/
|
|
644
394
|
export interface Transaction {
|
|
645
395
|
/**
|
|
646
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.
|
|
647
|
-
* @type {string}
|
|
648
|
-
* @memberof Transaction
|
|
649
397
|
*/
|
|
650
398
|
'authCode'?: string;
|
|
651
399
|
/**
|
|
652
400
|
* Number of days the authorisation is valid (applicable when merchants requests for extended authorisation period, longer than the default 7 days).
|
|
653
|
-
* @type {number}
|
|
654
|
-
* @memberof Transaction
|
|
655
401
|
*/
|
|
656
402
|
'authValidity'?: number;
|
|
657
403
|
/**
|
|
658
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.
|
|
659
|
-
* @type {Money}
|
|
660
|
-
* @memberof Transaction
|
|
661
405
|
*/
|
|
662
406
|
'billingAmount'?: Money;
|
|
663
407
|
/**
|
|
664
408
|
* The transaction amount in the local currency of the acquirer or the merchant, where the transaction occurred.
|
|
665
|
-
* @type {Money}
|
|
666
|
-
* @memberof Transaction
|
|
667
409
|
*/
|
|
668
410
|
'transactionAmount'?: Money;
|
|
669
411
|
/**
|
|
670
412
|
* The amount of funds transferred between the acquirer and the issuer, equal to the `transactionAmount`, in the settlement currency.
|
|
671
|
-
* @type {Money}
|
|
672
|
-
* @memberof Transaction
|
|
673
413
|
*/
|
|
674
414
|
'settlementAmount'?: Money;
|
|
675
415
|
/**
|
|
676
416
|
* Fee charged (for example, by the acquirer) for transaction activity.
|
|
677
|
-
* @type {Money}
|
|
678
|
-
* @memberof Transaction
|
|
679
417
|
*/
|
|
680
418
|
'acquirerTransactionFeeAmount'?: Money;
|
|
681
|
-
/**
|
|
682
|
-
*
|
|
683
|
-
* @type {Array<TransactionFee>}
|
|
684
|
-
* @memberof Transaction
|
|
685
|
-
*/
|
|
686
419
|
'issuerTransactionFees'?: Array<TransactionFee>;
|
|
687
|
-
/**
|
|
688
|
-
*
|
|
689
|
-
* @type {Array<CardholderVerificationMethod>}
|
|
690
|
-
* @memberof Transaction
|
|
691
|
-
*/
|
|
692
420
|
'cardholderVerificationMethods'?: Array<CardholderVerificationMethod>;
|
|
693
421
|
/**
|
|
694
422
|
* Merchant/acquirer generated transaction reference number.
|
|
695
|
-
* @type {string}
|
|
696
|
-
* @memberof Transaction
|
|
697
423
|
*/
|
|
698
424
|
'retrievalReferenceNumber'?: string;
|
|
699
|
-
/**
|
|
700
|
-
*
|
|
701
|
-
* @type {CardEntryMode}
|
|
702
|
-
* @memberof Transaction
|
|
703
|
-
*/
|
|
704
425
|
'cardEntryMode'?: CardEntryMode;
|
|
705
426
|
/**
|
|
706
427
|
* Indicates whether the cardholder is physically present during transaction.
|
|
707
|
-
* @type {boolean}
|
|
708
|
-
* @memberof Transaction
|
|
709
428
|
*/
|
|
710
429
|
'cardholderPresent'?: boolean;
|
|
711
430
|
/**
|
|
712
431
|
* Indicates whether the card is present at the point of service.
|
|
713
|
-
* @type {boolean}
|
|
714
|
-
* @memberof Transaction
|
|
715
432
|
*/
|
|
716
433
|
'cardPresent'?: boolean;
|
|
717
434
|
/**
|
|
718
435
|
* Indicates whether the transaction is a recurring payment or merchant initiated. This implies whether the cardholder has approved the merchant initiated transaction.
|
|
719
|
-
* @type {boolean}
|
|
720
|
-
* @memberof Transaction
|
|
721
436
|
*/
|
|
722
437
|
'merchantInitiated'?: boolean;
|
|
723
438
|
/**
|
|
724
439
|
* Date and time in the time zone where the transaction occurred.
|
|
725
|
-
* @type {string}
|
|
726
|
-
* @memberof Transaction
|
|
727
440
|
*/
|
|
728
441
|
'transactionDateTime'?: string;
|
|
729
442
|
/**
|
|
730
443
|
* This value is present only for recurring transaction, and it\'s value is first original authorisation request in the chain.
|
|
731
|
-
* @type {string}
|
|
732
|
-
* @memberof Transaction
|
|
733
444
|
*/
|
|
734
445
|
'originalTransactionId'?: string;
|
|
735
446
|
}
|
|
736
|
-
/**
|
|
737
|
-
*
|
|
738
|
-
* @export
|
|
739
|
-
* @interface TransactionEvent
|
|
740
|
-
*/
|
|
741
447
|
export interface TransactionEvent {
|
|
742
448
|
/**
|
|
743
449
|
* Unique system generated ID assigned to each event in the payment processing workflow. For example, an ID assigned to the initial authorisation event.
|
|
744
|
-
* @type {string}
|
|
745
|
-
* @memberof TransactionEvent
|
|
746
450
|
*/
|
|
747
451
|
'id'?: string;
|
|
748
452
|
/**
|
|
749
453
|
* Unique ID assigned to VOID_AUTHORIZATION message category — applicable only for VOID_AUTHORIZATION.
|
|
750
|
-
* @type {string}
|
|
751
|
-
* @memberof TransactionEvent
|
|
752
454
|
*/
|
|
753
455
|
'referenceTransactionEventId'?: string;
|
|
754
456
|
/**
|
|
755
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`.
|
|
756
|
-
* @type {string}
|
|
757
|
-
* @memberof TransactionEvent
|
|
758
458
|
*/
|
|
759
459
|
'transactionId'?: string;
|
|
760
|
-
/**
|
|
761
|
-
*
|
|
762
|
-
* @type {MessageCategoryTransactionEvent}
|
|
763
|
-
* @memberof TransactionEvent
|
|
764
|
-
*/
|
|
765
460
|
'messageCategory'?: MessageCategoryTransactionEvent;
|
|
766
|
-
/**
|
|
767
|
-
*
|
|
768
|
-
* @type {MessageFunctionTransactionEvent}
|
|
769
|
-
* @memberof TransactionEvent
|
|
770
|
-
*/
|
|
771
461
|
'messageFunction'?: MessageFunctionTransactionEvent;
|
|
772
|
-
/**
|
|
773
|
-
*
|
|
774
|
-
* @type {ClearingStatus}
|
|
775
|
-
* @memberof TransactionEvent
|
|
776
|
-
*/
|
|
777
462
|
'clearingStatus'?: ClearingStatus;
|
|
778
|
-
/**
|
|
779
|
-
*
|
|
780
|
-
* @type {Card}
|
|
781
|
-
* @memberof TransactionEvent
|
|
782
|
-
*/
|
|
783
463
|
'card'?: Card;
|
|
784
|
-
/**
|
|
785
|
-
*
|
|
786
|
-
* @type {Merchant}
|
|
787
|
-
* @memberof TransactionEvent
|
|
788
|
-
*/
|
|
789
464
|
'merchant'?: Merchant;
|
|
790
|
-
/**
|
|
791
|
-
*
|
|
792
|
-
* @type {TransactionEventTransaction}
|
|
793
|
-
* @memberof TransactionEvent
|
|
794
|
-
*/
|
|
795
465
|
'transaction'?: TransactionEventTransaction;
|
|
796
|
-
/**
|
|
797
|
-
*
|
|
798
|
-
* @type {Token}
|
|
799
|
-
* @memberof TransactionEvent
|
|
800
|
-
*/
|
|
801
466
|
'token'?: Token;
|
|
802
467
|
}
|
|
803
|
-
/**
|
|
804
|
-
*
|
|
805
|
-
* @export
|
|
806
|
-
* @interface TransactionEventMetadata
|
|
807
|
-
*/
|
|
808
468
|
export interface TransactionEventMetadata {
|
|
809
469
|
/**
|
|
810
470
|
* Unique system generated ID assigned to each event in the payment processing workflow. For example, an ID assigned to the initial authorisation event.
|
|
811
|
-
* @type {string}
|
|
812
|
-
* @memberof TransactionEventMetadata
|
|
813
471
|
*/
|
|
814
472
|
'id'?: string;
|
|
815
473
|
/**
|
|
816
474
|
* Unique ID assigned to VOID_AUTHORIZATION message category — applicable only for VOID_AUTHORIZATION.
|
|
817
|
-
* @type {string}
|
|
818
|
-
* @memberof TransactionEventMetadata
|
|
819
475
|
*/
|
|
820
476
|
'referenceTransactionEventId'?: string;
|
|
821
477
|
/**
|
|
822
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`.
|
|
823
|
-
* @type {string}
|
|
824
|
-
* @memberof TransactionEventMetadata
|
|
825
479
|
*/
|
|
826
480
|
'transactionId'?: string;
|
|
827
|
-
/**
|
|
828
|
-
*
|
|
829
|
-
* @type {MessageCategoryTransactionEvent}
|
|
830
|
-
* @memberof TransactionEventMetadata
|
|
831
|
-
*/
|
|
832
481
|
'messageCategory'?: MessageCategoryTransactionEvent;
|
|
833
|
-
/**
|
|
834
|
-
*
|
|
835
|
-
* @type {MessageFunctionTransactionEvent}
|
|
836
|
-
* @memberof TransactionEventMetadata
|
|
837
|
-
*/
|
|
838
482
|
'messageFunction'?: MessageFunctionTransactionEvent;
|
|
839
|
-
/**
|
|
840
|
-
*
|
|
841
|
-
* @type {ClearingStatus}
|
|
842
|
-
* @memberof TransactionEventMetadata
|
|
843
|
-
*/
|
|
844
483
|
'clearingStatus'?: ClearingStatus;
|
|
845
484
|
}
|
|
846
|
-
/**
|
|
847
|
-
*
|
|
848
|
-
* @export
|
|
849
|
-
* @interface TransactionEventTransaction
|
|
850
|
-
*/
|
|
851
485
|
export interface TransactionEventTransaction {
|
|
852
486
|
/**
|
|
853
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.
|
|
854
|
-
* @type {string}
|
|
855
|
-
* @memberof TransactionEventTransaction
|
|
856
488
|
*/
|
|
857
489
|
'authCode'?: string;
|
|
858
490
|
/**
|
|
859
491
|
* Number of days the authorisation is valid (applicable when merchants requests for extended authorisation period, longer than the default 7 days).
|
|
860
|
-
* @type {number}
|
|
861
|
-
* @memberof TransactionEventTransaction
|
|
862
492
|
*/
|
|
863
493
|
'authValidity'?: number;
|
|
864
494
|
/**
|
|
865
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.
|
|
866
|
-
* @type {Money}
|
|
867
|
-
* @memberof TransactionEventTransaction
|
|
868
496
|
*/
|
|
869
497
|
'billingAmount'?: Money;
|
|
870
498
|
/**
|
|
871
499
|
* The transaction amount in the local currency of the acquirer or the merchant, where the transaction occurred.
|
|
872
|
-
* @type {Money}
|
|
873
|
-
* @memberof TransactionEventTransaction
|
|
874
500
|
*/
|
|
875
501
|
'transactionAmount'?: Money;
|
|
876
502
|
/**
|
|
877
503
|
* The amount of funds transferred between the acquirer and the issuer, equal to the `transactionAmount`, in the settlement currency.
|
|
878
|
-
* @type {Money}
|
|
879
|
-
* @memberof TransactionEventTransaction
|
|
880
504
|
*/
|
|
881
505
|
'settlementAmount'?: Money;
|
|
882
506
|
/**
|
|
883
507
|
* Fee charged (for example, by the acquirer) for transaction activity.
|
|
884
|
-
* @type {Money}
|
|
885
|
-
* @memberof TransactionEventTransaction
|
|
886
508
|
*/
|
|
887
509
|
'acquirerTransactionFeeAmount'?: Money;
|
|
888
|
-
/**
|
|
889
|
-
*
|
|
890
|
-
* @type {Array<TransactionFee>}
|
|
891
|
-
* @memberof TransactionEventTransaction
|
|
892
|
-
*/
|
|
893
510
|
'issuerTransactionFees'?: Array<TransactionFee>;
|
|
894
|
-
/**
|
|
895
|
-
*
|
|
896
|
-
* @type {Array<CardholderVerificationMethod>}
|
|
897
|
-
* @memberof TransactionEventTransaction
|
|
898
|
-
*/
|
|
899
511
|
'cardholderVerificationMethods'?: Array<CardholderVerificationMethod>;
|
|
900
512
|
/**
|
|
901
513
|
* Merchant/acquirer generated transaction reference number.
|
|
902
|
-
* @type {string}
|
|
903
|
-
* @memberof TransactionEventTransaction
|
|
904
514
|
*/
|
|
905
515
|
'retrievalReferenceNumber'?: string;
|
|
906
|
-
/**
|
|
907
|
-
*
|
|
908
|
-
* @type {CardEntryMode}
|
|
909
|
-
* @memberof TransactionEventTransaction
|
|
910
|
-
*/
|
|
911
516
|
'cardEntryMode'?: CardEntryMode;
|
|
912
517
|
/**
|
|
913
518
|
* Indicates whether the cardholder is physically present during transaction.
|
|
914
|
-
* @type {boolean}
|
|
915
|
-
* @memberof TransactionEventTransaction
|
|
916
519
|
*/
|
|
917
520
|
'cardholderPresent'?: boolean;
|
|
918
521
|
/**
|
|
919
522
|
* Indicates whether the card is present at the point of service.
|
|
920
|
-
* @type {boolean}
|
|
921
|
-
* @memberof TransactionEventTransaction
|
|
922
523
|
*/
|
|
923
524
|
'cardPresent'?: boolean;
|
|
924
525
|
/**
|
|
925
526
|
* Indicates whether the transaction is a recurring payment or merchant initiated. This implies whether the cardholder has approved the merchant initiated transaction.
|
|
926
|
-
* @type {boolean}
|
|
927
|
-
* @memberof TransactionEventTransaction
|
|
928
527
|
*/
|
|
929
528
|
'merchantInitiated'?: boolean;
|
|
930
529
|
/**
|
|
931
530
|
* Date and time in the time zone where the transaction occurred.
|
|
932
|
-
* @type {string}
|
|
933
|
-
* @memberof TransactionEventTransaction
|
|
934
531
|
*/
|
|
935
532
|
'transactionDateTime'?: string;
|
|
936
533
|
/**
|
|
937
534
|
* This value is present only for recurring transaction, and it\'s value is first original authorisation request in the chain.
|
|
938
|
-
* @type {string}
|
|
939
|
-
* @memberof TransactionEventTransaction
|
|
940
535
|
*/
|
|
941
536
|
'originalTransactionId'?: string;
|
|
942
|
-
/**
|
|
943
|
-
*
|
|
944
|
-
* @type {TransactionTypeClearing}
|
|
945
|
-
* @memberof TransactionEventTransaction
|
|
946
|
-
*/
|
|
947
537
|
'transactionType'?: TransactionTypeClearing;
|
|
948
538
|
/**
|
|
949
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.
|
|
950
|
-
* @type {Money}
|
|
951
|
-
* @memberof TransactionEventTransaction
|
|
952
540
|
*/
|
|
953
541
|
'approvedAmount'?: Money;
|
|
954
542
|
/**
|
|
955
543
|
* Time when processed by Enfuce.
|
|
956
|
-
* @type {string}
|
|
957
|
-
* @memberof TransactionEventTransaction
|
|
958
544
|
*/
|
|
959
545
|
'processedDateTime'?: string;
|
|
960
546
|
/**
|
|
961
547
|
* Contains previous amounts in a Financial message that has been corrected, in transaction currency.
|
|
962
|
-
* @type {Money}
|
|
963
|
-
* @memberof TransactionEventTransaction
|
|
964
548
|
*/
|
|
965
549
|
'originalAmount'?: Money;
|
|
966
550
|
/**
|
|
967
551
|
* Identifies the clearing systems processing date expressed in the local time zone of the clearing system.
|
|
968
|
-
* @type {string}
|
|
969
|
-
* @memberof TransactionEventTransaction
|
|
970
552
|
*/
|
|
971
553
|
'reconciliationDate'?: string;
|
|
972
554
|
/**
|
|
973
555
|
* Identifies a reconciliation period in a reconciliation date.
|
|
974
|
-
* @type {string}
|
|
975
|
-
* @memberof TransactionEventTransaction
|
|
976
556
|
*/
|
|
977
557
|
'reconciliationCycle'?: string;
|
|
978
|
-
/**
|
|
979
|
-
*
|
|
980
|
-
* @type {InterchangeFee}
|
|
981
|
-
* @memberof TransactionEventTransaction
|
|
982
|
-
*/
|
|
983
558
|
'interchangeFee'?: InterchangeFee;
|
|
984
|
-
/**
|
|
985
|
-
*
|
|
986
|
-
* @type {ExchangeRates}
|
|
987
|
-
* @memberof TransactionEventTransaction
|
|
988
|
-
*/
|
|
989
559
|
'exchangeRates'?: ExchangeRates;
|
|
990
|
-
/**
|
|
991
|
-
*
|
|
992
|
-
* @type {ClearingStatus}
|
|
993
|
-
* @memberof TransactionEventTransaction
|
|
994
|
-
*/
|
|
995
560
|
'clearingStatus'?: ClearingStatus;
|
|
996
561
|
/**
|
|
997
562
|
* Indicates if transaction was cleared in a single operation.
|
|
998
|
-
* @type {boolean}
|
|
999
|
-
* @memberof TransactionEventTransaction
|
|
1000
563
|
*/
|
|
1001
564
|
'partialClearingApplied'?: boolean;
|
|
1002
565
|
/**
|
|
1003
566
|
* Response to the authorisation. Indicates to the merchant if the authorisation was approved or declined. Supports alphanumeric codes (e.g., Visa N7).
|
|
1004
|
-
* @type {string}
|
|
1005
|
-
* @memberof TransactionEventTransaction
|
|
1006
567
|
*/
|
|
1007
568
|
'responseCode'?: string;
|
|
1008
569
|
}
|
|
1009
|
-
/**
|
|
1010
|
-
*
|
|
1011
|
-
* @export
|
|
1012
|
-
* @interface TransactionFee
|
|
1013
|
-
*/
|
|
1014
570
|
export interface TransactionFee {
|
|
1015
571
|
/**
|
|
1016
572
|
* Type of Issuer generated transaction fee in cardholder billing currency. Transaction based fees that are additional fees charged on top of the transaction.
|
|
1017
|
-
* @type {string}
|
|
1018
|
-
* @memberof TransactionFee
|
|
1019
573
|
*/
|
|
1020
574
|
'type'?: TransactionFeeTypeEnum;
|
|
1021
575
|
/**
|
|
1022
576
|
* Transaction fee amount in cardholder billing currency.
|
|
1023
|
-
* @type {Money}
|
|
1024
|
-
* @memberof TransactionFee
|
|
1025
577
|
*/
|
|
1026
578
|
'amount'?: Money;
|
|
1027
579
|
}
|
|
@@ -1033,8 +585,6 @@ export declare const TransactionFeeTypeEnum: {
|
|
|
1033
585
|
export type TransactionFeeTypeEnum = typeof TransactionFeeTypeEnum[keyof typeof TransactionFeeTypeEnum];
|
|
1034
586
|
/**
|
|
1035
587
|
* The transaction Type
|
|
1036
|
-
* @export
|
|
1037
|
-
* @enum {string}
|
|
1038
588
|
*/
|
|
1039
589
|
export declare const TransactionType: {
|
|
1040
590
|
readonly Retail: "RETAIL";
|
|
@@ -1057,8 +607,6 @@ export declare const TransactionType: {
|
|
|
1057
607
|
export type TransactionType = typeof TransactionType[keyof typeof TransactionType];
|
|
1058
608
|
/**
|
|
1059
609
|
* The transaction Type
|
|
1060
|
-
* @export
|
|
1061
|
-
* @enum {string}
|
|
1062
610
|
*/
|
|
1063
611
|
export declare const TransactionTypeClearing: {
|
|
1064
612
|
readonly Retail: "RETAIL";
|