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