@vantagepay/vantagepay 0.15.0

package/dist/common/types.d.ts

@@ -0,0 +1,99 @@
+import { Country } from '../lookups/types';
+import { IdentityDocumentType } from '../lookups/types';
+/** Model to hold address details. */
+export declare class Address {
+    /** Gets the address reference. */
+    reference?: string;
+    /** Gets or sets the type of address the details are referring to. */
+    addressType: AddressType;
+    /** Gets or sets first line of the address (required). */
+    addressLine1: string;
+    /** Gets or sets second line of the address. */
+    addressLine2?: string;
+    /** Gets or sets third line of the address. */
+    addressLine3?: string;
+    /** Gets or sets postal code of the address. */
+    postalCode?: string;
+    /** Gets or sets 3 character ISO country code the address resides in. */
+    countryIsoCode: Country;
+    /** Gets or sets city the address resides in (required). */
+    city: string;
+    /** Gets or sets state/province the address resides in. */
+    state?: string;
+    /** Gets or sets additional location information for the address so that it can be pinned on a map. */
+    location?: Location;
+    /** Gets or sets the description of the address. */
+    description?: string;
+    /** Gets a single-line formatted string of the address. */
+    formatted: string;
+    isActive: boolean;
+}
+export declare enum AddressType {
+    MAIN = "MAIN",
+    POST = "POST",
+    BILL = "BILL",
+    SHIP = "SHIP"
+}
+export declare enum BankAccountType {
+    SAVINGS = "SAVINGS",
+    CURRENT = "CURRENT",
+    FIXED = "FIXED",
+    MONEYMARKET = "MONEYMARKET",
+    CODA = "CODA"
+}
+export declare class FaceCheckResult {
+    faceCount: number;
+    containsNoise: boolean;
+    isLowQuality: boolean;
+    isOverExposed: boolean;
+    isUnderExposed: boolean;
+    isBlurry: boolean;
+    isWearingMask: boolean;
+    foreheadNotIncluded: boolean;
+    eyesNotIncluded: boolean;
+    mouthNotIncluded: boolean;
+    faceLeft?: number;
+    faceTop?: number;
+    faceWidth?: number;
+    faceHeight?: number;
+    problems: string[];
+}
+/** Model to hold identification details. */
+export declare class IdentityDocument {
+    /** Gets or sets the identification document reference. */
+    reference?: string;
+    /** Gets or sets the type of identification document submitted by the consumer. */
+    identityDocumentType: IdentityDocumentType;
+    /** Gets or sets the 3 character ISO country code where the document was issued. */
+    countryIsoCode: Country;
+    /** Gets or sets the encrypted identification number. */
+    identityNumber: string;
+    /** Gets or sets the place of issuance. */
+    placeOfIssuance?: string;
+    /** Gets or sets the date at which the identification document was issued. */
+    effectiveDate?: Date;
+    /** Gets or sets the date at which the identification document expires. */
+    expiryDate?: Date;
+}
+/** Model to hold location data. */
+export declare class Location {
+    /** A latitude value expressed as a 64 bit floating point number (required). */
+    latitude: number;
+    /** A longitude value expressed as a 64 bit floating point number (required). */
+    longitude: number;
+    /** The time zone for this location. */
+    timeZone?: string;
+    /** The description of this location (if available). */
+    description?: string;
+}
+export declare class NameAndReference {
+    name: string;
+    reference: string;
+    externalReference: string;
+}
+/** Model to hold API endpoint and access token for an environment. */
+export declare class SwitchEnvironmentInfo {
+    name: string;
+    accessToken: string;
+    apiBaseUrl: string;
+}

package/dist/consumers/index.d.ts

@@ -0,0 +1,11 @@
+import { BaseApi } from '../baseApi';
+import { BasicConsumer, Consumer, Message } from './types';
+export declare class Consumers extends BaseApi {
+    createConsumer(request: BasicConsumer): Promise<Consumer>;
+    updateConsumer(request: Consumer): Promise<Consumer>;
+    deleteConsumer(): Promise<void>;
+    getConsumer(): Promise<Consumer>;
+    submitFeedback(description: string): Promise<void>;
+    getMessage(messageReference: string): Promise<Message>;
+    deleteMessage(messageReference: string): Promise<void>;
+}

