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