@vantagepay/vantagepay 0.16.0 → 0.17.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.
@@ -68,40 +68,9 @@ export declare class Beneficiary {
68
68
  /** A list of cards associated with a beneficiary. */
69
69
  cards: BeneficiaryCard[];
70
70
  /** A list of generic accounts (mobile numbers, meter numbers, etc) associated with a beneficiary. */
71
- accounts: BeneficiaryAccount[];
71
+ genericAccounts: BeneficiaryGenericAccount[];
72
72
  isActive: boolean;
73
73
  }
74
- /** Model to hold the unique details for a generic beneficiary account (mobile number, meter number, etc). */
75
- export declare class BeneficiaryAccount {
76
- /** The account number (can be a mobile number, meter number, etc). */
77
- accountNumber: string;
78
- /** The type of beneficiary account. */
79
- beneficiaryAccountType: BeneficiaryAccountType;
80
- beneficiaryAccountTypeName: string;
81
- createdDate: Date;
82
- /** A globally unique reference (UUID) generated by the system internally to identify a specific beneficiary account. */
83
- reference?: string;
84
- /** A 3 character ISO currency code. */
85
- currency: Currency;
86
- /** The details which add sufficient context behind the money transfer to the beneficiary. */
87
- recipientReference?: string;
88
- /** The details which add sufficient context behind the money transfer to the consumer. */
89
- senderReference?: string;
90
- /** A flag indicating whether the consumer requires a notification to be sent to the beneficiary after a successful money transfer. */
91
- sendProofOfPayment: boolean;
92
- /** The email address for the beneficiary. */
93
- proofOfPaymentEmailAddress?: string;
94
- /** The mobile number for the beneficiary. */
95
- proofOfPaymentMobileNumber?: string;
96
- isActive: boolean;
97
- }
98
- export declare enum BeneficiaryAccountType {
99
- None = "None",
100
- MobileNumber = "MobileNumber",
101
- WaterMeter = "WaterMeter",
102
- ElectricityMeter = "ElectricityMeter",
103
- PayShap = "PayShap"
104
- }
105
74
  /** Model to hold the unique details for a bank account beneficiary. */
106
75
  export declare class BeneficiaryBankAccount {
107
76
  /** The bank account token that was generated by the system. */
@@ -161,6 +130,30 @@ export declare class BeneficiaryCard {
161
130
  proofOfPaymentMobileNumber?: string;
162
131
  isActive: boolean;
163
132
  }
133
+ /** Model to hold the unique details for a beneficiary generic account (mobile number, meter number, etc). */
134
+ export declare class BeneficiaryGenericAccount {
135
+ /** The account number (can be a mobile number, meter number, etc). */
136
+ accountNumber: string;
137
+ /** The type of generic account. */
138
+ genericAccountType: GenericAccountType;
139
+ genericAccountTypeName: string;
140
+ createdDate: Date;
141
+ /** A globally unique reference (UUID) generated by the system internally to identify a specific beneficiary account. */
142
+ reference?: string;
143
+ /** A 3 character ISO currency code. */
144
+ currency: Currency;
145
+ /** The details which add sufficient context behind the money transfer to the beneficiary. */
146
+ recipientReference?: string;
147
+ /** The details which add sufficient context behind the money transfer to the consumer. */
148
+ senderReference?: string;
149
+ /** A flag indicating whether the consumer requires a notification to be sent to the beneficiary after a successful money transfer. */
150
+ sendProofOfPayment: boolean;
151
+ /** The email address for the beneficiary. */
152
+ proofOfPaymentEmailAddress?: string;
153
+ /** The mobile number for the beneficiary. */
154
+ proofOfPaymentMobileNumber?: string;
155
+ isActive: boolean;
156
+ }
164
157
  /** Model to hold the unique details for a mobile money beneficiary. */
165
158
  export declare class BeneficiaryMobileWallet {
166
159
  /**
@@ -273,6 +266,8 @@ export declare class ConsumerAccounts {
273
266
  loanAccounts: ConsumerLoanAccount[];
274
267
  /** A list of insurance policies associated with a consumer. */
275
268
  insurancePolicies: ConsumerInsurancePolicy[];
269
+ /** A list of generic accounts (mobile numbers, meter numbers, etc) associated with a consumer. */
270
+ genericAccounts: ConsumerGenericAccount[];
276
271
  /** A list of cards associated with a consumer. */
277
272
  cards: ConsumerCard[];
278
273
  }
@@ -357,6 +352,24 @@ export declare class ConsumerFile {
357
352
  lastUpdatedDate?: Date;
358
353
  isActive: boolean;
359
354
  }
355
+ /** Model to hold the unique details for a generic account (mobile number, meter number, etc). */
356
+ export declare class ConsumerGenericAccount {
357
+ /** The account number (can be a mobile number, meter number, etc). */
358
+ accountNumber: string;
359
+ /** The type of generic account. */
360
+ genericAccountType: GenericAccountType;
361
+ genericAccountTypeName: string;
362
+ createdDate: Date;
363
+ /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer account. */
364
+ reference?: string;
365
+ /** A 3 character ISO currency code. */
366
+ currency: Currency;
367
+ /** The details which add sufficient context behind the account to the consumer. */
368
+ accountName: string;
369
+ isActive: boolean;
370
+ iconUrl?: string;
371
+ linkedFileReferences: string[];
372
+ }
360
373
  export declare class ConsumerInsurancePolicy {
361
374
  policyNumber: string;
362
375
  coverAmountInCents: number;
@@ -425,6 +438,15 @@ export declare class ConsumerMobileWallet {
425
438
  export declare class Feedback {
426
439
  description?: string;
427
440
  }
441
+ export declare enum GenericAccountType {
442
+ None = "None",
443
+ MobileNumber = "MobileNumber",
444
+ WaterMeter = "WaterMeter",
445
+ ElectricityMeter = "ElectricityMeter",
446
+ PayShap = "PayShap",
447
+ DStv = "DStv",
448
+ EasyPay = "EasyPay"
449
+ }
428
450
  /** The KYC file result. */
429
451
  export declare class KycFileResult {
430
452
  /** Gets or sets the unique identifier for the KYC service provider used to retrieve the consumer KYC data. */