package/dist/consumers/types.d.ts

@@ -0,0 +1,358 @@
+import { Country } from '../lookups/types';
+import { Gender } from '../lookups/types';
+import { Language } from '../lookups/types';
+import { Bank } from '../lookups/types';
+import { BankAccountType } from '../common/types';
+import { Currency } from '../lookups/types';
+import { Month } from '../lookups/types';
+import { MobileWalletOperator } from '../lookups/types';
+import { LoginCredentials } from '../authentication/types';
+import { IdentityDocument } from '../common/types';
+import { Device } from '../devices/types';
+import { Address } from '../common/types';
+import { CardHolder } from '../payments/types';
+import { ConsumerFileType } from '../lookups/types';
+import { KycProvider } from '../lookups/types';
+import { KycStatus } from '../lookups/types';
+import { KycVerificationType } from '../lookups/types';
+/** Model to hold basic consumer details. */
+export declare class BasicConsumer {
+    /** Gets or sets the consumer reference. */
+    reference?: string;
+    /** Gets or sets the consumer external reference if linked to another system. */
+    yourReference?: string;
+    /** Gets or sets the current originator source of the consumer. */
+    source: string;
+    /** Gets the user reference associated with the user. */
+    userReference?: string;
+    /** Gets or sets the first name of the consumer (required). */
+    firstName?: string;
+    /** Gets or sets the last name (surname) of the consumer (required if IdentityNumber is not supplied). */
+    lastName?: string;
+    /** Gets or sets the middle name of the consumer. */
+    middleName?: string;
+    /** Gets or sets the email address for the consumer. */
+    emailAddress?: string;
+    /** Gets or sets the mobile number for the consumer. */
+    mobileNumber?: string;
+    /** Gets or sets 3 character ISO country code the consumer resides in. */
+    countryIsoCode: Country;
+    /** Gets or sets the date of birth of the consumer. */
+    dateOfBirth?: Date;
+    /** Gets or sets the gender of the consumer. */
+    gender?: Gender;
+    /** Gets or sets the language code preference of the consumer. */
+    preferredLanguage: Language;
+    /** Gets the KYC summary status. */
+    kycStatusSummary: KycStatusSummary;
+    isActive: boolean;
+}
+/** Model to hold consumer beneficiary details. */
+export declare class Beneficiary {
+    /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific beneficiary. */
+    reference?: string;
+    /** The beneficiary name. */
+    name: string;
+    /** A list of bank accounts associated with a beneficiary. */
+    bankAccounts: BeneficiaryBankAccount[];
+    /** A list of mobile wallets associated with a beneficiary. */
+    mobileWallets: BeneficiaryMobileWallet[];
+    /** A list of cards associated with a beneficiary. */
+    cards: BeneficiaryCard[];
+    isActive: boolean;
+}
+/** Model to hold the unique details for a bank account beneficiary. */
+export declare class BeneficiaryBankAccount {
+    /** The bank account token that was generated by the system. */
+    token?: string;
+    accountNumber: string;
+    bank: Bank;
+    bankName: string;
+    /** The bank account type. */
+    bankAccountType: BankAccountType;
+    bankAccountTypeName: string;
+    /** The branch code associated with the bank which holds the bank account. */
+    routingCode?: string;
+    /** A globally unique reference (UUID) generated by the system internally to identify a specific beneficiary account. */
+    reference: string;
+    /** A 3 character ISO currency code. */
+    currency: Currency;
+    /** The details which add sufficient context behind the money transfer to the beneficiary. */
+    recipientReference?: string;
+    /** The details which add sufficient context behind the money transfer to the consumer. */
+    senderReference?: string;
+    /** A flag indicating whether the consumer requires a notification to be sent to the beneficiary after a successful money transfer. */
+    sendProofOfPayment: boolean;
+    /** The email address for the beneficiary. */
+    proofOfPaymentEmailAddress?: string;
+    /** The mobile number for the beneficiary. */
+    proofOfPaymentMobileNumber?: string;
+    isActive: boolean;
+}
+/** Model to hold the unique details for a bank account beneficiary. */
+export declare class BeneficiaryCard {
+    /** The bank account token that was generated by the system. */
+    token?: string;
+    /** The full card number. */
+    cardNumber: string;
+    /** The name of the card holder as printed on the card. */
+    nameOnCard: string;
+    /** The month in which the card expires. */
+    expiryMonth: Month;
+    /** The year in which the card expires. */
+    expiryYear: number;
+    cardIssuer: string;
+    /** A globally unique reference (UUID) generated by the system internally to identify a specific beneficiary account. */
+    reference: string;
+    /** A 3 character ISO currency code. */
+    currency: Currency;
+    /** The details which add sufficient context behind the money transfer to the beneficiary. */
+    recipientReference?: string;
+    /** The details which add sufficient context behind the money transfer to the consumer. */
+    senderReference?: string;
+    /** A flag indicating whether the consumer requires a notification to be sent to the beneficiary after a successful money transfer. */
+    sendProofOfPayment: boolean;
+    /** The email address for the beneficiary. */
+    proofOfPaymentEmailAddress?: string;
+    /** The mobile number for the beneficiary. */
+    proofOfPaymentMobileNumber?: string;
+    isActive: boolean;
+}
+/** Model to hold the unique details for a mobile money beneficiary. */
+export declare class BeneficiaryMobileWallet {
+    /**
+    * Mobile Station International Subscriber Directory Number (MSISDN) is a number used to identify a mobile phone number internationally.
+    *             This number includes a country code and a National Destination Code which identifies the subscriber's operator.
+    */
+    msisdn: string;
+    /** The mobile wallet operator that owns the mobile money account. */
+    mobileWalletOperator: MobileWalletOperator;
+    mobileWalletOperatorName: string;
+    /** A globally unique reference (UUID) generated by the system internally to identify a specific beneficiary account. */
+    reference: string;
+    /** A 3 character ISO currency code. */
+    currency: Currency;
+    /** The details which add sufficient context behind the money transfer to the beneficiary. */
+    recipientReference?: string;
+    /** The details which add sufficient context behind the money transfer to the consumer. */
+    senderReference?: string;
+    /** A flag indicating whether the consumer requires a notification to be sent to the beneficiary after a successful money transfer. */
+    sendProofOfPayment: boolean;
+    /** The email address for the beneficiary. */
+    proofOfPaymentEmailAddress?: string;
+    /** The mobile number for the beneficiary. */
+    proofOfPaymentMobileNumber?: string;
+    isActive: boolean;
+}
+/** Model to hold detailed consumer details. */
+export declare class Consumer {
+    /** The date and time this consumer record was created. */
+    createdDate: Date;
+    /** Gets or sets the login credentials that this consumer can use to access their data. */
+    loginCredentials?: LoginCredentials;
+    /** Gets or sets the full name of a consumer's next of kin. */
+    fullNameOfNextOfKin?: string;
+    /** Gets or sets the contact number for a consumer's next of kin. */
+    contactNumberForNextOfKin?: string;
+    /** Gets or sets the invitation code for the consumer. */
+    invitationCode?: string;
+    /** Gets or sets a flag to indicate whether registration details have been captured by the consumer themselves. */
+    isRegistrationComplete: boolean;
+    /** Gets or sets a flag to indicate whether the consumer has verified their email address details yet or not. */
+    isEmailVerified: boolean;
+    /** Gets or sets a flag to indicate whether the consumer has verified their mobile number yet or not. */
+    isMobileNumberVerified: boolean;
+    /** Gets the available identification documentation information for the consumer. */
+    identityDocuments: IdentityDocument[];
+    /** Gets a list of KYC lookups related to the consumer. */
+    kycLookupResults: KycLookupResult[];
+    /** Gets a list of files related to the consumer. */
+    files: ConsumerFile[];
+    /** Gets a list of consumer devices. */
+    devices: Device[];
+    /** Gets the list of available addresses for the consumer. */
+    addresses: Address[];
+    /** A collection of available beneficiaries associated with the consumer. */
+    beneficiaries: Beneficiary[];
+    /** A collection of all financial institution accounts associated with the consumer. */
+    accounts: ConsumerAccounts;
+    /** Gets the attributes. */
+    attributes: ConsumerAttributeValue[];
+    rewardPointsInfo?: RewardPointsInfo;
+    /** Gets or sets the consumer reference. */
+    reference?: string;
+    /** Gets or sets the consumer external reference if linked to another system. */
+    yourReference?: string;
+    /** Gets or sets the current originator source of the consumer. */
+    source: string;
+    /** Gets the user reference associated with the user. */
+    userReference?: string;
+    /** Gets or sets the first name of the consumer (required). */
+    firstName?: string;
+    /** Gets or sets the last name (surname) of the consumer (required if IdentityNumber is not supplied). */
+    lastName?: string;
+    /** Gets or sets the middle name of the consumer. */
+    middleName?: string;
+    /** Gets or sets the email address for the consumer. */
+    emailAddress?: string;
+    /** Gets or sets the mobile number for the consumer. */
+    mobileNumber?: string;
+    /** Gets or sets 3 character ISO country code the consumer resides in. */
+    countryIsoCode: Country;
+    /** Gets or sets the date of birth of the consumer. */
+    dateOfBirth?: Date;
+    /** Gets or sets the gender of the consumer. */
+    gender?: Gender;
+    /** Gets or sets the language code preference of the consumer. */
+    preferredLanguage: Language;
+    /** Gets the KYC summary status. */
+    kycStatusSummary: KycStatusSummary;
+    isActive: boolean;
+}
+export declare class ConsumerAccounts {
+    /** A list of bank accounts associated with a consumer. */
+    bankAccounts: ConsumerBankAccount[];
+    /** A list of mobile money / wallet accounts associated with a consumer. */
+    mobileWallets: ConsumerMobileWallet[];
+    /** A list of cards associated with a consumer. */
+    cards: ConsumerCard[];
+}
+export declare enum ConsumerAttribute {
+    VisaPAN = 1,
+    MasterCardPAN = 2,
+    RegistrationInvitationCode = 3,
+    GMoneyWalletNumber = 4,
+    LinkedGcbBankAccountReferences = 5
+}
+/** Model to hold various attributes about a consumer. */
+export declare class ConsumerAttributeValue {
+    name: string;
+    attribute: ConsumerAttribute;
+    value: string;
+}
+export declare class ConsumerBankAccount {
+    /** The bank account token that was generated by the system. */
+    token?: string;
+    accountNumber: string;
+    bank: Bank;
+    branchName?: string;
+    /** The branch code associated with the bank which holds the bank account. */
+    routingCode?: string;
+    isActive: boolean;
+    /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer account. */
+    reference?: string;
+    /** A 3 character ISO currency code. */
+    currency: Currency;
+    /** The details which add sufficient context behind the account to the consumer. */
+    accountName: string;
+    iconUrl?: string;
+}
+export declare class ConsumerCard {
+    /** Additional customer information to facilitate the card payment. */
+    cardHolder: CardHolder;
+    /** The card token that was generated by the system. */
+    token?: string;
+    cardIssuer: string;
+    /** The full card number. */
+    cardNumber: string;
+    /** The name of the card holder as printed on the card. */
+    nameOnCard: string;
+    /** The month in which the card expires. */
+    expiryMonth: Month;
+    /** The year in which the card expires. */
+    expiryYear: number;
+    isActive: boolean;
+    /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer account. */
+    reference?: string;
+    /** A 3 character ISO currency code. */
+    currency: Currency;
+    /** The details which add sufficient context behind the account to the consumer. */
+    accountName: string;
+    iconUrl?: string;
+}
+export declare class ConsumerFile {
+    fileType: ConsumerFileType;
+    kycResults: KycFileResult[];
+    reference?: string;
+    yourReference?: string;
+    fileName: string;
+    mimeType: string;
+    base64Data?: string;
+    createdDate: Date;
+    lastUpdatedDate?: Date;
+}
+export declare class ConsumerMobileWallet {
+    /**
+    * Mobile Station International Subscriber Directory Number (MSISDN) is a number used to identify a mobile phone number internationally.
+    *             This number includes a country code and a National Destination Code which identifies the subscriber's operator.
+    */
+    msisdn: string;
+    /** The mobile wallet operator that owns the mobile money account. */
+    mobileWalletOperator: MobileWalletOperator;
+    isActive: boolean;
+    /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer account. */
+    reference?: string;
+    /** A 3 character ISO currency code. */
+    currency: Currency;
+    /** The details which add sufficient context behind the account to the consumer. */
+    accountName: string;
+    iconUrl?: string;
+}
+export declare class Feedback {
+    description?: string;
+}
+/** The KYC file result. */
+export declare class KycFileResult {
+    /** Gets or sets the unique identifier for the KYC service provider used to retrieve the consumer KYC data. */
+    provider: KycProvider;
+    /** Gets or sets the status of the particular KYC verification. */
+    status: KycStatus;
+    /** Gets or sets the consumer KYC verification type. */
+    verificationType: KycVerificationType;
+    /** Gets or sets the KYC provider reference associated with the KYC Lookup. */
+    providerReference?: string;
+    /** Gets the created date of the KYC lookup result. */
+    createdDate: Date;
+    /** Gets or sets the last date and time of when the KYC data was updated. */
+    lastUpdatedDate?: Date;
+}
+/** The KYC lookup result. */
+export declare class KycLookupResult {
+    /** Gets or sets the unique identifier for the KYC service provider used to retrieve the consumer KYC data. */
+    provider: KycProvider;
+    /** Gets or sets the status of the particular KYC verification. */
+    status: KycStatus;
+    /** Gets or sets the consumer KYC verification type. */
+    verificationType: KycVerificationType;
+    /** Gets or sets the KYC provider reference associated with the KYC Lookup. */
+    providerReference?: string;
+    /** Gets the created date of the KYC lookup result. */
+    createdDate: Date;
+    /** Gets or sets the last date and time of when the KYC data was updated. */
+    lastUpdatedDate?: Date;
+}
+export declare enum KycStatusSummary {
+    Unverified = "Unverified",
+    Verified = "Verified",
+    Rejected = "Rejected"
+}
+/** Model to hold consumer message details. */
+export declare class Message {
+    /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific message. */
+    reference: string;
+    /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer. */
+    consumerReference: string;
+    /** A short text string which briefly summarizes the message details. */
+    messageSummary: string;
+    /** The full consumer message text. */
+    messageDetail: string;
+    /** The date and time this consumer message was created. */
+    createdDate: Date;
+    /** A flag indicating whether the message has been deleted or not. */
+    isDeleted: boolean;
+}
+export declare class RewardPointsInfo {
+    pointsBalance: number;
+    rewardTier: number;
+    creditTransactionCount: number;
+}

