mtn-momo-client/src/products/collection.ts

A collection of utils to interact with the mtn-momo api

import { Product } from '../types';

import { createProductClient } from './common/client';
import type { CreateProductClientOptions } from './common/client';
import { createAccountBalanceFetcher } from './common/createAccountBalanceFetcher';
import type { FetchAccountBalance } from './common/createAccountBalanceFetcher';
import { createBasicUserInfoFetcher } from './common/createGetBasicUserInfo';
import type { FetchBasicUserInfo } from './common/createGetBasicUserInfo';
import { createRequestToPayDeliveryNotification } from './common/createRequestToPayDeliveryNotification';
import type { RequestToPayDeliveryNotification } from './common/createRequestToPayDeliveryNotification';
import { createTransactionInitiator } from './common/createTransactionInitiator';
import type { InitiateTransaction } from './common/createTransactionInitiator';
import { createTransactionStatusFetcher } from './common/createTransactionStatusFetcher';
import type { FetchTransactionStatus } from './common/createTransactionStatusFetcher';
import { createValidateAccountHolderStatus } from './common/createValidateAccountHolderStatus';
import type { ValidateAccountHolderStatus } from './common/createValidateAccountHolderStatus';

type CreateCollectionAPIOptions = Omit<
  CreateProductClientOptions,
  'targetProduct'
>;

type CreateCollectionAPIResult = {
  /**
   * This operation is used to request a payment from a consumer (Payer). The payer will be asked to authorize the payment.
   * The transaction will be executed once the payer has authorized the payment.
   * The requesttopay will be in status PENDING until the transaction is authorized or declined by the payer or it is timed out by the system.
   * Status of the transaction can be validated by using the requestToPayTransactionStatus method
   */
  requestToPay: InitiateTransaction<Product.Collection>;

  /**
   * This operation is used to get the status of a request to pay
   */
  requestToPayTransactionStatus: FetchTransactionStatus<Product.Collection>;

  /** Get the balance of the account */
  getAccountBalance: FetchAccountBalance;

  /** This operation returns personal information of the account holder. The operation does not need any consent by the account holder. */
  getBasicUserInfo: FetchBasicUserInfo;

  /** This operation is used to check if an account holder is registered and active in the system. */
  validateAccountHolderStatus: ValidateAccountHolderStatus;

  /** This operation is used to send additional Notification to an End User. */
  requestToPayDeliveryNotification: RequestToPayDeliveryNotification;
};

/**
 * Creates methods to access the collections API
 * @param options Properties to use when creating functions to access the collections API
 * @returns {CreateCollectionAPIResult} Methods to access the collections API
 */
const createCollectionAPI = (
  options: CreateCollectionAPIOptions
): CreateCollectionAPIResult => {
  const client = createProductClient({
    ...options,
    targetProduct: Product.Collection,
  });

  const requestToPay = createTransactionInitiator({
    client,
    targetProduct: Product.Collection,
  });

  const requestToPayTransactionStatus = createTransactionStatusFetcher({
    client,
    targetProduct: Product.Collection,
  });

  const getAccountBalance = createAccountBalanceFetcher({ client });

  const getBasicUserInfo = createBasicUserInfoFetcher({ client });

  const validateAccountHolderStatus = createValidateAccountHolderStatus({
    client,
  });

  const requestToPayDeliveryNotification =
    createRequestToPayDeliveryNotification({ client });

  return {
    requestToPay,
    requestToPayTransactionStatus,
    getAccountBalance,
    getBasicUserInfo,
    validateAccountHolderStatus,
    requestToPayDeliveryNotification,
  };
};

export { createCollectionAPI };