@vantagepay/vantagepay 0.17.0 → 0.17.2

package/dist/common/types.d.ts

@@ -5,6 +5,8 @@ import { IdentityDocumentType } from '../lookups/types';
 export declare class Address {
     /** Gets the address reference. */
     reference?: string;
+    /** Gets or sets the address external reference if linked to another system. */
+    yourReference?: string;
     /** Gets or sets the type of address the details are referring to. */
     addressType: AddressType;
     /** Gets or sets first line of the address (required). */
@@ -46,7 +48,8 @@ export declare enum BankAccountType {
     CURRENT = "CURRENT",
     FIXED = "FIXED",
     MONEYMARKET = "MONEYMARKET",
-    CODA = "CODA"
+    CODA = "CODA",
+    BOND = "BOND"
 }
 /** Model to capture generic contact/lead data. */
 export declare class ContactDetails {

package/dist/consumers/index.d.ts

@@ -9,6 +9,8 @@ export declare class Consumers extends BaseApi {
     getConsumerAgreement(): Promise<string>;
     acceptConsumerAgreement(): Promise<void>;
     stopCard(cardReference: string, reason?: string): Promise<void>;
+    stopDebitOrder(debitOrderReference: string): Promise<void>;
+    disputeDebitOrder(debitOrderReference: string): Promise<void>;
     getBankAccountBalance(bankAccountReference: string): Promise<Balance>;
     downloadFile(fileReference: string, queryParameters?: Record<string, string>): Promise<ConsumerFile | null>;
     submitFeedback(description: string): Promise<void>;

package/dist/consumers/types.d.ts

@@ -12,6 +12,8 @@ import { Device } from '../devices/types';
 import { Address } from '../common/types';
 import { CardHolder } from '../payments/types';
 import { ConsumerFileType } from '../lookups/types';
+import { InsurancePolicyStatus } from '../lookups/types';
+import { LoanStatus } from '../lookups/types';
 import { KycProvider } from '../lookups/types';
 import { KycStatus } from '../lookups/types';
 import { KycVerificationType } from '../lookups/types';
@@ -51,6 +53,8 @@ export declare class BasicConsumer {
 export declare class Beneficiary {
     /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific beneficiary. */
     reference?: string;
+    /** Gets or sets the beneficiary external reference if linked to another system. */
+    yourReference?: string;
     /** The beneficiary name. */
     name: string;
     /** The contact number for this beneficiary. */
@@ -300,12 +304,18 @@ export declare class ConsumerBankAccount {
     /** The branch code associated with the bank which holds the bank account. */
     routingCode?: string;
     linkedCardReferences: string[];
+    /** Gets or sets the card settings and preferences. */
+    cardSettings?: CardSettings;
+    /** Collection of debit orders linked to this bank account. */
+    debitOrders: DebitOrder[];
     createdDate: Date;
     /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer account. */
     reference?: string;
+    /** Gets or sets the external reference if linked to another system. */
+    yourReference?: string;
     /** A 3 character ISO currency code. */
     currency: Currency;
-    /** The details which add sufficient context behind the account to the consumer. */
+    /** The name of the account. */
     accountName: string;
     isActive: boolean;
     iconUrl?: string;
@@ -328,13 +338,15 @@ export declare class ConsumerCard {
     /** Gets the list of linked bank account references. */
     linkedBankAccountReferences: string[];
     /** Gets or sets the card settings and preferences. */
-    settings?: CardSettings;
+    cardSettings?: CardSettings;
     createdDate: Date;
     /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer account. */
     reference?: string;
+    /** Gets or sets the external reference if linked to another system. */
+    yourReference?: string;
     /** A 3 character ISO currency code. */
     currency: Currency;
-    /** The details which add sufficient context behind the account to the consumer. */
+    /** The name of the account. */
     accountName: string;
     isActive: boolean;
     iconUrl?: string;
@@ -362,9 +374,11 @@ export declare class ConsumerGenericAccount {
     createdDate: Date;
     /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer account. */
     reference?: string;
+    /** Gets or sets the external reference if linked to another system. */
+    yourReference?: string;
     /** A 3 character ISO currency code. */
     currency: Currency;
-    /** The details which add sufficient context behind the account to the consumer. */
+    /** The name of the account. */
     accountName: string;
     isActive: boolean;
     iconUrl?: string;
@@ -375,20 +389,35 @@ export declare class ConsumerInsurancePolicy {
     coverAmountInCents: number;
     premiumAmountInCents: number;
     description?: string;
-    beneficiaryName?: string;
+    beneficiaries: ConsumerInsurancePolicyBeneficiary[];
+    status: InsurancePolicyStatus;
     createdDate: Date;
     /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer account. */
     reference?: string;
+    /** Gets or sets the external reference if linked to another system. */
+    yourReference?: string;
     /** A 3 character ISO currency code. */
     currency: Currency;
-    /** The details which add sufficient context behind the account to the consumer. */
+    /** The name of the account. */
     accountName: string;
     isActive: boolean;
     iconUrl?: string;
     linkedFileReferences: string[];
 }
+export declare class ConsumerInsurancePolicyBeneficiary {
+    reference?: string;
+    firstName: string;
+    lastName: string;
+    contactNumber?: string;
+    dateOfBirth?: Date;
+    relationship?: string;
+    percentage: number;
+}
 export declare class ConsumerLoanAccount {
     contractNumber: string;
+    loanType: string;
+    loanSource: string;
+    status: LoanStatus;
     originalCapitalInCents: number;
     settlementAmountInCents: number;
     outstandingBalanceInCents: number;
@@ -396,9 +425,11 @@ export declare class ConsumerLoanAccount {
     arrearsAmountInCents: number;
     installmentsRemaining: number;
     annualInterestRatePercentage: number;
-    nextInstallmentDate: Date;
+    nextInstallmentDate?: Date;
+    lastPaymentDate?: Date;
     startDate: Date;
     endDate: Date;
+    term: number;
     /** Whether the loan is currently in arrears (past due). */
     isInArrears: boolean;
     /** Whether the loan has been fully paid. */
@@ -408,9 +439,11 @@ export declare class ConsumerLoanAccount {
     createdDate: Date;
     /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer account. */
     reference?: string;
+    /** Gets or sets the external reference if linked to another system. */
+    yourReference?: string;
     /** A 3 character ISO currency code. */
     currency: Currency;
-    /** The details which add sufficient context behind the account to the consumer. */
+    /** The name of the account. */
     accountName: string;
     isActive: boolean;
     iconUrl?: string;
@@ -427,14 +460,57 @@ export declare class ConsumerMobileWallet {
     createdDate: Date;
     /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer account. */
     reference?: string;
+    /** Gets or sets the external reference if linked to another system. */
+    yourReference?: string;
     /** A 3 character ISO currency code. */
     currency: Currency;
-    /** The details which add sufficient context behind the account to the consumer. */
+    /** The name of the account. */
     accountName: string;
     isActive: boolean;
     iconUrl?: string;
     linkedFileReferences: string[];
 }
+export declare class DebitOrder {
+    /** A globally unique reference (UUID) generated by the system to identify this debit order. */
+    reference?: string;
+    /** External reference from the source system (e.g., USN from Lesaka). */
+    yourReference?: string;
+    /** The reference of the debit order instruction. */
+    instructionReference: string;
+    /** The date the debit order was created in our system. */
+    createdDate: Date;
+    /** The date when the debit order is scheduled to be actioned. */
+    debitOrderDate: Date;
+    /** Description of the debit order. */
+    description: string;
+    /** Amount in cents. */
+    amountInCents: number;
+    /** Currency of the debit order. */
+    currency: Currency;
+    /** Indicates whether the debit order can be stopped by the consumer. */
+    canBeStopped: boolean;
+    /** Indicates whether the debit order can be disputed by the consumer. */
+    canBeDisputed: boolean;
+    /** Indicates whether the debit order has been stopped by the consumer. */
+    isStopped: boolean;
+    /** Indicates whether the debit order has been disputed by the consumer. */
+    isDisputed: boolean;
+    /** The date when the debit order was stopped (read-only). */
+    stoppedDate?: Date;
+    /** The date when the debit order was disputed (read-only). */
+    disputedDate?: Date;
+    /** Whether the debit order action date is in the future. */
+    isFuture: boolean;
+    /** Provider-specific metadata (not serialized to clients). */
+    metadata: {
+        [key: string]: string;
+    };
+}
+/** Request to dispute a debit order. */
+export declare class DisputeDebitOrderRequest {
+    /** The debit order reference to dispute. */
+    debitOrderReference: string;
+}
 export declare class Feedback {
     description?: string;
 }
@@ -505,7 +581,12 @@ export declare class RewardPointsInfo {
 /** Request to stop a consumer card. */
 export declare class StopCardRequest {
     /** The card reference to stop. */
-    cardReference?: string;
+    cardReference: string;
     /** The reason for stopping the card. */
     reason?: string;
 }
+/** Request to stop a debit order. */
+export declare class StopDebitOrderRequest {
+    /** The debit order reference to stop. */
+    debitOrderReference: string;
+}