@vantagepay/vantagepay 0.15.0

package/dist/merchants/index.d.ts

@@ -0,0 +1,36 @@
+import { OtpVerificationResponse, TokenResponse } from '../authentication/types';
+import { BaseApi } from '../baseApi';
+import { Device } from '../devices/types';
+import { Currency } from '../lookups/types';
+import { BasicMerchant, Merchant, MerchantFile, MerchantProduct, TerminalConfiguration, TerminalPaymentQrCodeUrls, TerminalPaymentQrCodes, TerminalSetup } from './types';
+export declare class Merchants extends BaseApi {
+    private readonly productDetailCache;
+    private productsCache;
+    private createMerchantProductProxy;
+    private getAllProducts;
+    getActiveProductTypes(): Promise<string[]>;
+    getMerchantNamesFromProductType(productType: string): Promise<string[]>;
+    getProductTypesForMerchant(merchantName: string): Promise<string[]>;
+    getProductsForMerchantAndProductType(productType: string, merchantName: string): Promise<any[]>;
+    getProductDetails(productReference: string): Promise<MerchantProduct>;
+    getProducts(): Promise<MerchantProduct[]>;
+    createProduct(product: MerchantProduct): Promise<MerchantProduct>;
+    updateProduct(product: MerchantProduct): Promise<MerchantProduct>;
+    deleteProduct(productReference: string): Promise<void>;
+    getMerchant(): Promise<Merchant>;
+    createMerchant(request: Merchant): Promise<Merchant>;
+    updateMerchant(request: Merchant): Promise<Merchant>;
+    getMerchantAgreement(): Promise<string>;
+    acceptMerchantAgreement(): Promise<void>;
+    verifyMobileNumber(msisdn?: string): Promise<void>;
+    validateOtp(otpValue: string, msisdn?: string): Promise<OtpVerificationResponse>;
+    validateMerchantName(name: string): Promise<boolean>;
+    createUser(username: string, password: string, mobileNumber?: string, emailAddress?: string): Promise<TokenResponse>;
+    switchToMerchant(merchantReference: string): Promise<TokenResponse>;
+    getUserMerchants(): Promise<BasicMerchant[]>;
+    setupPosTerminal(terminalReference: string, merchantSource?: string, deviceInformation?: Device): Promise<TerminalSetup>;
+    getPosTerminalConfiguration(terminalReference: string, merchantSource?: string): Promise<TerminalConfiguration>;
+    getTerminalPaymentQrCodes(amountInCents: number, currency: Currency): Promise<TerminalPaymentQrCodes>;
+    getTerminalPaymentQrCodeUrls(amountInCents: number, currency: Currency): Promise<TerminalPaymentQrCodeUrls>;
+    uploadFile(request: MerchantFile): Promise<void>;
+}

package/dist/merchants/types.d.ts

