@vantagepay/vantagepay 0.15.0
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 +515 -0
- package/dist/apiConfig.d.ts +10 -0
- package/dist/apiError.d.ts +5 -0
- package/dist/apiTokens.d.ts +7 -0
- package/dist/authentication/index.d.ts +22 -0
- package/dist/authentication/types.d.ts +67 -0
- package/dist/baseApi.d.ts +9 -0
- package/dist/common/types.d.ts +99 -0
- package/dist/consumers/index.d.ts +11 -0
- package/dist/consumers/types.d.ts +358 -0
- package/dist/content/index.d.ts +7 -0
- package/dist/devices/types.d.ts +20 -0
- package/dist/eventTypes.d.ts +10 -0
- package/dist/gmoney/index.d.ts +48 -0
- package/dist/gmoney/types.d.ts +136 -0
- package/dist/hubtel/index.d.ts +21 -0
- package/dist/hubtel/types.d.ts +35 -0
- package/dist/index.d.ts +36 -0
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -0
- package/dist/index.m.js +2 -0
- package/dist/index.m.js.map +1 -0
- package/dist/index.modern.mjs +2 -0
- package/dist/index.modern.mjs.map +1 -0
- package/dist/index.umd.js +2 -0
- package/dist/index.umd.js.map +1 -0
- package/dist/log/index.d.ts +19 -0
- package/dist/log/messageTemplate.d.ts +10 -0
- package/dist/log/types.d.ts +20 -0
- package/dist/lookups/index.d.ts +28 -0
- package/dist/lookups/types.d.ts +1840 -0
- package/dist/merchants/index.d.ts +36 -0
- package/dist/merchants/types.d.ts +479 -0
- package/dist/payments/index.d.ts +38 -0
- package/dist/payments/types.d.ts +2015 -0
- package/dist/qr/index.d.ts +6 -0
- package/dist/reports/index.d.ts +8 -0
- package/dist/reports/types.d.ts +67 -0
- package/dist/system/index.d.ts +4 -0
- package/dist/tokens/types.d.ts +38 -0
- package/dist/transflow/index.d.ts +11 -0
- package/dist/transflow/types.d.ts +11 -0
- package/package.json +47 -0
|
@@ -0,0 +1,2015 @@
|
|
|
1
|
+
import { Currency } from '../lookups/types';
|
|
2
|
+
import { Country } from '../lookups/types';
|
|
3
|
+
import { Address } from '../common/types';
|
|
4
|
+
import { BasicConsumer } from '../consumers/types';
|
|
5
|
+
import { Location } from '../common/types';
|
|
6
|
+
import { Bank } from '../lookups/types';
|
|
7
|
+
import { MobileWalletOperator } from '../lookups/types';
|
|
8
|
+
import { Channel } from '../lookups/types';
|
|
9
|
+
import { RepeatInterval } from '../lookups/types';
|
|
10
|
+
import { Month } from '../lookups/types';
|
|
11
|
+
import { BasicMerchant } from '../merchants/types';
|
|
12
|
+
export declare abstract class AccountHolderTransactionResult {
|
|
13
|
+
accountHolder?: string;
|
|
14
|
+
/** A collection of the results of all refund transactions that are associated with the transaction that this result object refers to. */
|
|
15
|
+
refunds: RefundTransactionResult[];
|
|
16
|
+
/** The date and time this transaction record was created. */
|
|
17
|
+
createdDate: Date;
|
|
18
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
19
|
+
reference?: string;
|
|
20
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
21
|
+
shortReference?: string;
|
|
22
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
23
|
+
description?: string;
|
|
24
|
+
/** The original amount of the transaction, in cents, as submitted to the payment engine over the wire before Fees and Commissions are factored in. */
|
|
25
|
+
originalAmountInCents: number;
|
|
26
|
+
/** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
|
|
27
|
+
amountAttemptedInCents: number;
|
|
28
|
+
/**
|
|
29
|
+
* The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
|
|
30
|
+
* This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
|
|
31
|
+
*/
|
|
32
|
+
amountInCents: number;
|
|
33
|
+
/** The cashback amount, in cents. */
|
|
34
|
+
cashbackAmountInCents: number;
|
|
35
|
+
/** A collection of all fees applied to the transaction. */
|
|
36
|
+
fees: TransactionFee[];
|
|
37
|
+
/** A collection of metadata linked to this transaction. */
|
|
38
|
+
data: TransactionData[];
|
|
39
|
+
/** A 3 character ISO currency code. */
|
|
40
|
+
currency: Currency;
|
|
41
|
+
/** The current status of the transaction. */
|
|
42
|
+
status: TransactionStatus;
|
|
43
|
+
/** The category of the transaction. */
|
|
44
|
+
category: TransactionCategory;
|
|
45
|
+
/** A derived summary transaction status that groups transaction statuses into less granular sets to make it easier to quickly determine the general status of a transaction. */
|
|
46
|
+
summaryStatus: TransactionStatus;
|
|
47
|
+
isComplete: boolean;
|
|
48
|
+
isCashWithdrawal: boolean;
|
|
49
|
+
/** A message detailing the current status of the transaction. */
|
|
50
|
+
message: string;
|
|
51
|
+
}
|
|
52
|
+
export declare class AmountTotals {
|
|
53
|
+
totalAmountRequestedInCents: number;
|
|
54
|
+
totalAmountAttemptedInCents: number;
|
|
55
|
+
totalAmountProcessedInCents: number;
|
|
56
|
+
totalAmountProcessedLessFeesAndCommissionsInCents: number;
|
|
57
|
+
totalInternalFeesInCents: number;
|
|
58
|
+
totalExternalFeesInCents: number;
|
|
59
|
+
totalFeesInCents: number;
|
|
60
|
+
totalElevyInCents: number;
|
|
61
|
+
totalUserFeesInCents: number;
|
|
62
|
+
totalCommissionsInCents: number;
|
|
63
|
+
totalRefundsInCents: number;
|
|
64
|
+
totalCashbackAmountAttemptedInCents: number;
|
|
65
|
+
totalCashbackAmountProcessedInCents: number;
|
|
66
|
+
totalTipAmountAttemptedInCents: number;
|
|
67
|
+
totalTipAmountProcessedInCents: number;
|
|
68
|
+
grandTotalProcessedInCents: number;
|
|
69
|
+
grandTotalToBePaidByUserInCents: number;
|
|
70
|
+
}
|
|
71
|
+
/** Model to hold card holder details. */
|
|
72
|
+
export declare class CardHolder {
|
|
73
|
+
/** The card holder's first name (required). */
|
|
74
|
+
firstName: string;
|
|
75
|
+
/** The card holder's last name/surname (required). */
|
|
76
|
+
lastName: string;
|
|
77
|
+
/** Gets or sets the card holder's email address (required). */
|
|
78
|
+
emailAddress: string;
|
|
79
|
+
/** Gets or sets the card holder's phone number (required - digits only). */
|
|
80
|
+
phoneNumber: string;
|
|
81
|
+
/** Gets or sets 3 character ISO country code the card holder resides in. */
|
|
82
|
+
countryIsoCode: Country;
|
|
83
|
+
/** The customers shipping address. */
|
|
84
|
+
shippingAddress?: Address;
|
|
85
|
+
}
|
|
86
|
+
export declare enum CardIssuer {
|
|
87
|
+
AmericanExpress = "AmericanExpress",
|
|
88
|
+
DinersClub = "DinersClub",
|
|
89
|
+
Discover = "Discover",
|
|
90
|
+
JCB = "JCB",
|
|
91
|
+
Maestro = "Maestro",
|
|
92
|
+
MasterCard = "MasterCard",
|
|
93
|
+
Switch = "Switch",
|
|
94
|
+
Visa = "Visa",
|
|
95
|
+
Unknown = "Unknown"
|
|
96
|
+
}
|
|
97
|
+
/** A model to hold the details of a request to verify a card. */
|
|
98
|
+
export declare class CardVerificationPaymentRequest {
|
|
99
|
+
/** An external reference supplied by the caller. */
|
|
100
|
+
yourReference?: string;
|
|
101
|
+
/** Information about the consumer who owns the card. */
|
|
102
|
+
consumer?: BasicConsumer;
|
|
103
|
+
/** A card token. */
|
|
104
|
+
token: string;
|
|
105
|
+
/** The CVV for the card. */
|
|
106
|
+
cvv?: string;
|
|
107
|
+
/** The card holders billing address. */
|
|
108
|
+
billingAddress?: Address;
|
|
109
|
+
/** Additional information about the owner of the card to facilitate the card payment. */
|
|
110
|
+
cardHolder?: CardHolder;
|
|
111
|
+
/** The location from which the payment request was submitted. */
|
|
112
|
+
location?: Location;
|
|
113
|
+
/** Web hook details to be used to call back to the initiator of the payment with progress updates. */
|
|
114
|
+
paymentStatusWebhook?: Webhook;
|
|
115
|
+
}
|
|
116
|
+
/** Contains the details of the bank account you would like to pay money into. */
|
|
117
|
+
export declare class BankAccountDestination {
|
|
118
|
+
/**
|
|
119
|
+
* A token that can be used instead of a bank account number.
|
|
120
|
+
* If a token is present a bank account does not need to be provided.
|
|
121
|
+
*/
|
|
122
|
+
token?: string;
|
|
123
|
+
/** The bank account number of the recipient. */
|
|
124
|
+
accountNumber: string;
|
|
125
|
+
/** The bank code of the bank that the account belongs to. */
|
|
126
|
+
bank: Bank;
|
|
127
|
+
notificationEmailAddress?: string;
|
|
128
|
+
notificationMobileNumber?: string;
|
|
129
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
130
|
+
description?: string;
|
|
131
|
+
/** The transaction amount, in cents. */
|
|
132
|
+
amountInCents: number;
|
|
133
|
+
/** The cashback amount, in cents. */
|
|
134
|
+
cashbackAmountInCents: number;
|
|
135
|
+
/** A 3 character ISO currency code. */
|
|
136
|
+
currency: Currency;
|
|
137
|
+
/** Set this optional flag to avoid actually processing a transaction. */
|
|
138
|
+
doNotProcess: boolean;
|
|
139
|
+
/**
|
|
140
|
+
* Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
|
|
141
|
+
* The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
|
|
142
|
+
* This flag can only be used with server integrations and will be ignored for any other calls.
|
|
143
|
+
* This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
|
|
144
|
+
*/
|
|
145
|
+
disableConfirmation: boolean;
|
|
146
|
+
/** A collection of public data that can be associated with the transaction. */
|
|
147
|
+
clientData: {
|
|
148
|
+
[key: string]: string;
|
|
149
|
+
};
|
|
150
|
+
/** A collection of all refund transaction requests that are associated with this transaction. */
|
|
151
|
+
refunds?: RefundTransaction[];
|
|
152
|
+
fees: TransactionFee[];
|
|
153
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
154
|
+
reference?: string;
|
|
155
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
156
|
+
shortReference?: string;
|
|
157
|
+
}
|
|
158
|
+
/** A model to hold the details of the result of an attempt to pay money into a bank account. */
|
|
159
|
+
export declare class BankAccountDestinationResult {
|
|
160
|
+
/** The bank account number of the recipient. */
|
|
161
|
+
accountNumber: string;
|
|
162
|
+
/** The bank that the recipient banks with as a 3 digit bank code. */
|
|
163
|
+
bank: Bank;
|
|
164
|
+
bankName: string;
|
|
165
|
+
accountHolder?: string;
|
|
166
|
+
/** A collection of the results of all refund transactions that are associated with the transaction that this result object refers to. */
|
|
167
|
+
refunds: RefundTransactionResult[];
|
|
168
|
+
/** The date and time this transaction record was created. */
|
|
169
|
+
createdDate: Date;
|
|
170
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
171
|
+
reference?: string;
|
|
172
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
173
|
+
shortReference?: string;
|
|
174
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
175
|
+
description?: string;
|
|
176
|
+
/** The original amount of the transaction, in cents, as submitted to the payment engine over the wire before Fees and Commissions are factored in. */
|
|
177
|
+
originalAmountInCents: number;
|
|
178
|
+
/** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
|
|
179
|
+
amountAttemptedInCents: number;
|
|
180
|
+
/**
|
|
181
|
+
* The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
|
|
182
|
+
* This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
|
|
183
|
+
*/
|
|
184
|
+
amountInCents: number;
|
|
185
|
+
/** The cashback amount, in cents. */
|
|
186
|
+
cashbackAmountInCents: number;
|
|
187
|
+
/** A collection of all fees applied to the transaction. */
|
|
188
|
+
fees: TransactionFee[];
|
|
189
|
+
/** A collection of metadata linked to this transaction. */
|
|
190
|
+
data: TransactionData[];
|
|
191
|
+
/** A 3 character ISO currency code. */
|
|
192
|
+
currency: Currency;
|
|
193
|
+
/** The current status of the transaction. */
|
|
194
|
+
status: TransactionStatus;
|
|
195
|
+
/** The category of the transaction. */
|
|
196
|
+
category: TransactionCategory;
|
|
197
|
+
/** A derived summary transaction status that groups transaction statuses into less granular sets to make it easier to quickly determine the general status of a transaction. */
|
|
198
|
+
summaryStatus: TransactionStatus;
|
|
199
|
+
isComplete: boolean;
|
|
200
|
+
isCashWithdrawal: boolean;
|
|
201
|
+
/** A message detailing the current status of the transaction. */
|
|
202
|
+
message: string;
|
|
203
|
+
}
|
|
204
|
+
/** A model to hold the details of a bill payment. */
|
|
205
|
+
export declare class BillDestination {
|
|
206
|
+
/** A globally unique product reference (UUID) that uniquely identifies a product that the system knows how to pay. */
|
|
207
|
+
productReference: string;
|
|
208
|
+
/** A dictionary of information related to the product referenced by <see cref="P:ZGA.Core.Models.Payments.BillDestination.ProductReference" />. */
|
|
209
|
+
productFields: {
|
|
210
|
+
[key: string]: string;
|
|
211
|
+
};
|
|
212
|
+
notificationEmailAddress?: string;
|
|
213
|
+
notificationMobileNumber?: string;
|
|
214
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
215
|
+
description?: string;
|
|
216
|
+
/** The transaction amount, in cents. */
|
|
217
|
+
amountInCents: number;
|
|
218
|
+
/** The cashback amount, in cents. */
|
|
219
|
+
cashbackAmountInCents: number;
|
|
220
|
+
/** A 3 character ISO currency code. */
|
|
221
|
+
currency: Currency;
|
|
222
|
+
/** Set this optional flag to avoid actually processing a transaction. */
|
|
223
|
+
doNotProcess: boolean;
|
|
224
|
+
/**
|
|
225
|
+
* Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
|
|
226
|
+
* The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
|
|
227
|
+
* This flag can only be used with server integrations and will be ignored for any other calls.
|
|
228
|
+
* This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
|
|
229
|
+
*/
|
|
230
|
+
disableConfirmation: boolean;
|
|
231
|
+
/** A collection of public data that can be associated with the transaction. */
|
|
232
|
+
clientData: {
|
|
233
|
+
[key: string]: string;
|
|
234
|
+
};
|
|
235
|
+
/** A collection of all refund transaction requests that are associated with this transaction. */
|
|
236
|
+
refunds?: RefundTransaction[];
|
|
237
|
+
fees: TransactionFee[];
|
|
238
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
239
|
+
reference?: string;
|
|
240
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
241
|
+
shortReference?: string;
|
|
242
|
+
}
|
|
243
|
+
/** A model to hold the result of an attempt to pay a bill. */
|
|
244
|
+
export declare class BillDestinationResult {
|
|
245
|
+
/** The name of the product that the system attempted to pay. */
|
|
246
|
+
productName?: string;
|
|
247
|
+
/** A globally unique product reference (UUID) that uniquely identifies a product that the system knows how to pay. */
|
|
248
|
+
productReference?: string;
|
|
249
|
+
accountHolder?: string;
|
|
250
|
+
/** A collection of the results of all refund transactions that are associated with the transaction that this result object refers to. */
|
|
251
|
+
refunds: RefundTransactionResult[];
|
|
252
|
+
/** The date and time this transaction record was created. */
|
|
253
|
+
createdDate: Date;
|
|
254
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
255
|
+
reference?: string;
|
|
256
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
257
|
+
shortReference?: string;
|
|
258
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
259
|
+
description?: string;
|
|
260
|
+
/** The original amount of the transaction, in cents, as submitted to the payment engine over the wire before Fees and Commissions are factored in. */
|
|
261
|
+
originalAmountInCents: number;
|
|
262
|
+
/** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
|
|
263
|
+
amountAttemptedInCents: number;
|
|
264
|
+
/**
|
|
265
|
+
* The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
|
|
266
|
+
* This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
|
|
267
|
+
*/
|
|
268
|
+
amountInCents: number;
|
|
269
|
+
/** The cashback amount, in cents. */
|
|
270
|
+
cashbackAmountInCents: number;
|
|
271
|
+
/** A collection of all fees applied to the transaction. */
|
|
272
|
+
fees: TransactionFee[];
|
|
273
|
+
/** A collection of metadata linked to this transaction. */
|
|
274
|
+
data: TransactionData[];
|
|
275
|
+
/** A 3 character ISO currency code. */
|
|
276
|
+
currency: Currency;
|
|
277
|
+
/** The current status of the transaction. */
|
|
278
|
+
status: TransactionStatus;
|
|
279
|
+
/** The category of the transaction. */
|
|
280
|
+
category: TransactionCategory;
|
|
281
|
+
/** A derived summary transaction status that groups transaction statuses into less granular sets to make it easier to quickly determine the general status of a transaction. */
|
|
282
|
+
summaryStatus: TransactionStatus;
|
|
283
|
+
isComplete: boolean;
|
|
284
|
+
isCashWithdrawal: boolean;
|
|
285
|
+
/** A message detailing the current status of the transaction. */
|
|
286
|
+
message: string;
|
|
287
|
+
}
|
|
288
|
+
/** Model to hold details of a card into which a payment should be made. */
|
|
289
|
+
export declare class CardDestination {
|
|
290
|
+
/**
|
|
291
|
+
* A token that can be used instead of a card number.
|
|
292
|
+
* If a token is present a card does not need to be provided.
|
|
293
|
+
*/
|
|
294
|
+
token?: string;
|
|
295
|
+
/** The full card number. */
|
|
296
|
+
cardNumber: string;
|
|
297
|
+
notificationEmailAddress?: string;
|
|
298
|
+
notificationMobileNumber?: string;
|
|
299
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
300
|
+
description?: string;
|
|
301
|
+
/** The transaction amount, in cents. */
|
|
302
|
+
amountInCents: number;
|
|
303
|
+
/** The cashback amount, in cents. */
|
|
304
|
+
cashbackAmountInCents: number;
|
|
305
|
+
/** A 3 character ISO currency code. */
|
|
306
|
+
currency: Currency;
|
|
307
|
+
/** Set this optional flag to avoid actually processing a transaction. */
|
|
308
|
+
doNotProcess: boolean;
|
|
309
|
+
/**
|
|
310
|
+
* Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
|
|
311
|
+
* The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
|
|
312
|
+
* This flag can only be used with server integrations and will be ignored for any other calls.
|
|
313
|
+
* This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
|
|
314
|
+
*/
|
|
315
|
+
disableConfirmation: boolean;
|
|
316
|
+
/** A collection of public data that can be associated with the transaction. */
|
|
317
|
+
clientData: {
|
|
318
|
+
[key: string]: string;
|
|
319
|
+
};
|
|
320
|
+
/** A collection of all refund transaction requests that are associated with this transaction. */
|
|
321
|
+
refunds?: RefundTransaction[];
|
|
322
|
+
fees: TransactionFee[];
|
|
323
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
324
|
+
reference?: string;
|
|
325
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
326
|
+
shortReference?: string;
|
|
327
|
+
}
|
|
328
|
+
export declare class CardDestinationResult {
|
|
329
|
+
cardIssuer: string;
|
|
330
|
+
cardIssuerCountryIsoCode?: Country;
|
|
331
|
+
cardNumber: string;
|
|
332
|
+
threeDSecureUrl?: string;
|
|
333
|
+
/** A collection of the results of all refund transactions that are associated with the transaction that this result object refers to. */
|
|
334
|
+
refunds: RefundTransactionResult[];
|
|
335
|
+
/** The date and time this transaction record was created. */
|
|
336
|
+
createdDate: Date;
|
|
337
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
338
|
+
reference?: string;
|
|
339
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
340
|
+
shortReference?: string;
|
|
341
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
342
|
+
description?: string;
|
|
343
|
+
/** The original amount of the transaction, in cents, as submitted to the payment engine over the wire before Fees and Commissions are factored in. */
|
|
344
|
+
originalAmountInCents: number;
|
|
345
|
+
/** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
|
|
346
|
+
amountAttemptedInCents: number;
|
|
347
|
+
/**
|
|
348
|
+
* The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
|
|
349
|
+
* This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
|
|
350
|
+
*/
|
|
351
|
+
amountInCents: number;
|
|
352
|
+
/** The cashback amount, in cents. */
|
|
353
|
+
cashbackAmountInCents: number;
|
|
354
|
+
/** A collection of all fees applied to the transaction. */
|
|
355
|
+
fees: TransactionFee[];
|
|
356
|
+
/** A collection of metadata linked to this transaction. */
|
|
357
|
+
data: TransactionData[];
|
|
358
|
+
/** A 3 character ISO currency code. */
|
|
359
|
+
currency: Currency;
|
|
360
|
+
/** The current status of the transaction. */
|
|
361
|
+
status: TransactionStatus;
|
|
362
|
+
/** The category of the transaction. */
|
|
363
|
+
category: TransactionCategory;
|
|
364
|
+
/** A derived summary transaction status that groups transaction statuses into less granular sets to make it easier to quickly determine the general status of a transaction. */
|
|
365
|
+
summaryStatus: TransactionStatus;
|
|
366
|
+
isComplete: boolean;
|
|
367
|
+
isCashWithdrawal: boolean;
|
|
368
|
+
/** A message detailing the current status of the transaction. */
|
|
369
|
+
message: string;
|
|
370
|
+
}
|
|
371
|
+
export declare class CashDestination {
|
|
372
|
+
doNotProcess: boolean;
|
|
373
|
+
notificationEmailAddress?: string;
|
|
374
|
+
notificationMobileNumber?: string;
|
|
375
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
376
|
+
description?: string;
|
|
377
|
+
/** The transaction amount, in cents. */
|
|
378
|
+
amountInCents: number;
|
|
379
|
+
/** The cashback amount, in cents. */
|
|
380
|
+
cashbackAmountInCents: number;
|
|
381
|
+
/** A 3 character ISO currency code. */
|
|
382
|
+
currency: Currency;
|
|
383
|
+
/**
|
|
384
|
+
* Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
|
|
385
|
+
* The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
|
|
386
|
+
* This flag can only be used with server integrations and will be ignored for any other calls.
|
|
387
|
+
* This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
|
|
388
|
+
*/
|
|
389
|
+
disableConfirmation: boolean;
|
|
390
|
+
/** A collection of public data that can be associated with the transaction. */
|
|
391
|
+
clientData: {
|
|
392
|
+
[key: string]: string;
|
|
393
|
+
};
|
|
394
|
+
/** A collection of all refund transaction requests that are associated with this transaction. */
|
|
395
|
+
refunds?: RefundTransaction[];
|
|
396
|
+
fees: TransactionFee[];
|
|
397
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
398
|
+
reference?: string;
|
|
399
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
400
|
+
shortReference?: string;
|
|
401
|
+
}
|
|
402
|
+
export declare class CashDestinationResult {
|
|
403
|
+
/** A collection of the results of all refund transactions that are associated with the transaction that this result object refers to. */
|
|
404
|
+
refunds: RefundTransactionResult[];
|
|
405
|
+
/** The date and time this transaction record was created. */
|
|
406
|
+
createdDate: Date;
|
|
407
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
408
|
+
reference?: string;
|
|
409
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
410
|
+
shortReference?: string;
|
|
411
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
412
|
+
description?: string;
|
|
413
|
+
/** The original amount of the transaction, in cents, as submitted to the payment engine over the wire before Fees and Commissions are factored in. */
|
|
414
|
+
originalAmountInCents: number;
|
|
415
|
+
/** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
|
|
416
|
+
amountAttemptedInCents: number;
|
|
417
|
+
/**
|
|
418
|
+
* The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
|
|
419
|
+
* This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
|
|
420
|
+
*/
|
|
421
|
+
amountInCents: number;
|
|
422
|
+
/** The cashback amount, in cents. */
|
|
423
|
+
cashbackAmountInCents: number;
|
|
424
|
+
/** A collection of all fees applied to the transaction. */
|
|
425
|
+
fees: TransactionFee[];
|
|
426
|
+
/** A collection of metadata linked to this transaction. */
|
|
427
|
+
data: TransactionData[];
|
|
428
|
+
/** A 3 character ISO currency code. */
|
|
429
|
+
currency: Currency;
|
|
430
|
+
/** The current status of the transaction. */
|
|
431
|
+
status: TransactionStatus;
|
|
432
|
+
/** The category of the transaction. */
|
|
433
|
+
category: TransactionCategory;
|
|
434
|
+
/** A derived summary transaction status that groups transaction statuses into less granular sets to make it easier to quickly determine the general status of a transaction. */
|
|
435
|
+
summaryStatus: TransactionStatus;
|
|
436
|
+
isComplete: boolean;
|
|
437
|
+
isCashWithdrawal: boolean;
|
|
438
|
+
/** A message detailing the current status of the transaction. */
|
|
439
|
+
message: string;
|
|
440
|
+
}
|
|
441
|
+
export declare class GenericDestination {
|
|
442
|
+
notificationEmailAddress?: string;
|
|
443
|
+
notificationMobileNumber?: string;
|
|
444
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
445
|
+
description?: string;
|
|
446
|
+
/** The transaction amount, in cents. */
|
|
447
|
+
amountInCents: number;
|
|
448
|
+
/** The cashback amount, in cents. */
|
|
449
|
+
cashbackAmountInCents: number;
|
|
450
|
+
/** A 3 character ISO currency code. */
|
|
451
|
+
currency: Currency;
|
|
452
|
+
/**
|
|
453
|
+
* Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
|
|
454
|
+
* The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
|
|
455
|
+
* This flag can only be used with server integrations and will be ignored for any other calls.
|
|
456
|
+
* This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
|
|
457
|
+
*/
|
|
458
|
+
disableConfirmation: boolean;
|
|
459
|
+
/** A collection of public data that can be associated with the transaction. */
|
|
460
|
+
clientData: {
|
|
461
|
+
[key: string]: string;
|
|
462
|
+
};
|
|
463
|
+
/** A collection of all refund transaction requests that are associated with this transaction. */
|
|
464
|
+
refunds?: RefundTransaction[];
|
|
465
|
+
fees: TransactionFee[];
|
|
466
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
467
|
+
reference?: string;
|
|
468
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
469
|
+
shortReference?: string;
|
|
470
|
+
}
|
|
471
|
+
/** Model to hold the details of a merchant who should be paid. */
|
|
472
|
+
export declare class MerchantDestination {
|
|
473
|
+
/** A unique merchant identifier. */
|
|
474
|
+
merchantReference?: string;
|
|
475
|
+
merchantSource?: string;
|
|
476
|
+
terminalReference?: string;
|
|
477
|
+
qrCodeReference?: string;
|
|
478
|
+
paymentType: MerchantPaymentType;
|
|
479
|
+
tipAmountInCents: number;
|
|
480
|
+
tipEmployeeReference?: string;
|
|
481
|
+
notificationEmailAddress?: string;
|
|
482
|
+
notificationMobileNumber?: string;
|
|
483
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
484
|
+
description?: string;
|
|
485
|
+
/** The transaction amount, in cents. */
|
|
486
|
+
amountInCents: number;
|
|
487
|
+
/** The cashback amount, in cents. */
|
|
488
|
+
cashbackAmountInCents: number;
|
|
489
|
+
/** A 3 character ISO currency code. */
|
|
490
|
+
currency: Currency;
|
|
491
|
+
/** Set this optional flag to avoid actually processing a transaction. */
|
|
492
|
+
doNotProcess: boolean;
|
|
493
|
+
/**
|
|
494
|
+
* Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
|
|
495
|
+
* The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
|
|
496
|
+
* This flag can only be used with server integrations and will be ignored for any other calls.
|
|
497
|
+
* This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
|
|
498
|
+
*/
|
|
499
|
+
disableConfirmation: boolean;
|
|
500
|
+
/** A collection of public data that can be associated with the transaction. */
|
|
501
|
+
clientData: {
|
|
502
|
+
[key: string]: string;
|
|
503
|
+
};
|
|
504
|
+
/** A collection of all refund transaction requests that are associated with this transaction. */
|
|
505
|
+
refunds?: RefundTransaction[];
|
|
506
|
+
fees: TransactionFee[];
|
|
507
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
508
|
+
reference?: string;
|
|
509
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
510
|
+
shortReference?: string;
|
|
511
|
+
}
|
|
512
|
+
export declare class MerchantDestinationResult {
|
|
513
|
+
merchantReference: string;
|
|
514
|
+
terminalReference?: string;
|
|
515
|
+
qrCodeReference?: string;
|
|
516
|
+
tipAmountInCents: number;
|
|
517
|
+
tipEmployeeReference?: string;
|
|
518
|
+
accountHolder?: string;
|
|
519
|
+
/** A collection of the results of all refund transactions that are associated with the transaction that this result object refers to. */
|
|
520
|
+
refunds: RefundTransactionResult[];
|
|
521
|
+
/** The date and time this transaction record was created. */
|
|
522
|
+
createdDate: Date;
|
|
523
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
524
|
+
reference?: string;
|
|
525
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
526
|
+
shortReference?: string;
|
|
527
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
528
|
+
description?: string;
|
|
529
|
+
/** The original amount of the transaction, in cents, as submitted to the payment engine over the wire before Fees and Commissions are factored in. */
|
|
530
|
+
originalAmountInCents: number;
|
|
531
|
+
/** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
|
|
532
|
+
amountAttemptedInCents: number;
|
|
533
|
+
/**
|
|
534
|
+
* The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
|
|
535
|
+
* This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
|
|
536
|
+
*/
|
|
537
|
+
amountInCents: number;
|
|
538
|
+
/** The cashback amount, in cents. */
|
|
539
|
+
cashbackAmountInCents: number;
|
|
540
|
+
/** A collection of all fees applied to the transaction. */
|
|
541
|
+
fees: TransactionFee[];
|
|
542
|
+
/** A collection of metadata linked to this transaction. */
|
|
543
|
+
data: TransactionData[];
|
|
544
|
+
/** A 3 character ISO currency code. */
|
|
545
|
+
currency: Currency;
|
|
546
|
+
/** The current status of the transaction. */
|
|
547
|
+
status: TransactionStatus;
|
|
548
|
+
/** The category of the transaction. */
|
|
549
|
+
category: TransactionCategory;
|
|
550
|
+
/** A derived summary transaction status that groups transaction statuses into less granular sets to make it easier to quickly determine the general status of a transaction. */
|
|
551
|
+
summaryStatus: TransactionStatus;
|
|
552
|
+
isComplete: boolean;
|
|
553
|
+
isCashWithdrawal: boolean;
|
|
554
|
+
/** A message detailing the current status of the transaction. */
|
|
555
|
+
message: string;
|
|
556
|
+
}
|
|
557
|
+
/** Contains the details of the mobile money account you would like to make a payment into. */
|
|
558
|
+
export declare class MobileWalletDestination {
|
|
559
|
+
/**
|
|
560
|
+
* Mobile Station International Subscriber Directory Number (MSISDN) is a number used to identify a mobile phone number internationally.
|
|
561
|
+
* This number includes a country code and a National Destination Code which identifies the subscriber's operator.
|
|
562
|
+
*/
|
|
563
|
+
msisdn: string;
|
|
564
|
+
/** The mobile wallet operator that owns the mobile money account. */
|
|
565
|
+
mobileWalletOperator: MobileWalletOperator;
|
|
566
|
+
notificationEmailAddress?: string;
|
|
567
|
+
notificationMobileNumber?: string;
|
|
568
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
569
|
+
description?: string;
|
|
570
|
+
/** The transaction amount, in cents. */
|
|
571
|
+
amountInCents: number;
|
|
572
|
+
/** The cashback amount, in cents. */
|
|
573
|
+
cashbackAmountInCents: number;
|
|
574
|
+
/** A 3 character ISO currency code. */
|
|
575
|
+
currency: Currency;
|
|
576
|
+
/** Set this optional flag to avoid actually processing a transaction. */
|
|
577
|
+
doNotProcess: boolean;
|
|
578
|
+
/**
|
|
579
|
+
* Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
|
|
580
|
+
* The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
|
|
581
|
+
* This flag can only be used with server integrations and will be ignored for any other calls.
|
|
582
|
+
* This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
|
|
583
|
+
*/
|
|
584
|
+
disableConfirmation: boolean;
|
|
585
|
+
/** A collection of public data that can be associated with the transaction. */
|
|
586
|
+
clientData: {
|
|
587
|
+
[key: string]: string;
|
|
588
|
+
};
|
|
589
|
+
/** A collection of all refund transaction requests that are associated with this transaction. */
|
|
590
|
+
refunds?: RefundTransaction[];
|
|
591
|
+
fees: TransactionFee[];
|
|
592
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
593
|
+
reference?: string;
|
|
594
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
595
|
+
shortReference?: string;
|
|
596
|
+
}
|
|
597
|
+
export declare class MobileWalletDestinationResult {
|
|
598
|
+
mobileWalletOperator: MobileWalletOperator;
|
|
599
|
+
mobileWalletOperatorName: string;
|
|
600
|
+
msisdn: string;
|
|
601
|
+
accountHolder?: string;
|
|
602
|
+
/** A collection of the results of all refund transactions that are associated with the transaction that this result object refers to. */
|
|
603
|
+
refunds: RefundTransactionResult[];
|
|
604
|
+
/** The date and time this transaction record was created. */
|
|
605
|
+
createdDate: Date;
|
|
606
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
607
|
+
reference?: string;
|
|
608
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
609
|
+
shortReference?: string;
|
|
610
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
611
|
+
description?: string;
|
|
612
|
+
/** The original amount of the transaction, in cents, as submitted to the payment engine over the wire before Fees and Commissions are factored in. */
|
|
613
|
+
originalAmountInCents: number;
|
|
614
|
+
/** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
|
|
615
|
+
amountAttemptedInCents: number;
|
|
616
|
+
/**
|
|
617
|
+
* The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
|
|
618
|
+
* This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
|
|
619
|
+
*/
|
|
620
|
+
amountInCents: number;
|
|
621
|
+
/** The cashback amount, in cents. */
|
|
622
|
+
cashbackAmountInCents: number;
|
|
623
|
+
/** A collection of all fees applied to the transaction. */
|
|
624
|
+
fees: TransactionFee[];
|
|
625
|
+
/** A collection of metadata linked to this transaction. */
|
|
626
|
+
data: TransactionData[];
|
|
627
|
+
/** A 3 character ISO currency code. */
|
|
628
|
+
currency: Currency;
|
|
629
|
+
/** The current status of the transaction. */
|
|
630
|
+
status: TransactionStatus;
|
|
631
|
+
/** The category of the transaction. */
|
|
632
|
+
category: TransactionCategory;
|
|
633
|
+
/** A derived summary transaction status that groups transaction statuses into less granular sets to make it easier to quickly determine the general status of a transaction. */
|
|
634
|
+
summaryStatus: TransactionStatus;
|
|
635
|
+
isComplete: boolean;
|
|
636
|
+
isCashWithdrawal: boolean;
|
|
637
|
+
/** A message detailing the current status of the transaction. */
|
|
638
|
+
message: string;
|
|
639
|
+
}
|
|
640
|
+
export declare class PaymentDestinationResults {
|
|
641
|
+
merchants: MerchantDestinationResult[];
|
|
642
|
+
mobileWallets: MobileWalletDestinationResult[];
|
|
643
|
+
bankAccounts: BankAccountDestinationResult[];
|
|
644
|
+
qrCodes: QrCodeDestinationResult[];
|
|
645
|
+
cards: CardDestinationResult[];
|
|
646
|
+
wallets: WalletDestinationResult[];
|
|
647
|
+
bills: BillDestinationResult[];
|
|
648
|
+
cash?: CashDestinationResult;
|
|
649
|
+
}
|
|
650
|
+
/** Model to hold lists of Merchants who must be paid. */
|
|
651
|
+
export declare class PaymentDestinations {
|
|
652
|
+
generic?: GenericDestination;
|
|
653
|
+
/** A list of merchants who must be paid. */
|
|
654
|
+
merchants?: MerchantDestination[];
|
|
655
|
+
/** A list of mobile money/wallet accounts to be paid. */
|
|
656
|
+
mobileWallets?: MobileWalletDestination[];
|
|
657
|
+
/** A list of bank accounts to be paid. */
|
|
658
|
+
bankAccounts?: BankAccountDestination[];
|
|
659
|
+
/** A list of QR Codes containing payment destination details and any additional information related to each QR Code. */
|
|
660
|
+
qrCodes?: QrCodeDestination[];
|
|
661
|
+
/** A list of credit cards to be paid. */
|
|
662
|
+
cards?: CardDestination[];
|
|
663
|
+
/** A list of generic digital wallets to be paid. */
|
|
664
|
+
wallets?: WalletDestination[];
|
|
665
|
+
/** A list of bills/products to pay. */
|
|
666
|
+
bills?: BillDestination[];
|
|
667
|
+
/** Details of a payment that will be made as cash. */
|
|
668
|
+
cash?: CashDestination;
|
|
669
|
+
}
|
|
670
|
+
/** Model to hold details of a payment being made with a QR Code providing the destination details. */
|
|
671
|
+
export declare class QrCodeDestination {
|
|
672
|
+
/** The QR Code data as a string. */
|
|
673
|
+
qrCode: string;
|
|
674
|
+
/** An optional list of values that the client prompted the user for because the QR Code instructed it to. The values that could be provided are defined in the relevant QR Code specifications. */
|
|
675
|
+
additionalInfo?: {
|
|
676
|
+
[key: string]: string;
|
|
677
|
+
};
|
|
678
|
+
tipAmountInCents: number;
|
|
679
|
+
notificationEmailAddress?: string;
|
|
680
|
+
notificationMobileNumber?: string;
|
|
681
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
682
|
+
description?: string;
|
|
683
|
+
/** The transaction amount, in cents. */
|
|
684
|
+
amountInCents: number;
|
|
685
|
+
/** The cashback amount, in cents. */
|
|
686
|
+
cashbackAmountInCents: number;
|
|
687
|
+
/** A 3 character ISO currency code. */
|
|
688
|
+
currency: Currency;
|
|
689
|
+
/** Set this optional flag to avoid actually processing a transaction. */
|
|
690
|
+
doNotProcess: boolean;
|
|
691
|
+
/**
|
|
692
|
+
* Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
|
|
693
|
+
* The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
|
|
694
|
+
* This flag can only be used with server integrations and will be ignored for any other calls.
|
|
695
|
+
* This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
|
|
696
|
+
*/
|
|
697
|
+
disableConfirmation: boolean;
|
|
698
|
+
/** A collection of public data that can be associated with the transaction. */
|
|
699
|
+
clientData: {
|
|
700
|
+
[key: string]: string;
|
|
701
|
+
};
|
|
702
|
+
/** A collection of all refund transaction requests that are associated with this transaction. */
|
|
703
|
+
refunds?: RefundTransaction[];
|
|
704
|
+
fees: TransactionFee[];
|
|
705
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
706
|
+
reference?: string;
|
|
707
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
708
|
+
shortReference?: string;
|
|
709
|
+
}
|
|
710
|
+
export declare class QrCodeDestinationResult {
|
|
711
|
+
/** The QR Code data as a string. */
|
|
712
|
+
qrCode: string;
|
|
713
|
+
merchantReference: string;
|
|
714
|
+
billReference?: string;
|
|
715
|
+
tipAmountInCents: number;
|
|
716
|
+
accountHolder?: string;
|
|
717
|
+
/** A collection of the results of all refund transactions that are associated with the transaction that this result object refers to. */
|
|
718
|
+
refunds: RefundTransactionResult[];
|
|
719
|
+
/** The date and time this transaction record was created. */
|
|
720
|
+
createdDate: Date;
|
|
721
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
722
|
+
reference?: string;
|
|
723
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
724
|
+
shortReference?: string;
|
|
725
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
726
|
+
description?: string;
|
|
727
|
+
/** The original amount of the transaction, in cents, as submitted to the payment engine over the wire before Fees and Commissions are factored in. */
|
|
728
|
+
originalAmountInCents: number;
|
|
729
|
+
/** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
|
|
730
|
+
amountAttemptedInCents: number;
|
|
731
|
+
/**
|
|
732
|
+
* The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
|
|
733
|
+
* This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
|
|
734
|
+
*/
|
|
735
|
+
amountInCents: number;
|
|
736
|
+
/** The cashback amount, in cents. */
|
|
737
|
+
cashbackAmountInCents: number;
|
|
738
|
+
/** A collection of all fees applied to the transaction. */
|
|
739
|
+
fees: TransactionFee[];
|
|
740
|
+
/** A collection of metadata linked to this transaction. */
|
|
741
|
+
data: TransactionData[];
|
|
742
|
+
/** A 3 character ISO currency code. */
|
|
743
|
+
currency: Currency;
|
|
744
|
+
/** The current status of the transaction. */
|
|
745
|
+
status: TransactionStatus;
|
|
746
|
+
/** The category of the transaction. */
|
|
747
|
+
category: TransactionCategory;
|
|
748
|
+
/** A derived summary transaction status that groups transaction statuses into less granular sets to make it easier to quickly determine the general status of a transaction. */
|
|
749
|
+
summaryStatus: TransactionStatus;
|
|
750
|
+
isComplete: boolean;
|
|
751
|
+
isCashWithdrawal: boolean;
|
|
752
|
+
/** A message detailing the current status of the transaction. */
|
|
753
|
+
message: string;
|
|
754
|
+
}
|
|
755
|
+
/** Model to hold the details of a generic digital wallet. */
|
|
756
|
+
export declare class WalletDestination {
|
|
757
|
+
/** A unique wallet identifier. */
|
|
758
|
+
walletReference: string;
|
|
759
|
+
/** The wallet provider that created and manages the wallet. */
|
|
760
|
+
walletProvider: string;
|
|
761
|
+
/** The wallet provider that created and manages the wallet. */
|
|
762
|
+
walletSource: string;
|
|
763
|
+
notificationEmailAddress?: string;
|
|
764
|
+
notificationMobileNumber?: string;
|
|
765
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
766
|
+
description?: string;
|
|
767
|
+
/** The transaction amount, in cents. */
|
|
768
|
+
amountInCents: number;
|
|
769
|
+
/** The cashback amount, in cents. */
|
|
770
|
+
cashbackAmountInCents: number;
|
|
771
|
+
/** A 3 character ISO currency code. */
|
|
772
|
+
currency: Currency;
|
|
773
|
+
/** Set this optional flag to avoid actually processing a transaction. */
|
|
774
|
+
doNotProcess: boolean;
|
|
775
|
+
/**
|
|
776
|
+
* Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
|
|
777
|
+
* The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
|
|
778
|
+
* This flag can only be used with server integrations and will be ignored for any other calls.
|
|
779
|
+
* This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
|
|
780
|
+
*/
|
|
781
|
+
disableConfirmation: boolean;
|
|
782
|
+
/** A collection of public data that can be associated with the transaction. */
|
|
783
|
+
clientData: {
|
|
784
|
+
[key: string]: string;
|
|
785
|
+
};
|
|
786
|
+
/** A collection of all refund transaction requests that are associated with this transaction. */
|
|
787
|
+
refunds?: RefundTransaction[];
|
|
788
|
+
fees: TransactionFee[];
|
|
789
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
790
|
+
reference?: string;
|
|
791
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
792
|
+
shortReference?: string;
|
|
793
|
+
}
|
|
794
|
+
export declare class WalletDestinationResult {
|
|
795
|
+
walletReference: string;
|
|
796
|
+
walletProvider: string;
|
|
797
|
+
walletSource: string;
|
|
798
|
+
/** A collection of the results of all refund transactions that are associated with the transaction that this result object refers to. */
|
|
799
|
+
refunds: RefundTransactionResult[];
|
|
800
|
+
/** The date and time this transaction record was created. */
|
|
801
|
+
createdDate: Date;
|
|
802
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
803
|
+
reference?: string;
|
|
804
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
805
|
+
shortReference?: string;
|
|
806
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
807
|
+
description?: string;
|
|
808
|
+
/** The original amount of the transaction, in cents, as submitted to the payment engine over the wire before Fees and Commissions are factored in. */
|
|
809
|
+
originalAmountInCents: number;
|
|
810
|
+
/** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
|
|
811
|
+
amountAttemptedInCents: number;
|
|
812
|
+
/**
|
|
813
|
+
* The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
|
|
814
|
+
* This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
|
|
815
|
+
*/
|
|
816
|
+
amountInCents: number;
|
|
817
|
+
/** The cashback amount, in cents. */
|
|
818
|
+
cashbackAmountInCents: number;
|
|
819
|
+
/** A collection of all fees applied to the transaction. */
|
|
820
|
+
fees: TransactionFee[];
|
|
821
|
+
/** A collection of metadata linked to this transaction. */
|
|
822
|
+
data: TransactionData[];
|
|
823
|
+
/** A 3 character ISO currency code. */
|
|
824
|
+
currency: Currency;
|
|
825
|
+
/** The current status of the transaction. */
|
|
826
|
+
status: TransactionStatus;
|
|
827
|
+
/** The category of the transaction. */
|
|
828
|
+
category: TransactionCategory;
|
|
829
|
+
/** A derived summary transaction status that groups transaction statuses into less granular sets to make it easier to quickly determine the general status of a transaction. */
|
|
830
|
+
summaryStatus: TransactionStatus;
|
|
831
|
+
isComplete: boolean;
|
|
832
|
+
isCashWithdrawal: boolean;
|
|
833
|
+
/** A message detailing the current status of the transaction. */
|
|
834
|
+
message: string;
|
|
835
|
+
}
|
|
836
|
+
export declare enum FeeType {
|
|
837
|
+
None = "None",
|
|
838
|
+
/**
|
|
839
|
+
* A real-time commission that is deducted from the amount we are instructed to debit from a source account so that the amount we actually
|
|
840
|
+
* debit is less the commission to be paid to the account holder being debited and the commission is therefore effectively paid in real-time.
|
|
841
|
+
*/
|
|
842
|
+
FeeTakenFromSourceByMerchant = "FeeTakenFromSourceByMerchant",
|
|
843
|
+
Elevy = "Elevy",
|
|
844
|
+
/** A processing fee charged by the external payment processor that we used to process the payment, that is charged to us, and is not charged to the end user. */
|
|
845
|
+
ExternalPaymentProcessorFee = "ExternalPaymentProcessorFee",
|
|
846
|
+
ExternallyProcessedElevy = "ExternallyProcessedElevy",
|
|
847
|
+
InternalUserTransactionFee = "InternalUserTransactionFee",
|
|
848
|
+
ExternalUserTransactionFee = "ExternalUserTransactionFee",
|
|
849
|
+
/** A processing fee charged by us for processing a transaction, that is charged to the 3rd party using our payment engine to process transactions, and is not charged to the end user. */
|
|
850
|
+
InternalPaymentProcessorFee = "InternalPaymentProcessorFee"
|
|
851
|
+
}
|
|
852
|
+
export declare class LineItem {
|
|
853
|
+
reference: string;
|
|
854
|
+
name: string;
|
|
855
|
+
description?: string;
|
|
856
|
+
quantity: number;
|
|
857
|
+
currency: Currency;
|
|
858
|
+
unitAmountInCents: number;
|
|
859
|
+
totalAmountInCents: number;
|
|
860
|
+
}
|
|
861
|
+
export declare class MerchantPaymentResponse {
|
|
862
|
+
/** An optional access token that can be used to check the status of the transaction or perform any action required to unblock transaction processing. */
|
|
863
|
+
accessToken?: string;
|
|
864
|
+
/** A globally unique payment reference (UUID) that can be used to check the status of the payment. */
|
|
865
|
+
reference: string;
|
|
866
|
+
/** A set of URLs that can be used to check the status of a payment either via polling or SignalR. */
|
|
867
|
+
paymentStatusUrls: StatusUrls;
|
|
868
|
+
}
|
|
869
|
+
export declare enum MerchantPaymentType {
|
|
870
|
+
Unspecified = "Unspecified",
|
|
871
|
+
CashOut = "CashOut",
|
|
872
|
+
BuyingGoods = "BuyingGoods",
|
|
873
|
+
BillPayment = "BillPayment",
|
|
874
|
+
GhIPSSQrCode = "GhIPSSQrCode"
|
|
875
|
+
}
|
|
876
|
+
export declare class MerchantRefundRequest {
|
|
877
|
+
language?: string;
|
|
878
|
+
timeZone?: string;
|
|
879
|
+
description?: string;
|
|
880
|
+
transactionBatchReference?: string;
|
|
881
|
+
refundCategory: TransactionCategory;
|
|
882
|
+
/** A collection of public data that can be associated with the transaction. */
|
|
883
|
+
clientData: {
|
|
884
|
+
[key: string]: string;
|
|
885
|
+
};
|
|
886
|
+
refundAmountInCents: number;
|
|
887
|
+
}
|
|
888
|
+
export declare class PaymentReceiptResponse {
|
|
889
|
+
lineItems: LineItem[];
|
|
890
|
+
isComplete: boolean;
|
|
891
|
+
/** The percentage of transactions that have been completed so far, expressed as a percentage of the total number of both source and destination transactions associated with the payment. */
|
|
892
|
+
percentageComplete: number;
|
|
893
|
+
/** The date the payment was started. */
|
|
894
|
+
paymentStartedDate: Date;
|
|
895
|
+
/** The date the payment was completed. */
|
|
896
|
+
paymentCompletedDate?: Date;
|
|
897
|
+
/** The optional external reference that was supplied in the initial payment request, if it was supplied. */
|
|
898
|
+
yourReference?: string;
|
|
899
|
+
/** The transaction batch description/reference that can appear in notifications and statements. */
|
|
900
|
+
description?: string;
|
|
901
|
+
/**
|
|
902
|
+
* A globally unique payment reference (UUID) that was generated when the initial payment request was submitted.
|
|
903
|
+
* <para>
|
|
904
|
+
* This reference is returned in the response to that initial payment request.
|
|
905
|
+
* </para>
|
|
906
|
+
*/
|
|
907
|
+
paymentReference: string;
|
|
908
|
+
/** A short unique payment reference based on the payment ID. */
|
|
909
|
+
shortPaymentReference: string;
|
|
910
|
+
/**
|
|
911
|
+
* An optional reference that is associated with every transaction batch that participates in a split payment.
|
|
912
|
+
* This is used for split payments in environments like restaurants where multiple transaction batches contribute to one common bill.
|
|
913
|
+
* The client processing the split payment is responsible for generating this reference and ensuring that
|
|
914
|
+
* all transaction batches that are part of the split payment are associated with the same split reference.
|
|
915
|
+
*/
|
|
916
|
+
splitReference?: string;
|
|
917
|
+
/** A verification code that can be used to validate that an external payment was triggered by a trusted device (used for offline payments for example). */
|
|
918
|
+
verificationCode: string;
|
|
919
|
+
/** Specify the channel that this payment originated from. */
|
|
920
|
+
channel: Channel;
|
|
921
|
+
/** The consumer reference of the consumer who made the payment. */
|
|
922
|
+
consumerReference?: string;
|
|
923
|
+
/** Optional details of the consumer who made the payment. */
|
|
924
|
+
consumer?: BasicConsumer;
|
|
925
|
+
/** A <see cref="T:ZGA.Core.Models.Payments.PaymentSourceResults" /> object containing all of the payment sources associated with the payment and several aggregated values related to those sources. */
|
|
926
|
+
paymentSources?: PaymentSourceResults;
|
|
927
|
+
/** A <see cref="T:ZGA.Core.Models.Payments.PaymentDestinationResults" /> object containing all of the payment destinations associated with the payment and several aggregated values related to those sources. */
|
|
928
|
+
paymentDestinations?: PaymentDestinationResults;
|
|
929
|
+
/** Transaction amount totals that summarize the overall payment amounts, fees and commissions associated with the payment. */
|
|
930
|
+
amountTotals: AmountTotals;
|
|
931
|
+
timeZone?: string;
|
|
932
|
+
}
|
|
933
|
+
export declare class PaymentRecurrenceSchedule {
|
|
934
|
+
reference: string;
|
|
935
|
+
createdDate: Date;
|
|
936
|
+
repeatInterval: RepeatInterval;
|
|
937
|
+
scheduleEndDate?: Date;
|
|
938
|
+
repeatCount?: number;
|
|
939
|
+
entries: PaymentRecurrenceScheduleEntry[];
|
|
940
|
+
}
|
|
941
|
+
export declare class PaymentRecurrenceScheduleEntry {
|
|
942
|
+
scheduledDate: Date;
|
|
943
|
+
isCancelled: boolean;
|
|
944
|
+
transactionBatchReference?: string;
|
|
945
|
+
isProcessed: boolean;
|
|
946
|
+
}
|
|
947
|
+
/** Model to hold details of a response to a payment request. */
|
|
948
|
+
export declare class PaymentResponse {
|
|
949
|
+
/** A globally unique payment reference (UUID) that can be used to check the status of the payment. */
|
|
950
|
+
reference: string;
|
|
951
|
+
/** A set of URLs that can be used to check the status of a payment either via polling or SignalR. */
|
|
952
|
+
paymentStatusUrls: StatusUrls;
|
|
953
|
+
}
|
|
954
|
+
/** A model to hold the details of a payment request, including the current status of all associated transactions and the overall payment itself. */
|
|
955
|
+
export declare class PaymentStatusResponse {
|
|
956
|
+
isComplete: boolean;
|
|
957
|
+
/** The percentage of transactions that have been completed so far, expressed as a percentage of the total number of both source and destination transactions associated with the payment. */
|
|
958
|
+
percentageComplete: number;
|
|
959
|
+
/** The date the payment was started. */
|
|
960
|
+
paymentStartedDate: Date;
|
|
961
|
+
/** The date the payment was completed. */
|
|
962
|
+
paymentCompletedDate?: Date;
|
|
963
|
+
/** The optional external reference that was supplied in the initial payment request, if it was supplied. */
|
|
964
|
+
yourReference?: string;
|
|
965
|
+
/** The transaction batch description/reference that can appear in notifications and statements. */
|
|
966
|
+
description?: string;
|
|
967
|
+
/**
|
|
968
|
+
* A globally unique payment reference (UUID) that was generated when the initial payment request was submitted.
|
|
969
|
+
* <para>
|
|
970
|
+
* This reference is returned in the response to that initial payment request.
|
|
971
|
+
* </para>
|
|
972
|
+
*/
|
|
973
|
+
paymentReference: string;
|
|
974
|
+
/** A short unique payment reference based on the payment ID. */
|
|
975
|
+
shortPaymentReference: string;
|
|
976
|
+
/**
|
|
977
|
+
* An optional reference that is associated with every transaction batch that participates in a split payment.
|
|
978
|
+
* This is used for split payments in environments like restaurants where multiple transaction batches contribute to one common bill.
|
|
979
|
+
* The client processing the split payment is responsible for generating this reference and ensuring that
|
|
980
|
+
* all transaction batches that are part of the split payment are associated with the same split reference.
|
|
981
|
+
*/
|
|
982
|
+
splitReference?: string;
|
|
983
|
+
/** A verification code that can be used to validate that an external payment was triggered by a trusted device (used for offline payments for example). */
|
|
984
|
+
verificationCode: string;
|
|
985
|
+
/** Specify the channel that this payment originated from. */
|
|
986
|
+
channel: Channel;
|
|
987
|
+
/** The consumer reference of the consumer who made the payment. */
|
|
988
|
+
consumerReference?: string;
|
|
989
|
+
/** Optional details of the consumer who made the payment. */
|
|
990
|
+
consumer?: BasicConsumer;
|
|
991
|
+
/** A <see cref="T:ZGA.Core.Models.Payments.PaymentSourceResults" /> object containing all of the payment sources associated with the payment and several aggregated values related to those sources. */
|
|
992
|
+
paymentSources?: PaymentSourceResults;
|
|
993
|
+
/** A <see cref="T:ZGA.Core.Models.Payments.PaymentDestinationResults" /> object containing all of the payment destinations associated with the payment and several aggregated values related to those sources. */
|
|
994
|
+
paymentDestinations?: PaymentDestinationResults;
|
|
995
|
+
/** Transaction amount totals that summarize the overall payment amounts, fees and commissions associated with the payment. */
|
|
996
|
+
amountTotals: AmountTotals;
|
|
997
|
+
timeZone?: string;
|
|
998
|
+
}
|
|
999
|
+
export declare class PaymentTransaction {
|
|
1000
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
1001
|
+
description?: string;
|
|
1002
|
+
/** The transaction amount, in cents. */
|
|
1003
|
+
amountInCents: number;
|
|
1004
|
+
/** The cashback amount, in cents. */
|
|
1005
|
+
cashbackAmountInCents: number;
|
|
1006
|
+
/** A 3 character ISO currency code. */
|
|
1007
|
+
currency: Currency;
|
|
1008
|
+
/** Set this optional flag to avoid actually processing a transaction. */
|
|
1009
|
+
doNotProcess: boolean;
|
|
1010
|
+
/**
|
|
1011
|
+
* Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
|
|
1012
|
+
* The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
|
|
1013
|
+
* This flag can only be used with server integrations and will be ignored for any other calls.
|
|
1014
|
+
* This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
|
|
1015
|
+
*/
|
|
1016
|
+
disableConfirmation: boolean;
|
|
1017
|
+
/** A collection of public data that can be associated with the transaction. */
|
|
1018
|
+
clientData: {
|
|
1019
|
+
[key: string]: string;
|
|
1020
|
+
};
|
|
1021
|
+
/** A collection of all refund transaction requests that are associated with this transaction. */
|
|
1022
|
+
refunds?: RefundTransaction[];
|
|
1023
|
+
fees: TransactionFee[];
|
|
1024
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
1025
|
+
reference?: string;
|
|
1026
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
1027
|
+
shortReference?: string;
|
|
1028
|
+
}
|
|
1029
|
+
export declare abstract class PaymentTransactionResult {
|
|
1030
|
+
/** A collection of the results of all refund transactions that are associated with the transaction that this result object refers to. */
|
|
1031
|
+
refunds: RefundTransactionResult[];
|
|
1032
|
+
/** The date and time this transaction record was created. */
|
|
1033
|
+
createdDate: Date;
|
|
1034
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
1035
|
+
reference?: string;
|
|
1036
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
1037
|
+
shortReference?: string;
|
|
1038
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
1039
|
+
description?: string;
|
|
1040
|
+
/** The original amount of the transaction, in cents, as submitted to the payment engine over the wire before Fees and Commissions are factored in. */
|
|
1041
|
+
originalAmountInCents: number;
|
|
1042
|
+
/** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
|
|
1043
|
+
amountAttemptedInCents: number;
|
|
1044
|
+
/**
|
|
1045
|
+
* The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
|
|
1046
|
+
* This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
|
|
1047
|
+
*/
|
|
1048
|
+
amountInCents: number;
|
|
1049
|
+
/** The cashback amount, in cents. */
|
|
1050
|
+
cashbackAmountInCents: number;
|
|
1051
|
+
/** A collection of all fees applied to the transaction. */
|
|
1052
|
+
fees: TransactionFee[];
|
|
1053
|
+
/** A collection of metadata linked to this transaction. */
|
|
1054
|
+
data: TransactionData[];
|
|
1055
|
+
/** A 3 character ISO currency code. */
|
|
1056
|
+
currency: Currency;
|
|
1057
|
+
/** The current status of the transaction. */
|
|
1058
|
+
status: TransactionStatus;
|
|
1059
|
+
/** The category of the transaction. */
|
|
1060
|
+
category: TransactionCategory;
|
|
1061
|
+
/** A derived summary transaction status that groups transaction statuses into less granular sets to make it easier to quickly determine the general status of a transaction. */
|
|
1062
|
+
summaryStatus: TransactionStatus;
|
|
1063
|
+
isComplete: boolean;
|
|
1064
|
+
isCashWithdrawal: boolean;
|
|
1065
|
+
/** A message detailing the current status of the transaction. */
|
|
1066
|
+
message: string;
|
|
1067
|
+
}
|
|
1068
|
+
/** Model to hold the details of a request for validation of a QR code. */
|
|
1069
|
+
export declare class QrCodeValidationRequest {
|
|
1070
|
+
/** A QR Code string that you would like validated. */
|
|
1071
|
+
qrCode: string;
|
|
1072
|
+
}
|
|
1073
|
+
/** A model to hold the details of a QR Code validation response. */
|
|
1074
|
+
export declare class QrCodeValidationResponse {
|
|
1075
|
+
/** A boolean value indicating whether the current environment is capable of processing the QR Code that was submitted for validation. */
|
|
1076
|
+
canProcess: boolean;
|
|
1077
|
+
/** A comma delimited list of every type of QR Code that the current environment is capable of processing. */
|
|
1078
|
+
supportedQrCodes: string;
|
|
1079
|
+
}
|
|
1080
|
+
export declare enum ReceiptType {
|
|
1081
|
+
Consumer = "Consumer",
|
|
1082
|
+
Merchant = "Merchant"
|
|
1083
|
+
}
|
|
1084
|
+
/** A model to hold the details of the current status of a refund transaction. */
|
|
1085
|
+
export declare class RefundReceiptResponse {
|
|
1086
|
+
/** The optional external reference that was supplied in the initial refund request, if it was supplied. */
|
|
1087
|
+
yourReference?: string;
|
|
1088
|
+
/** The full payment receipt for the original payment that was refunded when available. */
|
|
1089
|
+
originalPaymentReceipt?: PaymentReceiptResponse;
|
|
1090
|
+
/** The date the refund was completed. */
|
|
1091
|
+
refundCompletedDate?: Date;
|
|
1092
|
+
timeZone?: string;
|
|
1093
|
+
/** The date and time this transaction record was created. */
|
|
1094
|
+
createdDate: Date;
|
|
1095
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
1096
|
+
reference?: string;
|
|
1097
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
1098
|
+
shortReference?: string;
|
|
1099
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
1100
|
+
description?: string;
|
|
1101
|
+
/** The original amount of the transaction, in cents, as submitted to the payment engine over the wire before Fees and Commissions are factored in. */
|
|
1102
|
+
originalAmountInCents: number;
|
|
1103
|
+
/** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
|
|
1104
|
+
amountAttemptedInCents: number;
|
|
1105
|
+
/**
|
|
1106
|
+
* The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
|
|
1107
|
+
* This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
|
|
1108
|
+
*/
|
|
1109
|
+
amountInCents: number;
|
|
1110
|
+
/** The cashback amount, in cents. */
|
|
1111
|
+
cashbackAmountInCents: number;
|
|
1112
|
+
/** A collection of all fees applied to the transaction. */
|
|
1113
|
+
fees: TransactionFee[];
|
|
1114
|
+
/** A collection of metadata linked to this transaction. */
|
|
1115
|
+
data: TransactionData[];
|
|
1116
|
+
/** A 3 character ISO currency code. */
|
|
1117
|
+
currency: Currency;
|
|
1118
|
+
/** The current status of the transaction. */
|
|
1119
|
+
status: TransactionStatus;
|
|
1120
|
+
/** The category of the transaction. */
|
|
1121
|
+
category: TransactionCategory;
|
|
1122
|
+
/** A derived summary transaction status that groups transaction statuses into less granular sets to make it easier to quickly determine the general status of a transaction. */
|
|
1123
|
+
summaryStatus: TransactionStatus;
|
|
1124
|
+
isComplete: boolean;
|
|
1125
|
+
isCashWithdrawal: boolean;
|
|
1126
|
+
/** A message detailing the current status of the transaction. */
|
|
1127
|
+
message: string;
|
|
1128
|
+
}
|
|
1129
|
+
/** A model to hold the details of a request to refund money to a source of funds. */
|
|
1130
|
+
export declare class RefundRequest {
|
|
1131
|
+
language?: string;
|
|
1132
|
+
timeZone?: string;
|
|
1133
|
+
/** A globally unique transaction reference (UUID) that identifies the original transaction that sourced the funds that you want to refund. */
|
|
1134
|
+
sourceTransactionReference: string;
|
|
1135
|
+
/** A globally unique transaction reference (UUID) that identifies the destination transaction that the refund request is associated with. */
|
|
1136
|
+
destinationTransactionReference: string;
|
|
1137
|
+
/** A collection of public data that can be associated with the transaction. */
|
|
1138
|
+
clientData: {
|
|
1139
|
+
[key: string]: string;
|
|
1140
|
+
};
|
|
1141
|
+
/**
|
|
1142
|
+
* The amount to refund.
|
|
1143
|
+
* <para>This value cannot be larger than the amount that was originally sourced by the transaction referenced by <see cref="P:ZGA.Core.Models.Payments.RefundRequest.SourceTransactionReference" />.</para>
|
|
1144
|
+
*/
|
|
1145
|
+
refundAmountInCents: number;
|
|
1146
|
+
}
|
|
1147
|
+
/** A model to hold the details of a response to a refund request. */
|
|
1148
|
+
export declare class RefundResponse {
|
|
1149
|
+
/**
|
|
1150
|
+
* A globally unique refund transaction reference (UUID) generated by the system internally to identify a specific refund transaction.
|
|
1151
|
+
* <para>Can be used to check the status of a refund.</para>
|
|
1152
|
+
*/
|
|
1153
|
+
reference: string;
|
|
1154
|
+
/** A set of URLs that can be used to check the status of a refund either via polling or SignalR. */
|
|
1155
|
+
refundStatusUrls: StatusUrls;
|
|
1156
|
+
}
|
|
1157
|
+
/** A model to hold the details of the current status of a refund transaction. */
|
|
1158
|
+
export declare class RefundStatusResponse {
|
|
1159
|
+
/** The date the refund was completed. */
|
|
1160
|
+
refundCompletedDate?: Date;
|
|
1161
|
+
timeZone?: string;
|
|
1162
|
+
/** The date and time this transaction record was created. */
|
|
1163
|
+
createdDate: Date;
|
|
1164
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
1165
|
+
reference?: string;
|
|
1166
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
1167
|
+
shortReference?: string;
|
|
1168
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
1169
|
+
description?: string;
|
|
1170
|
+
/** The original amount of the transaction, in cents, as submitted to the payment engine over the wire before Fees and Commissions are factored in. */
|
|
1171
|
+
originalAmountInCents: number;
|
|
1172
|
+
/** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
|
|
1173
|
+
amountAttemptedInCents: number;
|
|
1174
|
+
/**
|
|
1175
|
+
* The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
|
|
1176
|
+
* This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
|
|
1177
|
+
*/
|
|
1178
|
+
amountInCents: number;
|
|
1179
|
+
/** The cashback amount, in cents. */
|
|
1180
|
+
cashbackAmountInCents: number;
|
|
1181
|
+
/** A collection of all fees applied to the transaction. */
|
|
1182
|
+
fees: TransactionFee[];
|
|
1183
|
+
/** A collection of metadata linked to this transaction. */
|
|
1184
|
+
data: TransactionData[];
|
|
1185
|
+
/** A 3 character ISO currency code. */
|
|
1186
|
+
currency: Currency;
|
|
1187
|
+
/** The current status of the transaction. */
|
|
1188
|
+
status: TransactionStatus;
|
|
1189
|
+
/** The category of the transaction. */
|
|
1190
|
+
category: TransactionCategory;
|
|
1191
|
+
/** A derived summary transaction status that groups transaction statuses into less granular sets to make it easier to quickly determine the general status of a transaction. */
|
|
1192
|
+
summaryStatus: TransactionStatus;
|
|
1193
|
+
isComplete: boolean;
|
|
1194
|
+
isCashWithdrawal: boolean;
|
|
1195
|
+
/** A message detailing the current status of the transaction. */
|
|
1196
|
+
message: string;
|
|
1197
|
+
}
|
|
1198
|
+
/** A model to hold the details of a refund transaction. */
|
|
1199
|
+
export declare class RefundTransaction {
|
|
1200
|
+
/** The amount to refund. */
|
|
1201
|
+
refundAmountInCents: number;
|
|
1202
|
+
description?: string;
|
|
1203
|
+
}
|
|
1204
|
+
/** A model to hold the details of the result of a transaction refund attempt. */
|
|
1205
|
+
export declare class RefundTransactionResult {
|
|
1206
|
+
/** The date and time this transaction record was created. */
|
|
1207
|
+
createdDate: Date;
|
|
1208
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
1209
|
+
reference?: string;
|
|
1210
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
1211
|
+
shortReference?: string;
|
|
1212
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
1213
|
+
description?: string;
|
|
1214
|
+
/** The original amount of the transaction, in cents, as submitted to the payment engine over the wire before Fees and Commissions are factored in. */
|
|
1215
|
+
originalAmountInCents: number;
|
|
1216
|
+
/** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
|
|
1217
|
+
amountAttemptedInCents: number;
|
|
1218
|
+
/**
|
|
1219
|
+
* The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
|
|
1220
|
+
* This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
|
|
1221
|
+
*/
|
|
1222
|
+
amountInCents: number;
|
|
1223
|
+
/** The cashback amount, in cents. */
|
|
1224
|
+
cashbackAmountInCents: number;
|
|
1225
|
+
/** A collection of all fees applied to the transaction. */
|
|
1226
|
+
fees: TransactionFee[];
|
|
1227
|
+
/** A collection of metadata linked to this transaction. */
|
|
1228
|
+
data: TransactionData[];
|
|
1229
|
+
/** A 3 character ISO currency code. */
|
|
1230
|
+
currency: Currency;
|
|
1231
|
+
/** The current status of the transaction. */
|
|
1232
|
+
status: TransactionStatus;
|
|
1233
|
+
/** The category of the transaction. */
|
|
1234
|
+
category: TransactionCategory;
|
|
1235
|
+
/** A derived summary transaction status that groups transaction statuses into less granular sets to make it easier to quickly determine the general status of a transaction. */
|
|
1236
|
+
summaryStatus: TransactionStatus;
|
|
1237
|
+
isComplete: boolean;
|
|
1238
|
+
isCashWithdrawal: boolean;
|
|
1239
|
+
/** A message detailing the current status of the transaction. */
|
|
1240
|
+
message: string;
|
|
1241
|
+
}
|
|
1242
|
+
export declare enum RefundType {
|
|
1243
|
+
Manual = 1,
|
|
1244
|
+
Auto = 2
|
|
1245
|
+
}
|
|
1246
|
+
export declare class ApplePaySource {
|
|
1247
|
+
webPaymentResponse: ApplePayWebPaymentResponse;
|
|
1248
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
1249
|
+
description?: string;
|
|
1250
|
+
/** The transaction amount, in cents. */
|
|
1251
|
+
amountInCents: number;
|
|
1252
|
+
/** The cashback amount, in cents. */
|
|
1253
|
+
cashbackAmountInCents: number;
|
|
1254
|
+
/** A 3 character ISO currency code. */
|
|
1255
|
+
currency: Currency;
|
|
1256
|
+
/** Set this optional flag to avoid actually processing a transaction. */
|
|
1257
|
+
doNotProcess: boolean;
|
|
1258
|
+
/**
|
|
1259
|
+
* Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
|
|
1260
|
+
* The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
|
|
1261
|
+
* This flag can only be used with server integrations and will be ignored for any other calls.
|
|
1262
|
+
* This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
|
|
1263
|
+
*/
|
|
1264
|
+
disableConfirmation: boolean;
|
|
1265
|
+
/** A collection of public data that can be associated with the transaction. */
|
|
1266
|
+
clientData: {
|
|
1267
|
+
[key: string]: string;
|
|
1268
|
+
};
|
|
1269
|
+
/** A collection of all refund transaction requests that are associated with this transaction. */
|
|
1270
|
+
refunds?: RefundTransaction[];
|
|
1271
|
+
fees: TransactionFee[];
|
|
1272
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
1273
|
+
reference?: string;
|
|
1274
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
1275
|
+
shortReference?: string;
|
|
1276
|
+
}
|
|
1277
|
+
export declare class BankAccountSource {
|
|
1278
|
+
/**
|
|
1279
|
+
* A token that can be used instead of a bank account number.
|
|
1280
|
+
* If a token is present a bank account does not need to be provided.
|
|
1281
|
+
*/
|
|
1282
|
+
token?: string;
|
|
1283
|
+
/** The bank account number from which funds will be withdrawn. */
|
|
1284
|
+
accountNumber: string;
|
|
1285
|
+
/** The bank code of the bank that the account belongs to. */
|
|
1286
|
+
bank: Bank;
|
|
1287
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
1288
|
+
description?: string;
|
|
1289
|
+
/** The transaction amount, in cents. */
|
|
1290
|
+
amountInCents: number;
|
|
1291
|
+
/** The cashback amount, in cents. */
|
|
1292
|
+
cashbackAmountInCents: number;
|
|
1293
|
+
/** A 3 character ISO currency code. */
|
|
1294
|
+
currency: Currency;
|
|
1295
|
+
/** Set this optional flag to avoid actually processing a transaction. */
|
|
1296
|
+
doNotProcess: boolean;
|
|
1297
|
+
/**
|
|
1298
|
+
* Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
|
|
1299
|
+
* The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
|
|
1300
|
+
* This flag can only be used with server integrations and will be ignored for any other calls.
|
|
1301
|
+
* This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
|
|
1302
|
+
*/
|
|
1303
|
+
disableConfirmation: boolean;
|
|
1304
|
+
/** A collection of public data that can be associated with the transaction. */
|
|
1305
|
+
clientData: {
|
|
1306
|
+
[key: string]: string;
|
|
1307
|
+
};
|
|
1308
|
+
/** A collection of all refund transaction requests that are associated with this transaction. */
|
|
1309
|
+
refunds?: RefundTransaction[];
|
|
1310
|
+
fees: TransactionFee[];
|
|
1311
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
1312
|
+
reference?: string;
|
|
1313
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
1314
|
+
shortReference?: string;
|
|
1315
|
+
}
|
|
1316
|
+
export declare class BankAccountSourceResult {
|
|
1317
|
+
accountNumber: string;
|
|
1318
|
+
bank: Bank;
|
|
1319
|
+
bankName: string;
|
|
1320
|
+
accountHolder?: string;
|
|
1321
|
+
/** A collection of the results of all refund transactions that are associated with the transaction that this result object refers to. */
|
|
1322
|
+
refunds: RefundTransactionResult[];
|
|
1323
|
+
/** The date and time this transaction record was created. */
|
|
1324
|
+
createdDate: Date;
|
|
1325
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
1326
|
+
reference?: string;
|
|
1327
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
1328
|
+
shortReference?: string;
|
|
1329
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
1330
|
+
description?: string;
|
|
1331
|
+
/** The original amount of the transaction, in cents, as submitted to the payment engine over the wire before Fees and Commissions are factored in. */
|
|
1332
|
+
originalAmountInCents: number;
|
|
1333
|
+
/** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
|
|
1334
|
+
amountAttemptedInCents: number;
|
|
1335
|
+
/**
|
|
1336
|
+
* The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
|
|
1337
|
+
* This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
|
|
1338
|
+
*/
|
|
1339
|
+
amountInCents: number;
|
|
1340
|
+
/** The cashback amount, in cents. */
|
|
1341
|
+
cashbackAmountInCents: number;
|
|
1342
|
+
/** A collection of all fees applied to the transaction. */
|
|
1343
|
+
fees: TransactionFee[];
|
|
1344
|
+
/** A collection of metadata linked to this transaction. */
|
|
1345
|
+
data: TransactionData[];
|
|
1346
|
+
/** A 3 character ISO currency code. */
|
|
1347
|
+
currency: Currency;
|
|
1348
|
+
/** The current status of the transaction. */
|
|
1349
|
+
status: TransactionStatus;
|
|
1350
|
+
/** The category of the transaction. */
|
|
1351
|
+
category: TransactionCategory;
|
|
1352
|
+
/** A derived summary transaction status that groups transaction statuses into less granular sets to make it easier to quickly determine the general status of a transaction. */
|
|
1353
|
+
summaryStatus: TransactionStatus;
|
|
1354
|
+
isComplete: boolean;
|
|
1355
|
+
isCashWithdrawal: boolean;
|
|
1356
|
+
/** A message detailing the current status of the transaction. */
|
|
1357
|
+
message: string;
|
|
1358
|
+
}
|
|
1359
|
+
/** Model to hold the details of a card from which a payment should be made. */
|
|
1360
|
+
export declare class CardSource {
|
|
1361
|
+
/**
|
|
1362
|
+
* A token that can be used instead of a card number.
|
|
1363
|
+
* If a token is present a card does not need to be provided.
|
|
1364
|
+
*/
|
|
1365
|
+
token?: string;
|
|
1366
|
+
/** The name of the card company that issued this card: VISA, MasterCard, AMEX etc. */
|
|
1367
|
+
cardIssuer: CardIssuer;
|
|
1368
|
+
cardIssuerCountryIsoCode?: Country;
|
|
1369
|
+
/** The full card number. */
|
|
1370
|
+
cardNumber: string;
|
|
1371
|
+
/**
|
|
1372
|
+
* The Card Verification Value found on the back of the card.
|
|
1373
|
+
* This is either 3 or 4 digits long.
|
|
1374
|
+
*/
|
|
1375
|
+
cvv?: string;
|
|
1376
|
+
/** The name of the card holder as printed on the card. */
|
|
1377
|
+
nameOnCard: string;
|
|
1378
|
+
/** The month in which the card expires. */
|
|
1379
|
+
expiryMonth: Month;
|
|
1380
|
+
/** The year in which the card expires. */
|
|
1381
|
+
expiryYear: number;
|
|
1382
|
+
/** The card holders billing address. */
|
|
1383
|
+
billingAddress?: Address;
|
|
1384
|
+
/** Additional customer information to facilitate the card payment. */
|
|
1385
|
+
cardHolder?: CardHolder;
|
|
1386
|
+
disableThreeDSecure: boolean;
|
|
1387
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
1388
|
+
description?: string;
|
|
1389
|
+
/** The transaction amount, in cents. */
|
|
1390
|
+
amountInCents: number;
|
|
1391
|
+
/** The cashback amount, in cents. */
|
|
1392
|
+
cashbackAmountInCents: number;
|
|
1393
|
+
/** A 3 character ISO currency code. */
|
|
1394
|
+
currency: Currency;
|
|
1395
|
+
/** Set this optional flag to avoid actually processing a transaction. */
|
|
1396
|
+
doNotProcess: boolean;
|
|
1397
|
+
/**
|
|
1398
|
+
* Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
|
|
1399
|
+
* The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
|
|
1400
|
+
* This flag can only be used with server integrations and will be ignored for any other calls.
|
|
1401
|
+
* This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
|
|
1402
|
+
*/
|
|
1403
|
+
disableConfirmation: boolean;
|
|
1404
|
+
/** A collection of public data that can be associated with the transaction. */
|
|
1405
|
+
clientData: {
|
|
1406
|
+
[key: string]: string;
|
|
1407
|
+
};
|
|
1408
|
+
/** A collection of all refund transaction requests that are associated with this transaction. */
|
|
1409
|
+
refunds?: RefundTransaction[];
|
|
1410
|
+
fees: TransactionFee[];
|
|
1411
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
1412
|
+
reference?: string;
|
|
1413
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
1414
|
+
shortReference?: string;
|
|
1415
|
+
}
|
|
1416
|
+
export declare class CardSourceResult {
|
|
1417
|
+
cardIssuer: string;
|
|
1418
|
+
cardIssuerCountryIsoCode?: Country;
|
|
1419
|
+
cardNumber: string;
|
|
1420
|
+
threeDSecureUrl?: string;
|
|
1421
|
+
/** A collection of the results of all refund transactions that are associated with the transaction that this result object refers to. */
|
|
1422
|
+
refunds: RefundTransactionResult[];
|
|
1423
|
+
/** The date and time this transaction record was created. */
|
|
1424
|
+
createdDate: Date;
|
|
1425
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
1426
|
+
reference?: string;
|
|
1427
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
1428
|
+
shortReference?: string;
|
|
1429
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
1430
|
+
description?: string;
|
|
1431
|
+
/** The original amount of the transaction, in cents, as submitted to the payment engine over the wire before Fees and Commissions are factored in. */
|
|
1432
|
+
originalAmountInCents: number;
|
|
1433
|
+
/** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
|
|
1434
|
+
amountAttemptedInCents: number;
|
|
1435
|
+
/**
|
|
1436
|
+
* The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
|
|
1437
|
+
* This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
|
|
1438
|
+
*/
|
|
1439
|
+
amountInCents: number;
|
|
1440
|
+
/** The cashback amount, in cents. */
|
|
1441
|
+
cashbackAmountInCents: number;
|
|
1442
|
+
/** A collection of all fees applied to the transaction. */
|
|
1443
|
+
fees: TransactionFee[];
|
|
1444
|
+
/** A collection of metadata linked to this transaction. */
|
|
1445
|
+
data: TransactionData[];
|
|
1446
|
+
/** A 3 character ISO currency code. */
|
|
1447
|
+
currency: Currency;
|
|
1448
|
+
/** The current status of the transaction. */
|
|
1449
|
+
status: TransactionStatus;
|
|
1450
|
+
/** The category of the transaction. */
|
|
1451
|
+
category: TransactionCategory;
|
|
1452
|
+
/** A derived summary transaction status that groups transaction statuses into less granular sets to make it easier to quickly determine the general status of a transaction. */
|
|
1453
|
+
summaryStatus: TransactionStatus;
|
|
1454
|
+
isComplete: boolean;
|
|
1455
|
+
isCashWithdrawal: boolean;
|
|
1456
|
+
/** A message detailing the current status of the transaction. */
|
|
1457
|
+
message: string;
|
|
1458
|
+
}
|
|
1459
|
+
export declare class CashSource {
|
|
1460
|
+
doNotProcess: boolean;
|
|
1461
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
1462
|
+
description?: string;
|
|
1463
|
+
/** The transaction amount, in cents. */
|
|
1464
|
+
amountInCents: number;
|
|
1465
|
+
/** The cashback amount, in cents. */
|
|
1466
|
+
cashbackAmountInCents: number;
|
|
1467
|
+
/** A 3 character ISO currency code. */
|
|
1468
|
+
currency: Currency;
|
|
1469
|
+
/**
|
|
1470
|
+
* Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
|
|
1471
|
+
* The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
|
|
1472
|
+
* This flag can only be used with server integrations and will be ignored for any other calls.
|
|
1473
|
+
* This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
|
|
1474
|
+
*/
|
|
1475
|
+
disableConfirmation: boolean;
|
|
1476
|
+
/** A collection of public data that can be associated with the transaction. */
|
|
1477
|
+
clientData: {
|
|
1478
|
+
[key: string]: string;
|
|
1479
|
+
};
|
|
1480
|
+
/** A collection of all refund transaction requests that are associated with this transaction. */
|
|
1481
|
+
refunds?: RefundTransaction[];
|
|
1482
|
+
fees: TransactionFee[];
|
|
1483
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
1484
|
+
reference?: string;
|
|
1485
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
1486
|
+
shortReference?: string;
|
|
1487
|
+
}
|
|
1488
|
+
export declare class CashSourceResult {
|
|
1489
|
+
/** A collection of the results of all refund transactions that are associated with the transaction that this result object refers to. */
|
|
1490
|
+
refunds: RefundTransactionResult[];
|
|
1491
|
+
/** The date and time this transaction record was created. */
|
|
1492
|
+
createdDate: Date;
|
|
1493
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
1494
|
+
reference?: string;
|
|
1495
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
1496
|
+
shortReference?: string;
|
|
1497
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
1498
|
+
description?: string;
|
|
1499
|
+
/** The original amount of the transaction, in cents, as submitted to the payment engine over the wire before Fees and Commissions are factored in. */
|
|
1500
|
+
originalAmountInCents: number;
|
|
1501
|
+
/** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
|
|
1502
|
+
amountAttemptedInCents: number;
|
|
1503
|
+
/**
|
|
1504
|
+
* The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
|
|
1505
|
+
* This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
|
|
1506
|
+
*/
|
|
1507
|
+
amountInCents: number;
|
|
1508
|
+
/** The cashback amount, in cents. */
|
|
1509
|
+
cashbackAmountInCents: number;
|
|
1510
|
+
/** A collection of all fees applied to the transaction. */
|
|
1511
|
+
fees: TransactionFee[];
|
|
1512
|
+
/** A collection of metadata linked to this transaction. */
|
|
1513
|
+
data: TransactionData[];
|
|
1514
|
+
/** A 3 character ISO currency code. */
|
|
1515
|
+
currency: Currency;
|
|
1516
|
+
/** The current status of the transaction. */
|
|
1517
|
+
status: TransactionStatus;
|
|
1518
|
+
/** The category of the transaction. */
|
|
1519
|
+
category: TransactionCategory;
|
|
1520
|
+
/** A derived summary transaction status that groups transaction statuses into less granular sets to make it easier to quickly determine the general status of a transaction. */
|
|
1521
|
+
summaryStatus: TransactionStatus;
|
|
1522
|
+
isComplete: boolean;
|
|
1523
|
+
isCashWithdrawal: boolean;
|
|
1524
|
+
/** A message detailing the current status of the transaction. */
|
|
1525
|
+
message: string;
|
|
1526
|
+
}
|
|
1527
|
+
export declare class GenericSource {
|
|
1528
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
1529
|
+
description?: string;
|
|
1530
|
+
/** The transaction amount, in cents. */
|
|
1531
|
+
amountInCents: number;
|
|
1532
|
+
/** The cashback amount, in cents. */
|
|
1533
|
+
cashbackAmountInCents: number;
|
|
1534
|
+
/** A 3 character ISO currency code. */
|
|
1535
|
+
currency: Currency;
|
|
1536
|
+
/**
|
|
1537
|
+
* Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
|
|
1538
|
+
* The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
|
|
1539
|
+
* This flag can only be used with server integrations and will be ignored for any other calls.
|
|
1540
|
+
* This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
|
|
1541
|
+
*/
|
|
1542
|
+
disableConfirmation: boolean;
|
|
1543
|
+
/** A collection of public data that can be associated with the transaction. */
|
|
1544
|
+
clientData: {
|
|
1545
|
+
[key: string]: string;
|
|
1546
|
+
};
|
|
1547
|
+
/** A collection of all refund transaction requests that are associated with this transaction. */
|
|
1548
|
+
refunds?: RefundTransaction[];
|
|
1549
|
+
fees: TransactionFee[];
|
|
1550
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
1551
|
+
reference?: string;
|
|
1552
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
1553
|
+
shortReference?: string;
|
|
1554
|
+
}
|
|
1555
|
+
export declare class GooglePaySource {
|
|
1556
|
+
webPaymentResponse: GooglePayWebPaymentResponse;
|
|
1557
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
1558
|
+
description?: string;
|
|
1559
|
+
/** The transaction amount, in cents. */
|
|
1560
|
+
amountInCents: number;
|
|
1561
|
+
/** The cashback amount, in cents. */
|
|
1562
|
+
cashbackAmountInCents: number;
|
|
1563
|
+
/** A 3 character ISO currency code. */
|
|
1564
|
+
currency: Currency;
|
|
1565
|
+
/** Set this optional flag to avoid actually processing a transaction. */
|
|
1566
|
+
doNotProcess: boolean;
|
|
1567
|
+
/**
|
|
1568
|
+
* Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
|
|
1569
|
+
* The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
|
|
1570
|
+
* This flag can only be used with server integrations and will be ignored for any other calls.
|
|
1571
|
+
* This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
|
|
1572
|
+
*/
|
|
1573
|
+
disableConfirmation: boolean;
|
|
1574
|
+
/** A collection of public data that can be associated with the transaction. */
|
|
1575
|
+
clientData: {
|
|
1576
|
+
[key: string]: string;
|
|
1577
|
+
};
|
|
1578
|
+
/** A collection of all refund transaction requests that are associated with this transaction. */
|
|
1579
|
+
refunds?: RefundTransaction[];
|
|
1580
|
+
fees: TransactionFee[];
|
|
1581
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
1582
|
+
reference?: string;
|
|
1583
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
1584
|
+
shortReference?: string;
|
|
1585
|
+
}
|
|
1586
|
+
/** Model to hold the details of a mobile money payment source. */
|
|
1587
|
+
export declare class MobileWalletSource {
|
|
1588
|
+
/** The mobile wallet operator that owns the mobile money account. */
|
|
1589
|
+
mobileWalletOperator: MobileWalletOperator;
|
|
1590
|
+
/**
|
|
1591
|
+
* Mobile Station International Subscriber Directory Number (MSISDN) is a number used to identify a mobile phone number internationally.
|
|
1592
|
+
* This number includes a country code and a National Destination Code which identifies the subscriber's operator.
|
|
1593
|
+
*/
|
|
1594
|
+
msisdn: string;
|
|
1595
|
+
/**
|
|
1596
|
+
* A voucher code issued by your network provider (currently Vodafone/Telecel or GMoney) in order to verify your payment.
|
|
1597
|
+
* This can also actually be a One Time Pin code, despite being referred to as a VoucherCode, that is generated by the MNO but needs to be submitted via the payment engine.
|
|
1598
|
+
*/
|
|
1599
|
+
voucherCode?: string;
|
|
1600
|
+
/**
|
|
1601
|
+
* A PIN issued to the subscriber.
|
|
1602
|
+
* This is usually a static PIN code and is currently only applicable for Zeepay.
|
|
1603
|
+
*/
|
|
1604
|
+
subscriberPin?: string;
|
|
1605
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
1606
|
+
description?: string;
|
|
1607
|
+
/** The transaction amount, in cents. */
|
|
1608
|
+
amountInCents: number;
|
|
1609
|
+
/** The cashback amount, in cents. */
|
|
1610
|
+
cashbackAmountInCents: number;
|
|
1611
|
+
/** A 3 character ISO currency code. */
|
|
1612
|
+
currency: Currency;
|
|
1613
|
+
/** Set this optional flag to avoid actually processing a transaction. */
|
|
1614
|
+
doNotProcess: boolean;
|
|
1615
|
+
/**
|
|
1616
|
+
* Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
|
|
1617
|
+
* The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
|
|
1618
|
+
* This flag can only be used with server integrations and will be ignored for any other calls.
|
|
1619
|
+
* This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
|
|
1620
|
+
*/
|
|
1621
|
+
disableConfirmation: boolean;
|
|
1622
|
+
/** A collection of public data that can be associated with the transaction. */
|
|
1623
|
+
clientData: {
|
|
1624
|
+
[key: string]: string;
|
|
1625
|
+
};
|
|
1626
|
+
/** A collection of all refund transaction requests that are associated with this transaction. */
|
|
1627
|
+
refunds?: RefundTransaction[];
|
|
1628
|
+
fees: TransactionFee[];
|
|
1629
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
1630
|
+
reference?: string;
|
|
1631
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
1632
|
+
shortReference?: string;
|
|
1633
|
+
}
|
|
1634
|
+
export declare class MobileWalletSourceResult {
|
|
1635
|
+
mobileWalletOperator: MobileWalletOperator;
|
|
1636
|
+
mobileWalletOperatorName: string;
|
|
1637
|
+
msisdn: string;
|
|
1638
|
+
accountHolder?: string;
|
|
1639
|
+
/** A collection of the results of all refund transactions that are associated with the transaction that this result object refers to. */
|
|
1640
|
+
refunds: RefundTransactionResult[];
|
|
1641
|
+
/** The date and time this transaction record was created. */
|
|
1642
|
+
createdDate: Date;
|
|
1643
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
1644
|
+
reference?: string;
|
|
1645
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
1646
|
+
shortReference?: string;
|
|
1647
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
1648
|
+
description?: string;
|
|
1649
|
+
/** The original amount of the transaction, in cents, as submitted to the payment engine over the wire before Fees and Commissions are factored in. */
|
|
1650
|
+
originalAmountInCents: number;
|
|
1651
|
+
/** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
|
|
1652
|
+
amountAttemptedInCents: number;
|
|
1653
|
+
/**
|
|
1654
|
+
* The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
|
|
1655
|
+
* This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
|
|
1656
|
+
*/
|
|
1657
|
+
amountInCents: number;
|
|
1658
|
+
/** The cashback amount, in cents. */
|
|
1659
|
+
cashbackAmountInCents: number;
|
|
1660
|
+
/** A collection of all fees applied to the transaction. */
|
|
1661
|
+
fees: TransactionFee[];
|
|
1662
|
+
/** A collection of metadata linked to this transaction. */
|
|
1663
|
+
data: TransactionData[];
|
|
1664
|
+
/** A 3 character ISO currency code. */
|
|
1665
|
+
currency: Currency;
|
|
1666
|
+
/** The current status of the transaction. */
|
|
1667
|
+
status: TransactionStatus;
|
|
1668
|
+
/** The category of the transaction. */
|
|
1669
|
+
category: TransactionCategory;
|
|
1670
|
+
/** A derived summary transaction status that groups transaction statuses into less granular sets to make it easier to quickly determine the general status of a transaction. */
|
|
1671
|
+
summaryStatus: TransactionStatus;
|
|
1672
|
+
isComplete: boolean;
|
|
1673
|
+
isCashWithdrawal: boolean;
|
|
1674
|
+
/** A message detailing the current status of the transaction. */
|
|
1675
|
+
message: string;
|
|
1676
|
+
}
|
|
1677
|
+
export declare class PaymentSourceResults {
|
|
1678
|
+
cards: CardSourceResult[];
|
|
1679
|
+
mobileWallets: MobileWalletSourceResult[];
|
|
1680
|
+
bankAccounts: BankAccountSourceResult[];
|
|
1681
|
+
wallets: WalletSourceResult[];
|
|
1682
|
+
cash?: CashSourceResult;
|
|
1683
|
+
}
|
|
1684
|
+
/** Model to hold lists of Cards and Mobile Money accounts from which a payment must be made. */
|
|
1685
|
+
export declare class PaymentSources {
|
|
1686
|
+
generic?: GenericSource;
|
|
1687
|
+
/** A list of cards that must be used to fund the payment. */
|
|
1688
|
+
cards?: CardSource[];
|
|
1689
|
+
/** A list of mobile money/wallets which must be used to fund the payment. */
|
|
1690
|
+
mobileWallets?: MobileWalletSource[];
|
|
1691
|
+
/** A list of bank accounts which must be used to fund the payment. */
|
|
1692
|
+
bankAccounts?: BankAccountSource[];
|
|
1693
|
+
/** A list of generic digital wallet which must be used to fund the payment. */
|
|
1694
|
+
wallets?: WalletSource[];
|
|
1695
|
+
/** Details of cash received to fund the payment. */
|
|
1696
|
+
cash?: CashSource;
|
|
1697
|
+
/** Web Payments API response data for Apple Pay transactions. */
|
|
1698
|
+
applePay?: ApplePaySource;
|
|
1699
|
+
/** Web Payments API response data for Google Pay transactions. */
|
|
1700
|
+
googlePay?: GooglePaySource;
|
|
1701
|
+
}
|
|
1702
|
+
export declare class WalletSource {
|
|
1703
|
+
/** A unique wallet identifier. */
|
|
1704
|
+
walletReference: string;
|
|
1705
|
+
/** The wallet provider that created and manages the wallet. */
|
|
1706
|
+
walletProvider: string;
|
|
1707
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
1708
|
+
description?: string;
|
|
1709
|
+
/** The transaction amount, in cents. */
|
|
1710
|
+
amountInCents: number;
|
|
1711
|
+
/** The cashback amount, in cents. */
|
|
1712
|
+
cashbackAmountInCents: number;
|
|
1713
|
+
/** A 3 character ISO currency code. */
|
|
1714
|
+
currency: Currency;
|
|
1715
|
+
/** Set this optional flag to avoid actually processing a transaction. */
|
|
1716
|
+
doNotProcess: boolean;
|
|
1717
|
+
/**
|
|
1718
|
+
* Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
|
|
1719
|
+
* The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
|
|
1720
|
+
* This flag can only be used with server integrations and will be ignored for any other calls.
|
|
1721
|
+
* This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
|
|
1722
|
+
*/
|
|
1723
|
+
disableConfirmation: boolean;
|
|
1724
|
+
/** A collection of public data that can be associated with the transaction. */
|
|
1725
|
+
clientData: {
|
|
1726
|
+
[key: string]: string;
|
|
1727
|
+
};
|
|
1728
|
+
/** A collection of all refund transaction requests that are associated with this transaction. */
|
|
1729
|
+
refunds?: RefundTransaction[];
|
|
1730
|
+
fees: TransactionFee[];
|
|
1731
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
1732
|
+
reference?: string;
|
|
1733
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
1734
|
+
shortReference?: string;
|
|
1735
|
+
}
|
|
1736
|
+
export declare class WalletSourceResult {
|
|
1737
|
+
walletReference: string;
|
|
1738
|
+
walletProvider: string;
|
|
1739
|
+
/** A collection of the results of all refund transactions that are associated with the transaction that this result object refers to. */
|
|
1740
|
+
refunds: RefundTransactionResult[];
|
|
1741
|
+
/** The date and time this transaction record was created. */
|
|
1742
|
+
createdDate: Date;
|
|
1743
|
+
/** A globally unique transaction reference (UUID) generated by the system internally to identify a specific transaction. */
|
|
1744
|
+
reference?: string;
|
|
1745
|
+
/** A globally unique hashed short transaction reference generated by the system internally and derived from the transaction Id to identify a specific transaction. */
|
|
1746
|
+
shortReference?: string;
|
|
1747
|
+
/** The transaction description/reference that can appear in notifications and statements. */
|
|
1748
|
+
description?: string;
|
|
1749
|
+
/** The original amount of the transaction, in cents, as submitted to the payment engine over the wire before Fees and Commissions are factored in. */
|
|
1750
|
+
originalAmountInCents: number;
|
|
1751
|
+
/** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
|
|
1752
|
+
amountAttemptedInCents: number;
|
|
1753
|
+
/**
|
|
1754
|
+
* The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
|
|
1755
|
+
* This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
|
|
1756
|
+
*/
|
|
1757
|
+
amountInCents: number;
|
|
1758
|
+
/** The cashback amount, in cents. */
|
|
1759
|
+
cashbackAmountInCents: number;
|
|
1760
|
+
/** A collection of all fees applied to the transaction. */
|
|
1761
|
+
fees: TransactionFee[];
|
|
1762
|
+
/** A collection of metadata linked to this transaction. */
|
|
1763
|
+
data: TransactionData[];
|
|
1764
|
+
/** A 3 character ISO currency code. */
|
|
1765
|
+
currency: Currency;
|
|
1766
|
+
/** The current status of the transaction. */
|
|
1767
|
+
status: TransactionStatus;
|
|
1768
|
+
/** The category of the transaction. */
|
|
1769
|
+
category: TransactionCategory;
|
|
1770
|
+
/** A derived summary transaction status that groups transaction statuses into less granular sets to make it easier to quickly determine the general status of a transaction. */
|
|
1771
|
+
summaryStatus: TransactionStatus;
|
|
1772
|
+
isComplete: boolean;
|
|
1773
|
+
isCashWithdrawal: boolean;
|
|
1774
|
+
/** A message detailing the current status of the transaction. */
|
|
1775
|
+
message: string;
|
|
1776
|
+
}
|
|
1777
|
+
/** A model to hold a set of URLs that can be used to check the status of various types of transactions using various different web technologies. */
|
|
1778
|
+
export declare class StatusUrls {
|
|
1779
|
+
/** A URL that can be used to repeatedly poll for a status update on a timer. */
|
|
1780
|
+
polling?: string;
|
|
1781
|
+
/** A URL that can be used to connect to a SignalR endpoint in order to have updates pushed to you so that you do not have to poll. */
|
|
1782
|
+
signalR?: string;
|
|
1783
|
+
/** Not available at this time. */
|
|
1784
|
+
serverSentEvents?: string;
|
|
1785
|
+
/** Not available at this time. */
|
|
1786
|
+
webSockets?: string;
|
|
1787
|
+
}
|
|
1788
|
+
export declare enum TransactionCategory {
|
|
1789
|
+
Unknown = 0,
|
|
1790
|
+
Generic = 1,
|
|
1791
|
+
BankAccount = 2,
|
|
1792
|
+
Card = 3,
|
|
1793
|
+
MobileWallet = 4,
|
|
1794
|
+
Cash = 5,
|
|
1795
|
+
Merchant = 6,
|
|
1796
|
+
QrCode = 7,
|
|
1797
|
+
DigitalWallet = 8,
|
|
1798
|
+
Wallet = 8,
|
|
1799
|
+
Bill = 9
|
|
1800
|
+
}
|
|
1801
|
+
/** A model that holds the details of a transaction confirmation. */
|
|
1802
|
+
export declare class TransactionConfirmation {
|
|
1803
|
+
/** A boolean value indicating whether the transaction has been confirmed or not. */
|
|
1804
|
+
confirm: boolean;
|
|
1805
|
+
}
|
|
1806
|
+
export declare class TransactionData {
|
|
1807
|
+
key: string;
|
|
1808
|
+
data: string;
|
|
1809
|
+
isPublic: boolean;
|
|
1810
|
+
static none: TransactionData[];
|
|
1811
|
+
}
|
|
1812
|
+
export declare class TransactionFee {
|
|
1813
|
+
name: string;
|
|
1814
|
+
feeType: FeeType;
|
|
1815
|
+
feeAmountInCents: number;
|
|
1816
|
+
currency: Currency;
|
|
1817
|
+
}
|
|
1818
|
+
export declare enum TransactionIconType {
|
|
1819
|
+
Bank = 0,
|
|
1820
|
+
MobileWallet = 1,
|
|
1821
|
+
Card = 2,
|
|
1822
|
+
Cash = 3,
|
|
1823
|
+
Merchant = 4,
|
|
1824
|
+
QrCode = 5,
|
|
1825
|
+
DigitalWallet = 6,
|
|
1826
|
+
MTN = 7,
|
|
1827
|
+
Vodafone = 8,
|
|
1828
|
+
AirtelTigo = 9,
|
|
1829
|
+
GhanaPay = 10,
|
|
1830
|
+
Zeepay = 11,
|
|
1831
|
+
Glo = 12,
|
|
1832
|
+
Surfline = 13,
|
|
1833
|
+
Busy4G = 14,
|
|
1834
|
+
DSTV = 15,
|
|
1835
|
+
GoTV = 16,
|
|
1836
|
+
StarTimesTV = 17,
|
|
1837
|
+
ECG = 18,
|
|
1838
|
+
GhanaWater = 19,
|
|
1839
|
+
Telecel = 20
|
|
1840
|
+
}
|
|
1841
|
+
/** A model to hold the details of a pin or voucher code submission. */
|
|
1842
|
+
export declare class TransactionPin {
|
|
1843
|
+
/** A PIN or voucher code provided by an end user. */
|
|
1844
|
+
pin: string;
|
|
1845
|
+
}
|
|
1846
|
+
export declare enum TransactionStatus {
|
|
1847
|
+
NotStarted = 0,
|
|
1848
|
+
Success = 1,
|
|
1849
|
+
Failed = 2,
|
|
1850
|
+
Processing = 3,
|
|
1851
|
+
Pending = 4,
|
|
1852
|
+
Authorized = 5,
|
|
1853
|
+
Declined = 6,
|
|
1854
|
+
ValidationError = 7,
|
|
1855
|
+
Requires3DSecure = 8,
|
|
1856
|
+
RequiresPin = 9,
|
|
1857
|
+
Expired = 10,
|
|
1858
|
+
InsufficientFunds = 11,
|
|
1859
|
+
AddressVerificationFailed = 12,
|
|
1860
|
+
Ignored = 13,
|
|
1861
|
+
ExternallyFunded = 14,
|
|
1862
|
+
ProcessorUnavailable = 15,
|
|
1863
|
+
TimedOut = 16,
|
|
1864
|
+
Indeterminate = 17,
|
|
1865
|
+
RequiresConfirmation = 18,
|
|
1866
|
+
RequiresAddress = 19,
|
|
1867
|
+
Delayed = 20,
|
|
1868
|
+
RequiresInitialConfirmation = 21,
|
|
1869
|
+
Unrecoverable = 22,
|
|
1870
|
+
Reversed = 23
|
|
1871
|
+
}
|
|
1872
|
+
export declare enum TransactionType {
|
|
1873
|
+
Source = 1,
|
|
1874
|
+
Destination = 2
|
|
1875
|
+
}
|
|
1876
|
+
/** A model to hold the details of a web hook that a caller of this API would like to be called back on. */
|
|
1877
|
+
export declare class Webhook {
|
|
1878
|
+
/** The URL to call back on. */
|
|
1879
|
+
callbackUrl: string;
|
|
1880
|
+
/** A boolean value indicating whether callbacks should be sent every time there is a status change on any transaction associated with a payment, or only when the payment completes or any status change occurs that requires user intervention to allow the payment to progress. */
|
|
1881
|
+
onPaymentCompleteOnly: boolean;
|
|
1882
|
+
}
|
|
1883
|
+
export declare class EmailNotificationRequest {
|
|
1884
|
+
toEmailAddress: string;
|
|
1885
|
+
templateName?: string;
|
|
1886
|
+
receiptType: ReceiptType;
|
|
1887
|
+
}
|
|
1888
|
+
/** Model to hold the details of a merchant payment request. */
|
|
1889
|
+
export declare class MerchantPaymentRequest {
|
|
1890
|
+
/** A collection of all of the payment sources that must be used to make this payment. */
|
|
1891
|
+
paymentSources?: PaymentSources;
|
|
1892
|
+
/** The optional terminal reference if this payment is being made from a merchant controlled device. */
|
|
1893
|
+
terminalReference?: string;
|
|
1894
|
+
/** The optional QR code reference if this payment is being made from a scanned QR code. */
|
|
1895
|
+
qrCodeReference?: string;
|
|
1896
|
+
/** The optional timestamp from the client used to calculate an offline verification code. */
|
|
1897
|
+
timestamp?: number;
|
|
1898
|
+
notificationEmailAddress?: string;
|
|
1899
|
+
notificationMobileNumber?: string;
|
|
1900
|
+
tipAmountInCents: number;
|
|
1901
|
+
tipEmployeeReference?: string;
|
|
1902
|
+
language?: string;
|
|
1903
|
+
timeZone?: string;
|
|
1904
|
+
/** Specify the channel that this payment originated from. */
|
|
1905
|
+
channel: Channel;
|
|
1906
|
+
/**
|
|
1907
|
+
* A unique client reference for this payment.
|
|
1908
|
+
* This is optional to detect duplicate calls and also allow you to associate payments with your own internal reference numbers.
|
|
1909
|
+
*/
|
|
1910
|
+
yourReference?: string;
|
|
1911
|
+
/**
|
|
1912
|
+
* An optional reference that is associated with every transaction batch that participates in a split payment.
|
|
1913
|
+
* This is used for split payments in environments like restaurants where multiple transaction batches contribute to one common bill.
|
|
1914
|
+
* The client processing the split payment is responsible for generating this reference and ensuring that
|
|
1915
|
+
* all transaction batches that are part of the split payment are associated with the same split reference.
|
|
1916
|
+
*/
|
|
1917
|
+
splitReference?: string;
|
|
1918
|
+
/** Optional consumer information of the person making the payment. */
|
|
1919
|
+
consumer?: BasicConsumer;
|
|
1920
|
+
/** Optional merchant information of the business making the payment. */
|
|
1921
|
+
merchant?: BasicMerchant;
|
|
1922
|
+
/** The location from which the payment request was submitted. */
|
|
1923
|
+
location?: Location;
|
|
1924
|
+
/** Web hook details to be used to call back to the initiator of the payment with progress updates. */
|
|
1925
|
+
paymentStatusWebhook?: Webhook;
|
|
1926
|
+
/** A text description of the payment. Sometimes also referred to as a Narration. */
|
|
1927
|
+
description?: string;
|
|
1928
|
+
/**
|
|
1929
|
+
* A schedule definition to use to schedule payments to recur in the future.
|
|
1930
|
+
* If a schedule is supplied it must include either an end date or a repeat count and it must specify what repeat interval to use.
|
|
1931
|
+
*/
|
|
1932
|
+
recurrenceSchedule?: PaymentRecurrenceSchedule;
|
|
1933
|
+
/**
|
|
1934
|
+
* When a payment request instance is spawned by a recurrence schedule this property will be populated so that it is possible to lookup the specific schedule entry in the database
|
|
1935
|
+
* that is associated with payment request instance in question.
|
|
1936
|
+
*/
|
|
1937
|
+
scheduledSequenceNumber?: number;
|
|
1938
|
+
/**
|
|
1939
|
+
* In certain scenarios a confirmation may be requested from the client before transaction processing starts (confirming fees for example).
|
|
1940
|
+
* Use this flag to indicate that you want to automatically confirm any initial confirmations.
|
|
1941
|
+
*/
|
|
1942
|
+
disableInitialConfirmation: boolean;
|
|
1943
|
+
/** A list of line items associated with this payment. */
|
|
1944
|
+
lineItems: LineItem[];
|
|
1945
|
+
}
|
|
1946
|
+
/** Model to hold the details of a payment request. */
|
|
1947
|
+
export declare class PaymentRequest {
|
|
1948
|
+
/** A collection of all of the payment sources that must be used to make this payment. */
|
|
1949
|
+
paymentSources?: PaymentSources;
|
|
1950
|
+
/** A collection of all the payment destinations that must be paid as a result of processing this payment. */
|
|
1951
|
+
paymentDestinations?: PaymentDestinations;
|
|
1952
|
+
language?: string;
|
|
1953
|
+
timeZone?: string;
|
|
1954
|
+
/** Specify the channel that this payment originated from. */
|
|
1955
|
+
channel: Channel;
|
|
1956
|
+
/**
|
|
1957
|
+
* A unique client reference for this payment.
|
|
1958
|
+
* This is optional to detect duplicate calls and also allow you to associate payments with your own internal reference numbers.
|
|
1959
|
+
*/
|
|
1960
|
+
yourReference?: string;
|
|
1961
|
+
/**
|
|
1962
|
+
* An optional reference that is associated with every transaction batch that participates in a split payment.
|
|
1963
|
+
* This is used for split payments in environments like restaurants where multiple transaction batches contribute to one common bill.
|
|
1964
|
+
* The client processing the split payment is responsible for generating this reference and ensuring that
|
|
1965
|
+
* all transaction batches that are part of the split payment are associated with the same split reference.
|
|
1966
|
+
*/
|
|
1967
|
+
splitReference?: string;
|
|
1968
|
+
/** Optional consumer information of the person making the payment. */
|
|
1969
|
+
consumer?: BasicConsumer;
|
|
1970
|
+
/** Optional merchant information of the business making the payment. */
|
|
1971
|
+
merchant?: BasicMerchant;
|
|
1972
|
+
/** The location from which the payment request was submitted. */
|
|
1973
|
+
location?: Location;
|
|
1974
|
+
/** Web hook details to be used to call back to the initiator of the payment with progress updates. */
|
|
1975
|
+
paymentStatusWebhook?: Webhook;
|
|
1976
|
+
/** A text description of the payment. Sometimes also referred to as a Narration. */
|
|
1977
|
+
description?: string;
|
|
1978
|
+
/**
|
|
1979
|
+
* A schedule definition to use to schedule payments to recur in the future.
|
|
1980
|
+
* If a schedule is supplied it must include either an end date or a repeat count and it must specify what repeat interval to use.
|
|
1981
|
+
*/
|
|
1982
|
+
recurrenceSchedule?: PaymentRecurrenceSchedule;
|
|
1983
|
+
/**
|
|
1984
|
+
* When a payment request instance is spawned by a recurrence schedule this property will be populated so that it is possible to lookup the specific schedule entry in the database
|
|
1985
|
+
* that is associated with payment request instance in question.
|
|
1986
|
+
*/
|
|
1987
|
+
scheduledSequenceNumber?: number;
|
|
1988
|
+
/**
|
|
1989
|
+
* In certain scenarios a confirmation may be requested from the client before transaction processing starts (confirming fees for example).
|
|
1990
|
+
* Use this flag to indicate that you want to automatically confirm any initial confirmations.
|
|
1991
|
+
*/
|
|
1992
|
+
disableInitialConfirmation: boolean;
|
|
1993
|
+
/** A list of line items associated with this payment. */
|
|
1994
|
+
lineItems: LineItem[];
|
|
1995
|
+
}
|
|
1996
|
+
export declare class SmsNotificationRequest {
|
|
1997
|
+
toNumber: string;
|
|
1998
|
+
receiptType: ReceiptType;
|
|
1999
|
+
}
|
|
2000
|
+
export declare class GooglePayWebPaymentResponse {
|
|
2001
|
+
requestId: string;
|
|
2002
|
+
methodName: string;
|
|
2003
|
+
details: any;
|
|
2004
|
+
payerEmail?: string;
|
|
2005
|
+
payerName: string;
|
|
2006
|
+
payerPhone?: string;
|
|
2007
|
+
}
|
|
2008
|
+
export declare class ApplePayWebPaymentResponse {
|
|
2009
|
+
requestId: string;
|
|
2010
|
+
methodName: string;
|
|
2011
|
+
details: any;
|
|
2012
|
+
payerEmail?: string;
|
|
2013
|
+
payerName: string;
|
|
2014
|
+
payerPhone?: string;
|
|
2015
|
+
}
|