package/dist/content/index.d.ts

@@ -0,0 +1,7 @@
+import { BaseApi } from '../baseApi';
+export declare class Content extends BaseApi {
+    private clientContentCache;
+    private contactDetailsCache;
+    getClientContent(): Promise<any>;
+    getContactDetails(): Promise<any>;
+}

package/dist/devices/types.d.ts

@@ -0,0 +1,20 @@
+export declare class Device {
+    createdDate: Date;
+    lastUsedDate?: Date;
+    reference?: string;
+    yourReference?: string;
+    platform: DevicePlatform;
+    deviceType?: string;
+    brand?: string;
+    model?: string;
+    serialNumber?: string;
+    operatingSystemVersion?: string;
+    softwareVersion?: string;
+    pushNotificationToken?: string;
+}
+export declare enum DevicePlatform {
+    Unknown = "Unknown",
+    Android = "Android",
+    iOS = "iOS",
+    Web = "Web"
+}

package/dist/eventTypes.d.ts

@@ -0,0 +1,10 @@
+export declare const OnSessionExpired: unique symbol;
+export declare const OnAutomaticRefresh: unique symbol;
+export declare const OnApiRetry: unique symbol;
+export declare const OnPaymentStatusUpdate: unique symbol;
+export declare const OnPaymentComplete: unique symbol;
+export declare const OnRequires3DSecure: unique symbol;
+export declare const OnRequiresPin: unique symbol;
+export declare const OnRequiresConfirmation: unique symbol;
+export declare const OnRequiresAddress: unique symbol;
+export declare const OnComplete3DSecure: unique symbol;