@@ -0,0 +1,479 @@
+import { MerchantCategory } from '../lookups/types';
+import { Country } from '../lookups/types';
+import { Currency } from '../lookups/types';
+import { LoginCredentials } from '../authentication/types';
+import { Gender } from '../lookups/types';
+import { Address } from '../common/types';
+import { IdentityDocument } from '../common/types';
+import { KybProvider } from '../lookups/types';
+import { KybStatus } from '../lookups/types';
+import { Language } from '../lookups/types';
+import { Device } from '../devices/types';
+import { Bank } from '../lookups/types';
+import { MerchantFileType } from '../lookups/types';
+import { MobileWalletOperator } from '../lookups/types';
+import { ProductType } from '../lookups/types';
+import { DayOfWeek } from '../lookups/types';
+import { DevicePlatform } from '../devices/types';
+import { QrCodeType } from '../lookups/types';
+export declare class AdditionalTerminalReference {
+    terminalType: TerminalType;
+    reference: string;
+}
+export declare class BasicEmployee {
+    reference?: string;
+    yourReference?: string;
+    title?: string;
+    firstName: string;
+    lastName: string;
+    employeeNumber: number;
+    passcode?: string;
+    isActive: boolean;
+    posPermissions: PosPermissions;
+}
+export declare class BasicMerchant {
+    reference?: string;
+    userReference?: string;
+    yourReference?: string;
+    source: string;
+    name: string;
+    categoryCode: MerchantCategory;
+    category: string;
+    emailAddress?: string;
+    mobileNumber?: string;
+    countryIsoCode: Country;
+    currency: Currency;
+    kybStatusSummary: KybStatusSummary;
+    shortCode?: number;
+    isActive: boolean;
+}
+export declare class Business {
+    reference?: string;
+    parentBusinessReference?: string;
+    createdDate: Date;
+    yourReference?: string;
+    source: string;
+    name: string;
+    emailAddress?: string;
+    mobileNumber?: string;
+    phoneNumber?: string;
+    isEmailVerified: boolean;
+    isMobileNumberVerified: boolean;
+    isActive: boolean;
+}
+export declare class Employee {
+    createdDate: Date;
+    loginCredentials?: LoginCredentials;
+    userReference?: string;
+    isOwner: boolean;
+    dateOfBirth?: Date;
+    gender?: Gender;
+    countryIsoCode?: Country;
+    emailAddress?: string;
+    mobileNumber?: string;
+    profileImage?: string;
+    notificationEmailAddress?: string;
+    notificationMobileNumber?: string;
+    notificationSettings: EmployeeNotificationEventSetting[];
+    addresses: Address[];
+    identityDocuments: IdentityDocument[];
+    reference?: string;
+    yourReference?: string;
+    title?: string;
+    firstName: string;
+    lastName: string;
+    employeeNumber: number;
+    passcode?: string;
+    isActive: boolean;
+    posPermissions: PosPermissions;
+}
+export declare enum EmployeeNotificationEvent {
+    PaymentSuccessful = 1,
+    PaymentFailed = 2
+}
+export declare class EmployeeNotificationEventSetting {
+    event: EmployeeNotificationEvent;
+    description: string;
+    sendEmail: boolean;
+    sendSms: boolean;
+    terminalReferences: string[];
+}
+export declare enum FuelPurchaseMethod {
+    ByAmount = "ByAmount",
+    ByQuantity = "ByQuantity",
+    ByAmountAndQuantity = "ByAmountAndQuantity"
+}
+export declare class HostedPaymentOptions {
+    cardNotPresentMID?: number;
+    isVisaEnabled: boolean;
+    isMastercardEnabled: boolean;
+    isAmericanExpressEnabled: boolean;
+    isDinersEnabled: boolean;
+    settlementTime: SettlementTime;
+}
+export declare enum Industry {
+    None = "None",
+    Retail = "Retail",
+    Restaurant = "Restaurant",
+    Forecourt = "Forecourt",
+    Workshop = "Workshop"
+}
+export declare class KybFileResult {
+    provider: KybProvider;
+    status: KybStatus;
+    createdDate: Date;
+    lastUpdatedDate?: Date;
+}
+export declare enum KybStatusSummary {
+    Unverified = "Unverified",
+    Verified = "Verified",
+    PartiallyVerified = "PartiallyVerified",
+    Rejected = "Rejected"
+}
+export declare class Merchant {
+    createdDate: Date;
+    loginCredentials?: LoginCredentials;
+    tradingName?: string;
+    franchiseName?: string;
+    capturedBy?: string;
+    capturedFrom?: string;
+    industry: Industry;
+    phoneNumber?: string;
+    notificationEmailAddress?: string;
+    notificationMobileNumber?: string;
+    city?: string;
+    state?: string;
+    languageIsoCode: Language;
+    webSiteUrl?: string;
+    isRegistrationComplete: boolean;
+    isEmailVerified: boolean;
+    isMobileNumberVerified: boolean;
+    vCard?: string;
+    logoImage?: string;
+    taxNumber?: string;
+    companyRegistrationNumber?: string;
+    companyRegistrationDate?: Date;
+    adminPasscode?: string;
+    logoUrl?: string;
+    hostedPaymentUrl?: string;
+    hostedPaymentOptions?: HostedPaymentOptions;
+    posOptions?: PosOptions;
+    business?: Business;
+    addresses: Address[];
+    employees: Employee[];
+    terminals: Terminal[];
+    files: MerchantFile[];
+    notificationSettings: MerchantNotificationEventSetting[];
+    attributes: MerchantAttributeValue[];
+    bankAccounts: MerchantBankAccount[];
+    mobileWallets: MerchantMobileWallet[];
+    operatingTimes: OperatingTime[];
+    devices: Device[];
+    qrCodes: MerchantQrCode[];
+    reference?: string;
+    userReference?: string;
+    yourReference?: string;
+    source: string;
+    name: string;
+    categoryCode: MerchantCategory;
+    category: string;
+    emailAddress?: string;
+    mobileNumber?: string;
+    countryIsoCode: Country;
+    currency: Currency;
+    kybStatusSummary: KybStatusSummary;
+    shortCode?: number;
+    isActive: boolean;
+}
+export declare enum MerchantAttribute {
+    GhIPSSMerchantId = 2,
+    VisaPAN = 3,
+    MasterCardPAN = 4,
+    NIBSSMerchantReference = 6
+}
+/** Model to hold various attributes about a merchant. */
+export declare class MerchantAttributeValue {
+    name: string;
+    attribute: MerchantAttribute;
+    value: string;
+}
+export declare class MerchantBankAccount {
+    reference?: string;
+    createdDateUtc: Date;
+    accountNumber: string;
+    bank: Bank;
+    currency: Currency;
+    accountName?: string;
+    branchName?: string;
+    /** The branch code associated with the bank which holds the bank account. */
+    routingCode?: string;
+    /**
+    * Can be set to True when creating a brand new Merchant to indicate that default settlement rules should be created for the bank account or when editing a Merchant if HasSettlementRules = FALSE.
+    *             Attempting to set this property to FALSE if HasSettlementRules = TRUE has no effect because currently the only way to delete or disable settlement rules is via direct database access.
+    */
+    isSettlement: boolean;
+    /** This property will be set to TRUE if default settlement rules have been created for this bank account in the database. */
+    hasSettlementRules: boolean;
+    isActive: boolean;
+}
+export declare class MerchantFile {
+    fileType: MerchantFileType;
+    kybResults: KybFileResult[];
+    reference?: string;
+    yourReference?: string;
+    fileName: string;
+    mimeType: string;
+    base64Data?: string;
+    createdDate: Date;
+    lastUpdatedDate?: Date;
+}
+export declare class MerchantLoginCredentials {
+    emailAddress?: string;
+    mobileNumber?: string;
+    /** Gets or sets the username (required). */
+    username: string;
+    /** Gets or sets the password (required). */
+    password: string;
+}
+export declare class MerchantMobileWallet {
+    reference?: string;
+    msisdn: string;
+    mobileWalletOperator: MobileWalletOperator;
+    currency: Currency;
+    accountName?: string;
+    /**
+    * Can be set to True when creating a brand new Merchant to indicate that default settlement rules should be created for the mobile wallet or when editing a Merchant if HasSettlementRules = FALSE.
+    *             Attempting to set this property to FALSE if HasSettlementRules = TRUE has no effect because currently the only way to delete or disable settlement rules is via direct database access.
+    */
+    isSettlement: boolean;
+    /** This property will be set to TRUE if default settlement rules have been created for this mobile wallet in the database. */
+    hasSettlementRules: boolean;
+    isActive: boolean;
+}
+export declare class MerchantNameVerificationRequest {
+    merchantName: string;
+}
+export declare class MerchantNameVerificationResponse {
+    accessToken?: string;
+}
+export declare enum MerchantNotificationEvent {
+    PaymentSuccessful = 1,
+    PaymentFailed = 2,
+    SettlementConfirmation = 3
+}
+export declare class MerchantNotificationEventSetting {
+    event: MerchantNotificationEvent;
+    description: string;
+    sendEmail: boolean;
+    sendSms: boolean;
+    terminalReferences: string[];
+}
+export declare class MerchantProduct {
+    reference?: string;
+    createdDate: Date;
+    lastUpdatedDate?: Date;
+    yourReference?: string;
+    name: string;
+    description?: string;
+    unitLabel?: string;
+    productType: ProductType;
+    currency: Currency;
+    amountInCents: number;
+    maximumAmountInCents: number;
+    futureAmountInCents: number;
+    futureAmountEffectiveFromDate?: Date;
+    fullAmountRequired: boolean;
+    quantityRequired: boolean;
+    isActive: boolean;
+    fields: MerchantProductField[];
+}
+export declare class MerchantProductCatalog {
+    reference?: string;
+    industry: Industry;
+    name: string;
+    description?: string;
+    isActive: boolean;
+    products: MerchantProduct[];
+}
+export declare class MerchantProductField {
+    key: string;
+    name: string;
+    isRequired: boolean;
+    isAccountKey: boolean;
+    selectionItems: MerchantProductFieldSelectionItem[];
+}
+export declare class MerchantProductFieldSelectionItem {
+    label: string;
+    value: string;
+}
+export declare class MerchantQrCode {
+    reference?: string;
+    createdDate: Date;
+    lastUpdatedDate?: Date;
+    name: string;
+    shortUrl: string;
+    fullUrl: string;
+    label?: string;
+    notes?: string;
+    options: MerchantQrCodeOptions;
+    isActive: boolean;
+}
+export declare class MerchantQrCodeOptions {
+    amountInCents: number;
+    isAmountEditable: boolean;
+    tipAmountInCents: number;
+    tipEmployeeReference?: string;
+    splitReference?: string;
+    isQrCode: boolean;
+    currency?: Currency;
+    currencySymbol: string;
+    feePercentage: number;
+    enableCustomReference: boolean;
+    enableTip: boolean;
+    enableRating: boolean;
+    redirectUrl?: string;
+    notificationEmailAddresses: string[];
+    notificationMobileNumbers: string[];
+    metaData: {
+        [key: string]: string;
+    };
+    clientData: {
+        [key: string]: string;
+    };
+}
+export declare class OperatingTime {
+    reference?: string;
+    dayOfWeek: DayOfWeek;
+    fromTime: string;
+    toTime: string;
+}
+export declare class PosOptions {
+    isRefundsEnabled: boolean;
+    isCancellationsEnabled: boolean;
+    isPurchaseWithCashbackEnabled: boolean;
+    isWithdrawalsEnabled: boolean;
+    isBalanceCheckEnabled: boolean;
+    isCurrencyConversionEnabled: boolean;
+    isRcsPaymentEnabled: boolean;
+    isDebiCheckEnabled: boolean;
+    isPreAuthorizationEnabled: boolean;
+    isManualCardEntryEnabled: boolean;
+    isInvoiceNumberEnabled: boolean;
+    isPasscodeAlwaysRequired: boolean;
+    fuelPurchaseMethod: FuelPurchaseMethod;
+}
+export declare class PosPermissions {
+    canCreateUsers: boolean;
+    canProcessRefunds: boolean;
+    canCloseAndAccessBatchReports: boolean;
+    canEditDeviceSettings: boolean;
+    canExceedMaximumSaleLimits: boolean;
+}
+export declare enum SettlementTime {
+    None = "None",
+    IntraDay = "IntraDay",
+    EndOfDay = "EndOfDay",
+    TPlusOne = "TPlusOne",
+    TPlusTwo = "TPlusTwo",
+    TPlusThree = "TPlusThree",
+    TPlusSeven = "TPlusSeven"
+}
+export declare class Terminal {
+    reference?: string;
+    yourReference?: string;
+    device?: Device;
+    createdDate: Date;
+    name: string;
+    hostedPaymentUrl?: string;
+    isActive: boolean;
+    isLinked: boolean;
+    /**
+    * The list of all QR codes associated with the Terminal including QR codes that originated in external systems and QR codes generated in this system (V2QR).
+    *             V2QR codes are not stored in the database, they are generated on-the-fly every time Merchant details are retrieved, and are added to this collection at that time.
+    */
+    qrCodes: TerminalQrCode[];
+    /**
+    * A list of QR codes that originated in external systems that are associated with the Terminal.
+    *             These QR codes are stored in the database when a Merchant is registered with an external Merchant management system and QR codes are supplied by that external system.
+    */
+    externalQrCodes: TerminalQrCode[];
+    notificationTokens: TerminalNotificationToken[];
+    additionalReferences: AdditionalTerminalReference[];
+}
+export declare class TerminalConfiguration {
+    merchant: BasicMerchant;
+    industry: Industry;
+    primaryAddress?: Address;
+    merchantId: number;
+    terminalId: number;
+    posMerchantId?: string;
+    posTerminalId?: string;
+    terminalReference: string;
+    accessToken: string;
+    adminPasscode: string;
+    hostedPaymentUrl: string;
+    posOptions: PosOptions;
+    features: TerminalFeatures;
+    employees: BasicEmployee[];
+}
+export declare class TerminalFeatures {
+    isQrCodeEnabled: boolean;
+    isCardEnabled: boolean;
+    isCashEnabled: boolean;
+    isMobileMoneyEnabled: boolean;
+}
+export declare class TerminalNotificationToken {
+    reference?: string;
+    token: string;
+    platform: DevicePlatform;
+}
+export declare class TerminalPaymentQrCodes {
+    zapperQrCodeBase64?: string;
+    snapScanQrCodeBase64?: string;
+    vantagePayQrCodeBase64?: string;
+    mtnMoMoQrCodeBase64?: string;
+}
+export declare class TerminalPaymentQrCodeUrls {
+    zapperQrCodeUrl?: string;
+    snapScanQrCodeUrl?: string;
+    vantagePayQrCodeUrl?: string;
+    mtnMoMoQrCodeUrl?: string;
+}
+export declare class TerminalQrCode {
+    qrCodeType: QrCodeType;
+    qrCode: string;
+}
+export declare class TerminalSetup {
+    qrCodeBase64: string;
+    checkAccessToken: string;
+    doesTerminalExist: boolean;
+    isTerminalActive: boolean;
+    isTerminalLinked: boolean;
+}
+export declare enum TerminalType {
+    None = "None",
+    GHIPPS = "GHIPPS",
+    NIBSS = "NIBSS",
+    PAX = "PAX",
+    Verifone = "Verifone"
+}
+export declare class CategoryDetails {
+    type: string;
+    merchants: MerchantDetail[];
+}
+export declare class MerchantDetail {
+    name: string;
+    products: ProductDetail[];
+}
+export declare class ProductDetail {
+    reference: string;
+    name: string;
+    description?: string;
+    unitLabel?: string;
+    amountInCents: number;
+    futureAmountInCents: number;
+    futureAmountEffectiveFromDate?: Date;
+    fullAmountRequired: boolean;
+    quantityRequired: boolean;
+    fields: MerchantProductField[];
+}

