@vantagepay/vantagepay 0.17.0 → 0.17.1

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.
@@ -5,6 +5,8 @@ import { IdentityDocumentType } from '../lookups/types';
5
5
  export declare class Address {
6
6
  /** Gets the address reference. */
7
7
  reference?: string;
8
+ /** Gets or sets the address external reference if linked to another system. */
9
+ yourReference?: string;
8
10
  /** Gets or sets the type of address the details are referring to. */
9
11
  addressType: AddressType;
10
12
  /** Gets or sets first line of the address (required). */
@@ -46,7 +48,8 @@ export declare enum BankAccountType {
46
48
  CURRENT = "CURRENT",
47
49
  FIXED = "FIXED",
48
50
  MONEYMARKET = "MONEYMARKET",
49
- CODA = "CODA"
51
+ CODA = "CODA",
52
+ BOND = "BOND"
50
53
  }
51
54
  /** Model to capture generic contact/lead data. */
52
55
  export declare class ContactDetails {
@@ -12,6 +12,8 @@ import { Device } from '../devices/types';
12
12
  import { Address } from '../common/types';
13
13
  import { CardHolder } from '../payments/types';
14
14
  import { ConsumerFileType } from '../lookups/types';
15
+ import { InsurancePolicyStatus } from '../lookups/types';
16
+ import { LoanStatus } from '../lookups/types';
15
17
  import { KycProvider } from '../lookups/types';
16
18
  import { KycStatus } from '../lookups/types';
17
19
  import { KycVerificationType } from '../lookups/types';
@@ -51,6 +53,8 @@ export declare class BasicConsumer {
51
53
  export declare class Beneficiary {
52
54
  /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific beneficiary. */
53
55
  reference?: string;
56
+ /** Gets or sets the beneficiary external reference if linked to another system. */
57
+ yourReference?: string;
54
58
  /** The beneficiary name. */
55
59
  name: string;
56
60
  /** The contact number for this beneficiary. */
@@ -300,12 +304,16 @@ export declare class ConsumerBankAccount {
300
304
  /** The branch code associated with the bank which holds the bank account. */
301
305
  routingCode?: string;
302
306
  linkedCardReferences: string[];
307
+ /** Gets or sets the card settings and preferences. */
308
+ cardSettings?: CardSettings;
303
309
  createdDate: Date;
304
310
  /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer account. */
305
311
  reference?: string;
312
+ /** Gets or sets the external reference if linked to another system. */
313
+ yourReference?: string;
306
314
  /** A 3 character ISO currency code. */
307
315
  currency: Currency;
308
- /** The details which add sufficient context behind the account to the consumer. */
316
+ /** The name of the account. */
309
317
  accountName: string;
310
318
  isActive: boolean;
311
319
  iconUrl?: string;
@@ -328,13 +336,15 @@ export declare class ConsumerCard {
328
336
  /** Gets the list of linked bank account references. */
329
337
  linkedBankAccountReferences: string[];
330
338
  /** Gets or sets the card settings and preferences. */
331
- settings?: CardSettings;
339
+ cardSettings?: CardSettings;
332
340
  createdDate: Date;
333
341
  /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer account. */
334
342
  reference?: string;
343
+ /** Gets or sets the external reference if linked to another system. */
344
+ yourReference?: string;
335
345
  /** A 3 character ISO currency code. */
336
346
  currency: Currency;
337
- /** The details which add sufficient context behind the account to the consumer. */
347
+ /** The name of the account. */
338
348
  accountName: string;
339
349
  isActive: boolean;
340
350
  iconUrl?: string;
@@ -362,9 +372,11 @@ export declare class ConsumerGenericAccount {
362
372
  createdDate: Date;
363
373
  /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer account. */
364
374
  reference?: string;
375
+ /** Gets or sets the external reference if linked to another system. */
376
+ yourReference?: string;
365
377
  /** A 3 character ISO currency code. */
366
378
  currency: Currency;
367
- /** The details which add sufficient context behind the account to the consumer. */
379
+ /** The name of the account. */
368
380
  accountName: string;
369
381
  isActive: boolean;
370
382
  iconUrl?: string;
@@ -375,20 +387,35 @@ export declare class ConsumerInsurancePolicy {
375
387
  coverAmountInCents: number;
376
388
  premiumAmountInCents: number;
377
389
  description?: string;
378
- beneficiaryName?: string;
390
+ beneficiaries: ConsumerInsurancePolicyBeneficiary[];
391
+ status: InsurancePolicyStatus;
379
392
  createdDate: Date;
380
393
  /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer account. */
381
394
  reference?: string;
395
+ /** Gets or sets the external reference if linked to another system. */
396
+ yourReference?: string;
382
397
  /** A 3 character ISO currency code. */
383
398
  currency: Currency;
384
- /** The details which add sufficient context behind the account to the consumer. */
399
+ /** The name of the account. */
385
400
  accountName: string;
386
401
  isActive: boolean;
387
402
  iconUrl?: string;
388
403
  linkedFileReferences: string[];
389
404
  }
405
+ export declare class ConsumerInsurancePolicyBeneficiary {
406
+ reference?: string;
407
+ firstName: string;
408
+ lastName: string;
409
+ contactNumber?: string;
410
+ dateOfBirth?: Date;
411
+ relationship?: string;
412
+ percentage: number;
413
+ }
390
414
  export declare class ConsumerLoanAccount {
391
415
  contractNumber: string;
416
+ loanType: string;
417
+ loanSource: string;
418
+ status: LoanStatus;
392
419
  originalCapitalInCents: number;
393
420
  settlementAmountInCents: number;
394
421
  outstandingBalanceInCents: number;
@@ -396,9 +423,11 @@ export declare class ConsumerLoanAccount {
396
423
  arrearsAmountInCents: number;
397
424
  installmentsRemaining: number;
398
425
  annualInterestRatePercentage: number;
399
- nextInstallmentDate: Date;
426
+ nextInstallmentDate?: Date;
427
+ lastPaymentDate?: Date;
400
428
  startDate: Date;
401
429
  endDate: Date;
430
+ term: number;
402
431
  /** Whether the loan is currently in arrears (past due). */
403
432
  isInArrears: boolean;
404
433
  /** Whether the loan has been fully paid. */
@@ -408,9 +437,11 @@ export declare class ConsumerLoanAccount {
408
437
  createdDate: Date;
409
438
  /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer account. */
410
439
  reference?: string;
440
+ /** Gets or sets the external reference if linked to another system. */
441
+ yourReference?: string;
411
442
  /** A 3 character ISO currency code. */
412
443
  currency: Currency;
413
- /** The details which add sufficient context behind the account to the consumer. */
444
+ /** The name of the account. */
414
445
  accountName: string;
415
446
  isActive: boolean;
416
447
  iconUrl?: string;
@@ -427,9 +458,11 @@ export declare class ConsumerMobileWallet {
427
458
  createdDate: Date;
428
459
  /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer account. */
429
460
  reference?: string;
461
+ /** Gets or sets the external reference if linked to another system. */
462
+ yourReference?: string;
430
463
  /** A 3 character ISO currency code. */
431
464
  currency: Currency;
432
- /** The details which add sufficient context behind the account to the consumer. */
465
+ /** The name of the account. */
433
466
  accountName: string;
434
467
  isActive: boolean;
435
468
  iconUrl?: string;