package/dist/gmoney/index.d.ts

@@ -0,0 +1,48 @@
+import { BaseApi } from '../baseApi';
+import { OtpVerificationResponse, GMoneyConsumerCreateProfileRequest, GMoneyConsumerUpdateProfileRequest, GMoneyConsumerProfileResponse, GMoneyConsumerWalletResponse, TransactionReportResponse, LinkBankAccountRequest, TransactionReceiptResponse, GMoneyConsumerBankAccountResponse } from './types';
+import { TokenResponse } from '../authentication/types';
+import { FaceMovementDetectionLevel } from '../lookups/types';
+import { ConsumerBankAccount } from '../consumers/types';
+export declare class GMoney extends BaseApi {
+    private readonly branchesCache;
+    private readonly atmsCache;
+    private readonly agentsCache;
+    private readonly merchantNameCache;
+    private readonly customerNameCache;
+    private readonly bankAccountNameCache;
+    private clientContentCache;
+    private contactDetailsCache;
+    verifyMobileNumber(msisdn: string): Promise<OtpVerificationResponse>;
+    validateOtp(otpValue: string): Promise<OtpVerificationResponse>;
+    resendOtp(): Promise<void>;
+    createConsumerProfile(request: GMoneyConsumerCreateProfileRequest): Promise<TokenResponse>;
+    deleteConsumerProfile(): Promise<void>;
+    updateConsumerProfile(request: GMoneyConsumerUpdateProfileRequest): Promise<GMoneyConsumerProfileResponse>;
+    getConsumerProfile(): Promise<GMoneyConsumerProfileResponse>;
+    getWalletInformation(): Promise<GMoneyConsumerWalletResponse>;
+    changeWalletPin(tempPin: string, newPin: string): Promise<void>;
+    activateCustomer(oldPin: string, newPin: string): Promise<void>;
+    resetWalletPin(): Promise<void>;
+    saveConsumerSelfie(base64Image: string): Promise<string>;
+    linkGcbBankAccount(request: LinkBankAccountRequest): Promise<void>;
+    checkConsumerLiveness(base64Images: string[]): Promise<FaceMovementDetectionLevel>;
+    saveProfilePicture(base64Image: string): Promise<string>;
+    getBranches(limit?: number, latitude?: number, longitude?: number): Promise<any>;
+    getAtms(limit?: number, latitude?: number, longitude?: number): Promise<any>;
+    getAgents(limit?: number, latitude?: number, longitude?: number): Promise<any>;
+    getMerchantNameFromOrganizationCode(organizationCode: string): Promise<string>;
+    getCustomerNameFromWalletNumber(msisdn: string): Promise<string>;
+    getCustomerNameFromBankAccountNumber(accountNumber: string): Promise<string>;
+    getClientContent(): Promise<any>;
+    getContactDetails(): Promise<any>;
+    getRecentTransactions(limit?: number, successOnly?: boolean): Promise<TransactionReportResponse>;
+    getTransactionHistory(dateFrom?: string, dateTo?: string): Promise<TransactionReportResponse>;
+    getTransactionReceipt(paymentReference: string): Promise<TransactionReceiptResponse>;
+    forgotPassword(msisdn: string): Promise<void>;
+    getServiceStatus(): Promise<boolean>;
+    getAllLinkedBankAccounts(): Promise<ConsumerBankAccount[]>;
+    getLinkedBankAccountInformation(bankAccountReference: string): Promise<GMoneyConsumerBankAccountResponse>;
+    getLinkedBankAccountRecentTransactions(bankAccountReference: string, limit?: number): Promise<TransactionReportResponse>;
+    getLinkedBankAccountTransactionHistory(bankAccountReference: string): Promise<TransactionReportResponse>;
+    getLinkedBankAccountTransactionReceipt(paymentReference: string): Promise<TransactionReceiptResponse>;
+}