package/dist/payments/index.d.ts

@@ -0,0 +1,38 @@
+import { BaseApi } from '../baseApi';
+import { Address } from '../common/types';
+import { MobileWalletOperator } from '../lookups/types';
+import { MerchantQrCodeOptions } from '../merchants/types';
+import { PaymentRequest, PaymentStatusResponse, QrCodeValidationRequest, QrCodeValidationResponse, CardVerificationPaymentRequest, MerchantPaymentRequest, PaymentReceiptResponse } from './types';
+import { CardRequest, CardResponse, BankAccountRequest, BankAccountResponse, VerifyCardRequest } from '../tokens/types';
+import { AxiosInstance } from 'axios';
+export declare class Payments extends BaseApi {
+    private readonly hubConnection;
+    private readonly baseUrl;
+    private activeTransactions;
+    private manuallyStartedPaymentStatusChecking;
+    constructor(axiosInstance: AxiosInstance, consoleLogging?: boolean);
+    pay(request: PaymentRequest): Promise<PaymentStatusResponse>;
+    payMerchant(merchantReference: string, request: MerchantPaymentRequest): Promise<PaymentStatusResponse>;
+    paymentStatusCheck(paymentReference: string): Promise<PaymentStatusResponse>;
+    paymentReceipt(paymentReference: string): Promise<PaymentReceiptResponse>;
+    createCardToken(request: CardRequest): Promise<CardResponse>;
+    createBankAccountToken(request: BankAccountRequest): Promise<BankAccountResponse>;
+    verifyCardToken(request: VerifyCardRequest): Promise<CardResponse>;
+    createCardVerificationPayment(request: CardVerificationPaymentRequest): Promise<PaymentStatusResponse>;
+    submitPinCode(transactionReference: string, pin: string): Promise<void>;
+    rejectPinCode(transactionReference: string): Promise<void>;
+    submitConfirmation(transactionReference: string, confirm: boolean): Promise<void>;
+    submitAddress(transactionReference: string, request: Address): Promise<void>;
+    validateQrCode(request: QrCodeValidationRequest): Promise<QrCodeValidationResponse>;
+    sendEmailPaymentNotification(paymentReference: string, emailAddress: string, templateName?: string): Promise<void>;
+    sendSmsPaymentNotification(paymentReference: string, msisdn: string): Promise<void>;
+    stopPaymentStatusChecking(paymentReference?: string): Promise<void>;
+    startPaymentStatusChecking(paymentReference?: string): Promise<PaymentStatusResponse>;
+    getOfflinePaymentFormUrl(timestamp: number, merchantId: number, terminalId: number, batchNumber: string, options: MerchantQrCodeOptions): string;
+    getRequiredPinLength(mobileWalletOperator: MobileWalletOperator): number;
+    luhnCheck(creditCardNumber: string): boolean;
+    private checkPaymentUpdateStatus;
+    private onStatusPollingInterval;
+    private addPaymentStatusCheckInterval;
+    private removePaymentStatusCheckInterval;
+}