@vantagepay/vantagepay 0.17.4 → 0.18.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.
@@ -1,622 +0,0 @@
1
- import { Country } from '../lookups/types';
2
- import { Gender } from '../lookups/types';
3
- import { Language } from '../lookups/types';
4
- import { Currency } from '../lookups/types';
5
- import { BankAccountType } from '../common/types';
6
- import { Bank } from '../lookups/types';
7
- import { Month } from '../lookups/types';
8
- import { MobileWalletOperator } from '../lookups/types';
9
- import { LoginCredentials } from '../authentication/types';
10
- import { IdentityDocument } from '../common/types';
11
- import { Device } from '../devices/types';
12
- import { Address } from '../common/types';
13
- import { CardHolder } from '../payments/types';
14
- import { ConsumerFileType } from '../lookups/types';
15
- import { InsurancePolicyStatus } from '../lookups/types';
16
- import { LoanStatus } from '../lookups/types';
17
- import { KycProvider } from '../lookups/types';
18
- import { KycStatus } from '../lookups/types';
19
- import { KycVerificationType } from '../lookups/types';
20
- import { TransactionLimitType } from '../common/types';
21
- import { LimitResetPeriod } from '../common/types';
22
- /** Model to hold basic consumer details. */
23
- export declare class BasicConsumer {
24
- /** Gets or sets the consumer reference. */
25
- reference?: string;
26
- /** Gets or sets the consumer external reference if linked to another system. */
27
- yourReference?: string;
28
- /** Gets or sets the current originator source of the consumer. */
29
- source: string;
30
- /** Gets the user reference associated with the user. */
31
- userReference?: string;
32
- /** Gets or sets the first name of the consumer (required). */
33
- firstName?: string;
34
- /** Gets or sets the last name (surname) of the consumer (required if IdentityNumber is not supplied). */
35
- lastName?: string;
36
- /** Gets or sets the middle name of the consumer. */
37
- middleName?: string;
38
- /** Gets or sets the email address for the consumer. */
39
- emailAddress?: string;
40
- /** Gets or sets the mobile number for the consumer. */
41
- mobileNumber?: string;
42
- /** Gets or sets 3 character ISO country code the consumer resides in. */
43
- countryIsoCode: Country;
44
- /** Gets or sets the date of birth of the consumer. */
45
- dateOfBirth?: Date;
46
- /** Gets or sets the gender of the consumer. */
47
- gender?: Gender;
48
- /** Gets or sets the language code preference of the consumer. */
49
- preferredLanguage: Language;
50
- /** Gets the KYC summary status. */
51
- kycStatusSummary: KycStatusSummary;
52
- isActive: boolean;
53
- }
54
- /** Model to hold consumer beneficiary details. */
55
- export declare class Beneficiary {
56
- /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific beneficiary. */
57
- reference?: string;
58
- /** Gets or sets the beneficiary external reference if linked to another system. */
59
- yourReference?: string;
60
- /** The beneficiary name. */
61
- name: string;
62
- /** The contact number for this beneficiary. */
63
- contactNumber?: string;
64
- /** The date and time of the last transaction made to this beneficiary account. */
65
- lastTransactionDate?: Date;
66
- /** The amount in cents of the last transaction made to this beneficiary account. */
67
- lastTransactionAmountInCents?: number;
68
- /** The currency of the last transaction made to this beneficiary account. */
69
- lastTransactionCurrency?: Currency;
70
- /** A list of bank accounts associated with a beneficiary. */
71
- bankAccounts: BeneficiaryBankAccount[];
72
- /** A list of mobile wallets associated with a beneficiary. */
73
- mobileWallets: BeneficiaryMobileWallet[];
74
- /** A list of cards associated with a beneficiary. */
75
- cards: BeneficiaryCard[];
76
- /** A list of generic accounts (mobile numbers, meter numbers, etc) associated with a beneficiary. */
77
- genericAccounts: BeneficiaryGenericAccount[];
78
- isActive: boolean;
79
- }
80
- /** Model to hold the unique details for a bank account beneficiary. */
81
- export declare class BeneficiaryBankAccount {
82
- /** The bank account token that was generated by the system. */
83
- token?: string;
84
- accountNumber: string;
85
- /** The bank account type. */
86
- bankAccountType: BankAccountType;
87
- bankAccountTypeName: string;
88
- bank: Bank;
89
- bankName: string;
90
- /** The branch code associated with the bank which holds the bank account. */
91
- routingCode?: string;
92
- createdDate: Date;
93
- /** A globally unique reference (UUID) generated by the system internally to identify a specific beneficiary account. */
94
- reference?: string;
95
- /** A 3 character ISO currency code. */
96
- currency: Currency;
97
- /** The details which add sufficient context behind the money transfer to the beneficiary. */
98
- recipientReference?: string;
99
- /** The details which add sufficient context behind the money transfer to the consumer. */
100
- senderReference?: string;
101
- /** A flag indicating whether the consumer requires a notification to be sent to the beneficiary after a successful money transfer. */
102
- sendProofOfPayment: boolean;
103
- /** The email address for the beneficiary. */
104
- proofOfPaymentEmailAddress?: string;
105
- /** The mobile number for the beneficiary. */
106
- proofOfPaymentMobileNumber?: string;
107
- isActive: boolean;
108
- }
109
- /** Model to hold the unique details for a bank account beneficiary. */
110
- export declare class BeneficiaryCard {
111
- /** The bank account token that was generated by the system. */
112
- token?: string;
113
- /** The full card number. */
114
- cardNumber: string;
115
- /** The name of the card holder as printed on the card. */
116
- nameOnCard: string;
117
- /** The month in which the card expires. */
118
- expiryMonth: Month;
119
- /** The year in which the card expires. */
120
- expiryYear: number;
121
- cardIssuer: string;
122
- createdDate: Date;
123
- /** A globally unique reference (UUID) generated by the system internally to identify a specific beneficiary account. */
124
- reference?: string;
125
- /** A 3 character ISO currency code. */
126
- currency: Currency;
127
- /** The details which add sufficient context behind the money transfer to the beneficiary. */
128
- recipientReference?: string;
129
- /** The details which add sufficient context behind the money transfer to the consumer. */
130
- senderReference?: string;
131
- /** A flag indicating whether the consumer requires a notification to be sent to the beneficiary after a successful money transfer. */
132
- sendProofOfPayment: boolean;
133
- /** The email address for the beneficiary. */
134
- proofOfPaymentEmailAddress?: string;
135
- /** The mobile number for the beneficiary. */
136
- proofOfPaymentMobileNumber?: string;
137
- isActive: boolean;
138
- }
139
- /** Model to hold the unique details for a beneficiary generic account (mobile number, meter number, etc). */
140
- export declare class BeneficiaryGenericAccount {
141
- /** The account number (can be a mobile number, meter number, etc). */
142
- accountNumber: string;
143
- /** The type of generic account. */
144
- genericAccountType: GenericAccountType;
145
- genericAccountTypeName: string;
146
- createdDate: Date;
147
- /** A globally unique reference (UUID) generated by the system internally to identify a specific beneficiary account. */
148
- reference?: string;
149
- /** A 3 character ISO currency code. */
150
- currency: Currency;
151
- /** The details which add sufficient context behind the money transfer to the beneficiary. */
152
- recipientReference?: string;
153
- /** The details which add sufficient context behind the money transfer to the consumer. */
154
- senderReference?: string;
155
- /** A flag indicating whether the consumer requires a notification to be sent to the beneficiary after a successful money transfer. */
156
- sendProofOfPayment: boolean;
157
- /** The email address for the beneficiary. */
158
- proofOfPaymentEmailAddress?: string;
159
- /** The mobile number for the beneficiary. */
160
- proofOfPaymentMobileNumber?: string;
161
- isActive: boolean;
162
- }
163
- /** Model to hold the unique details for a mobile money beneficiary. */
164
- export declare class BeneficiaryMobileWallet {
165
- /**
166
- * Mobile Station International Subscriber Directory Number (MSISDN) is a number used to identify a mobile phone number internationally.
167
- * This number includes a country code and a National Destination Code which identifies the subscriber's operator.
168
- */
169
- msisdn: string;
170
- /** The mobile wallet operator that owns the mobile money account. */
171
- mobileWalletOperator: MobileWalletOperator;
172
- mobileWalletOperatorName: string;
173
- createdDate: Date;
174
- /** A globally unique reference (UUID) generated by the system internally to identify a specific beneficiary account. */
175
- reference?: string;
176
- /** A 3 character ISO currency code. */
177
- currency: Currency;
178
- /** The details which add sufficient context behind the money transfer to the beneficiary. */
179
- recipientReference?: string;
180
- /** The details which add sufficient context behind the money transfer to the consumer. */
181
- senderReference?: string;
182
- /** A flag indicating whether the consumer requires a notification to be sent to the beneficiary after a successful money transfer. */
183
- sendProofOfPayment: boolean;
184
- /** The email address for the beneficiary. */
185
- proofOfPaymentEmailAddress?: string;
186
- /** The mobile number for the beneficiary. */
187
- proofOfPaymentMobileNumber?: string;
188
- isActive: boolean;
189
- }
190
- /** Model to hold consumer card settings and preferences. */
191
- export declare class CardSettings {
192
- /** Gets or sets a value indicating whether tap to pay functionality is allowed for this card. */
193
- allowTapToPay: boolean;
194
- /** Gets or sets a value indicating whether a PIN should always be requested for transactions with this card. */
195
- alwaysAskForPin: boolean;
196
- /** Gets or sets a value indicating whether online banking is enabled. */
197
- isOnlineBankingEnabled: boolean;
198
- onlineBankingLastUsedDate?: Date;
199
- /** Gets or sets a value indicating whether mobile banking features are enabled. */
200
- isMobileBankingEnabled: boolean;
201
- mobileBankingLastUsedDate?: Date;
202
- /** Gets or sets a value indicating whether USSD banking functionality is enabled. */
203
- isUssdBankingEnabled: boolean;
204
- ussdBankingLastUsedDate?: Date;
205
- }
206
- /** Model to hold detailed consumer details. */
207
- export declare class Consumer {
208
- /** The date and time this consumer record was created. */
209
- createdDate: Date;
210
- /** Gets or sets the login credentials that this consumer can use to access their data. */
211
- loginCredentials?: LoginCredentials;
212
- /** Gets or sets the preferred name of the consumer. */
213
- preferredName?: string;
214
- /** Gets or sets the full name of a consumer's next of kin. */
215
- fullNameOfNextOfKin?: string;
216
- /** Gets or sets the contact number for a consumer's next of kin. */
217
- contactNumberForNextOfKin?: string;
218
- /** Gets or sets an alternate contact number for the consumer. */
219
- alternateContactNumber?: string;
220
- /** Gets or sets the invitation code for the consumer. */
221
- invitationCode?: string;
222
- /** Gets or sets a flag to indicate whether registration details have been captured by the consumer themselves. */
223
- isRegistrationComplete: boolean;
224
- /** Gets or sets a flag to indicate whether the consumer has verified their email address details yet or not. */
225
- isEmailVerified: boolean;
226
- /** Gets or sets a flag to indicate whether the consumer has verified their mobile number yet or not. */
227
- isMobileNumberVerified: boolean;
228
- /** Gets the available identification documentation information for the consumer. */
229
- identityDocuments: IdentityDocument[];
230
- /** Gets a list of KYC lookups related to the consumer. */
231
- kycLookupResults: KycLookupResult[];
232
- /** Gets a list of files related to the consumer. */
233
- files: ConsumerFile[];
234
- /** Gets a list of consumer devices. */
235
- devices: Device[];
236
- /** Gets the list of available addresses for the consumer. */
237
- addresses: Address[];
238
- /** A collection of available beneficiaries associated with the consumer. */
239
- beneficiaries: Beneficiary[];
240
- /** A collection of all financial institution accounts associated with the consumer. */
241
- accounts: ConsumerAccounts;
242
- /** Gets the attributes. */
243
- attributes: ConsumerAttributeValue[];
244
- rewardPointsInfo?: RewardPointsInfo;
245
- /** Gets or sets the consumer reference. */
246
- reference?: string;
247
- /** Gets or sets the consumer external reference if linked to another system. */
248
- yourReference?: string;
249
- /** Gets or sets the current originator source of the consumer. */
250
- source: string;
251
- /** Gets the user reference associated with the user. */
252
- userReference?: string;
253
- /** Gets or sets the first name of the consumer (required). */
254
- firstName?: string;
255
- /** Gets or sets the last name (surname) of the consumer (required if IdentityNumber is not supplied). */
256
- lastName?: string;
257
- /** Gets or sets the middle name of the consumer. */
258
- middleName?: string;
259
- /** Gets or sets the email address for the consumer. */
260
- emailAddress?: string;
261
- /** Gets or sets the mobile number for the consumer. */
262
- mobileNumber?: string;
263
- /** Gets or sets 3 character ISO country code the consumer resides in. */
264
- countryIsoCode: Country;
265
- /** Gets or sets the date of birth of the consumer. */
266
- dateOfBirth?: Date;
267
- /** Gets or sets the gender of the consumer. */
268
- gender?: Gender;
269
- /** Gets or sets the language code preference of the consumer. */
270
- preferredLanguage: Language;
271
- /** Gets the KYC summary status. */
272
- kycStatusSummary: KycStatusSummary;
273
- isActive: boolean;
274
- }
275
- export declare class ConsumerAccounts {
276
- /** A list of bank accounts associated with a consumer. */
277
- bankAccounts: ConsumerBankAccount[];
278
- /** A list of mobile money / wallet accounts associated with a consumer. */
279
- mobileWallets: ConsumerMobileWallet[];
280
- /** A list of loan accounts associated with a consumer. */
281
- loanAccounts: ConsumerLoanAccount[];
282
- /** A list of insurance policies associated with a consumer. */
283
- insurancePolicies: ConsumerInsurancePolicy[];
284
- /** A list of generic accounts (mobile numbers, meter numbers, etc) associated with a consumer. */
285
- genericAccounts: ConsumerGenericAccount[];
286
- /** A list of cards associated with a consumer. */
287
- cards: ConsumerCard[];
288
- }
289
- export declare enum ConsumerAttribute {
290
- VisaPAN = 1,
291
- MasterCardPAN = 2,
292
- RegistrationInvitationCode = 3,
293
- GMoneyWalletNumber = 4,
294
- LinkedGcbBankAccountReferences = 5,
295
- MarketingConsent = 6,
296
- CommunicationOutsideRegularHoursConsent = 7,
297
- PrimarySourceOfFunds = 8
298
- }
299
- /** Model to hold various attributes about a consumer. */
300
- export declare class ConsumerAttributeValue {
301
- name?: string;
302
- attribute: ConsumerAttribute;
303
- value: string;
304
- }
305
- export declare class ConsumerBankAccount {
306
- /** The bank account token that was generated by the system. */
307
- token?: string;
308
- accountNumber: string;
309
- /** The bank account type. */
310
- bankAccountType?: BankAccountType;
311
- bankAccountTypeName?: string;
312
- bank: Bank;
313
- bankName: string;
314
- branchName?: string;
315
- /** The branch code associated with the bank which holds the bank account. */
316
- routingCode?: string;
317
- linkedCardReferences: string[];
318
- /** Gets or sets the card settings and preferences that apply to this bank account and all linked cards. When updated, these settings cascade to all linked cards. */
319
- linkedCardSettings?: CardSettings;
320
- /** Collection of debit orders linked to this bank account. */
321
- debitOrders: DebitOrder[];
322
- createdDate: Date;
323
- /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer account. */
324
- reference?: string;
325
- /** Gets or sets the external reference if linked to another system. */
326
- yourReference?: string;
327
- /** A 3 character ISO currency code. */
328
- currency: Currency;
329
- /** The name of the account. */
330
- accountName: string;
331
- isActive: boolean;
332
- iconUrl?: string;
333
- linkedFileReferences: string[];
334
- }
335
- export declare class ConsumerCard {
336
- /** Additional customer information to facilitate the card payment. */
337
- cardHolder: CardHolder;
338
- /** The card token that was generated by the system. */
339
- token?: string;
340
- cardIssuer: string;
341
- /** The full card number. */
342
- cardNumber: string;
343
- /** The name of the card holder as printed on the card. */
344
- nameOnCard: string;
345
- /** The month in which the card expires. */
346
- expiryMonth: Month;
347
- /** The year in which the card expires. */
348
- expiryYear: number;
349
- /** Gets the list of linked bank account references. */
350
- linkedBankAccountReferences: string[];
351
- /** Gets or sets the card settings and preferences. */
352
- cardSettings?: CardSettings;
353
- createdDate: Date;
354
- /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer account. */
355
- reference?: string;
356
- /** Gets or sets the external reference if linked to another system. */
357
- yourReference?: string;
358
- /** A 3 character ISO currency code. */
359
- currency: Currency;
360
- /** The name of the account. */
361
- accountName: string;
362
- isActive: boolean;
363
- iconUrl?: string;
364
- linkedFileReferences: string[];
365
- }
366
- export declare class ConsumerFile {
367
- fileType: ConsumerFileType;
368
- kycResults: KycFileResult[];
369
- reference?: string;
370
- yourReference?: string;
371
- description?: string;
372
- fileName: string;
373
- mimeType: string;
374
- base64Data?: string;
375
- createdDate: Date;
376
- lastUpdatedDate?: Date;
377
- isActive: boolean;
378
- }
379
- /** Model to hold the unique details for a generic account (mobile number, meter number, etc). */
380
- export declare class ConsumerGenericAccount {
381
- /** The account number (can be a mobile number, meter number, etc). */
382
- accountNumber: string;
383
- /** The type of generic account. */
384
- genericAccountType: GenericAccountType;
385
- genericAccountTypeName: string;
386
- createdDate: Date;
387
- /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer account. */
388
- reference?: string;
389
- /** Gets or sets the external reference if linked to another system. */
390
- yourReference?: string;
391
- /** A 3 character ISO currency code. */
392
- currency: Currency;
393
- /** The name of the account. */
394
- accountName: string;
395
- isActive: boolean;
396
- iconUrl?: string;
397
- linkedFileReferences: string[];
398
- }
399
- export declare class ConsumerInsurancePolicy {
400
- policyNumber: string;
401
- coverAmountInCents: number;
402
- premiumAmountInCents: number;
403
- description?: string;
404
- beneficiaries: ConsumerInsurancePolicyBeneficiary[];
405
- status: InsurancePolicyStatus;
406
- createdDate: Date;
407
- /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer account. */
408
- reference?: string;
409
- /** Gets or sets the external reference if linked to another system. */
410
- yourReference?: string;
411
- /** A 3 character ISO currency code. */
412
- currency: Currency;
413
- /** The name of the account. */
414
- accountName: string;
415
- isActive: boolean;
416
- iconUrl?: string;
417
- linkedFileReferences: string[];
418
- }
419
- export declare class ConsumerInsurancePolicyBeneficiary {
420
- reference?: string;
421
- firstName: string;
422
- lastName: string;
423
- contactNumber?: string;
424
- dateOfBirth?: Date;
425
- relationship?: string;
426
- percentage: number;
427
- }
428
- export declare class ConsumerLoanAccount {
429
- contractNumber: string;
430
- loanType: string;
431
- loanSource: string;
432
- status: LoanStatus;
433
- originalCapitalInCents: number;
434
- settlementAmountInCents: number;
435
- outstandingBalanceInCents: number;
436
- installmentAmountInCents: number;
437
- arrearsAmountInCents: number;
438
- installmentsRemaining: number;
439
- annualInterestRatePercentage: number;
440
- nextInstallmentDate?: Date;
441
- lastPaymentDate?: Date;
442
- startDate: Date;
443
- endDate: Date;
444
- term: number;
445
- /** Whether the loan is currently in arrears (past due). */
446
- isInArrears: boolean;
447
- /** Whether the loan has been fully paid. */
448
- isFullyPaid: boolean;
449
- /** Percentage of loan that has been repaid. */
450
- repaymentPercentage: number;
451
- createdDate: Date;
452
- /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer account. */
453
- reference?: string;
454
- /** Gets or sets the external reference if linked to another system. */
455
- yourReference?: string;
456
- /** A 3 character ISO currency code. */
457
- currency: Currency;
458
- /** The name of the account. */
459
- accountName: string;
460
- isActive: boolean;
461
- iconUrl?: string;
462
- linkedFileReferences: string[];
463
- }
464
- export declare class ConsumerMobileWallet {
465
- /**
466
- * Mobile Station International Subscriber Directory Number (MSISDN) is a number used to identify a mobile phone number internationally.
467
- * This number includes a country code and a National Destination Code which identifies the subscriber's operator.
468
- */
469
- msisdn: string;
470
- /** The mobile wallet operator that owns the mobile money account. */
471
- mobileWalletOperator: MobileWalletOperator;
472
- createdDate: Date;
473
- /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer account. */
474
- reference?: string;
475
- /** Gets or sets the external reference if linked to another system. */
476
- yourReference?: string;
477
- /** A 3 character ISO currency code. */
478
- currency: Currency;
479
- /** The name of the account. */
480
- accountName: string;
481
- isActive: boolean;
482
- iconUrl?: string;
483
- linkedFileReferences: string[];
484
- }
485
- export declare class DebitOrder {
486
- /** A globally unique reference (UUID) generated by the system to identify this debit order. */
487
- reference?: string;
488
- /** External reference from the source system (e.g., USN from Lesaka). */
489
- yourReference?: string;
490
- /** The reference of the debit order instruction. */
491
- instructionReference: string;
492
- /** The date the debit order was created in our system. */
493
- createdDate: Date;
494
- /** The date when the debit order is scheduled to be actioned. */
495
- debitOrderDate: Date;
496
- /** Description of the debit order. */
497
- description: string;
498
- /** Amount in cents. */
499
- amountInCents: number;
500
- /** Currency of the debit order. */
501
- currency: Currency;
502
- /** Indicates whether the debit order can be stopped by the consumer. */
503
- canBeStopped: boolean;
504
- /** Indicates whether the debit order can be disputed by the consumer. */
505
- canBeDisputed: boolean;
506
- /** Indicates whether the debit order has been stopped by the consumer. */
507
- isStopped: boolean;
508
- /** Indicates whether the debit order has been disputed by the consumer. */
509
- isDisputed: boolean;
510
- /** The date when the debit order was stopped (read-only). */
511
- stoppedDate?: Date;
512
- /** The date when the debit order was disputed (read-only). */
513
- disputedDate?: Date;
514
- /** Whether the debit order action date is in the future. */
515
- isFuture: boolean;
516
- }
517
- /** Request to dispute a debit order. */
518
- export declare class DisputeDebitOrdersRequest {
519
- /** The debit order references to dispute. */
520
- debitOrderReferences: string[];
521
- }
522
- export declare class Feedback {
523
- description?: string;
524
- }
525
- export declare enum GenericAccountType {
526
- None = "None",
527
- MobileNumber = "MobileNumber",
528
- WaterMeter = "WaterMeter",
529
- ElectricityMeter = "ElectricityMeter",
530
- PayShap = "PayShap",
531
- DStv = "DStv",
532
- EasyPay = "EasyPay"
533
- }
534
- /** The KYC file result. */
535
- export declare class KycFileResult {
536
- /** Gets or sets the unique identifier for the KYC service provider used to retrieve the consumer KYC data. */
537
- provider: KycProvider;
538
- /** Gets or sets the status of the particular KYC verification. */
539
- status: KycStatus;
540
- /** Gets or sets the consumer KYC verification type. */
541
- verificationType: KycVerificationType;
542
- /** Gets or sets the KYC provider reference associated with the KYC Lookup. */
543
- providerReference?: string;
544
- /** Gets the created date of the KYC lookup result. */
545
- createdDate: Date;
546
- /** Gets or sets the last date and time of when the KYC data was updated. */
547
- lastUpdatedDate?: Date;
548
- }
549
- /** The KYC lookup result. */
550
- export declare class KycLookupResult {
551
- /** Gets or sets the unique identifier for the KYC service provider used to retrieve the consumer KYC data. */
552
- provider: KycProvider;
553
- /** Gets or sets the status of the particular KYC verification. */
554
- status: KycStatus;
555
- /** Gets or sets the consumer KYC verification type. */
556
- verificationType: KycVerificationType;
557
- /** Gets or sets the KYC provider reference associated with the KYC Lookup. */
558
- providerReference?: string;
559
- /** Gets the created date of the KYC lookup result. */
560
- createdDate: Date;
561
- /** Gets or sets the last date and time of when the KYC data was updated. */
562
- lastUpdatedDate?: Date;
563
- }
564
- export declare enum KycStatusSummary {
565
- Unverified = "Unverified",
566
- Verified = "Verified",
567
- Rejected = "Rejected"
568
- }
569
- /** Model to hold consumer message details. */
570
- export declare class Message {
571
- /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific message. */
572
- reference?: string;
573
- /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer. */
574
- consumerReference: string;
575
- /** A short text string which briefly summarizes the message details. */
576
- messageSummary: string;
577
- /** The full consumer message text. */
578
- messageDetail: string;
579
- /** The date and time this consumer message was created. */
580
- createdDate: Date;
581
- /** A flag indicating whether the message has been deleted or not. */
582
- isDeleted: boolean;
583
- }
584
- export declare class RewardPointsInfo {
585
- pointsBalance: number;
586
- rewardTier: number;
587
- creditTransactionCount: number;
588
- }
589
- /** Request to stop a consumer card. */
590
- export declare class StopCardRequest {
591
- /** The card reference to stop. */
592
- cardReference: string;
593
- /** The reason for stopping the card. */
594
- reason?: string;
595
- }
596
- /** Request to stop a debit order. */
597
- export declare class StopDebitOrdersRequest {
598
- /** The debit order references to stop. */
599
- debitOrderReferences: string[];
600
- }
601
- export declare class BankAccountLimit {
602
- /** The transaction limit type (ATM, Payment, Transfer, etc.). */
603
- transactionLimitType: TransactionLimitType;
604
- transactionLimitTypeName: string;
605
- /** The reset period for this limit (PerTransaction, Daily, Weekly, Monthly, Yearly). */
606
- resetPeriod: LimitResetPeriod;
607
- resetPeriodName: string;
608
- /** The maximum amount allowed in cents for this transaction type and reset period. */
609
- limitAmountInCents: number;
610
- /** The amount already used in cents for this transaction type and reset period. */
611
- usedAmountInCents: number;
612
- /** The amount remaining in cents for this transaction type and reset period. */
613
- remainingAmountInCents: number;
614
- }
615
- export declare class BankAccountLimitChange {
616
- /** The transaction limit type (ATM, Payment, Transfer, etc.). */
617
- transactionLimitType: TransactionLimitType;
618
- /** The reset period for this limit (PerTransaction, Daily, Weekly, Monthly, Yearly). */
619
- resetPeriod: LimitResetPeriod;
620
- /** The maximum amount allowed in cents for this transaction type and reset period. */
621
- newLimitAmountInCents: number;
622
- }
@@ -1,7 +0,0 @@
1
- import { BaseApi } from '../baseApi';
2
- export declare class Content extends BaseApi {
3
- private clientContentCache;
4
- private contactDetailsCache;
5
- getClientContent(): Promise<any>;
6
- getContactDetails(): Promise<any>;
7
- }
@@ -1,20 +0,0 @@
1
- export declare class Device {
2
- createdDate: Date;
3
- lastUsedDate?: Date;
4
- reference?: string;
5
- yourReference?: string;
6
- platform: DevicePlatform;
7
- deviceType?: string;
8
- brand?: string;
9
- model?: string;
10
- serialNumber?: string;
11
- operatingSystemVersion?: string;
12
- softwareVersion?: string;
13
- pushNotificationToken?: string;
14
- }
15
- export declare enum DevicePlatform {
16
- Unknown = "Unknown",
17
- Android = "Android",
18
- iOS = "iOS",
19
- Web = "Web"
20
- }
@@ -1,11 +0,0 @@
1
- export declare const OnSessionStarted: unique symbol;
2
- export declare const OnSessionExpired: unique symbol;
3
- export declare const OnAutomaticRefresh: unique symbol;
4
- export declare const OnApiRetry: unique symbol;
5
- export declare const OnPaymentStatusUpdate: unique symbol;
6
- export declare const OnPaymentComplete: unique symbol;
7
- export declare const OnRequires3DSecure: unique symbol;
8
- export declare const OnRequiresPin: unique symbol;
9
- export declare const OnRequiresConfirmation: unique symbol;
10
- export declare const OnRequiresAddress: unique symbol;
11
- export declare const OnComplete3DSecure: unique symbol;