react-monnify-2/libs/types.ts

This is an reactJS library for implementing monnify payment gateway

export interface MonnifyProps {
  /**
   * development status | Should be set to true when using the sandbox and false when on production
   */
  isTestMode?: true | false;
  /**
   * Merchant's API Key (Can be found on the Monnify dashboard)
   */
  apiKey: string;
  /**
   * Merchant's contract code (Can be found on the Monnify dashboard)
   */
  contractCode: string;
  /**
   * The amount to be paid by the customer
   */
  amount: number;
  /**
   * The currency of the transaction being initialized. `NGN`
   */
  currency: string;
  /**
   * Merchant's Unique reference for every transaction.
   * (The SDK already has a code snippet that generates this for you, but you can always replace it)
   */
  reference: string;
  /**
   * Full name of the customer
   */
  customerFullName: string;
  /**
   * Email address of the customer
   */
  customerEmail: string;
  /**
   * Description for the transaction. Will be used as the account name for bank transfer payments
   */
  paymentDescription?: string;
  /**
   * Transaction Hash added to transaction response for security purposes.
   *  Click here {@link https://docs.teamapt.com/display/MON/Calculating+the+Transaction+Hash Monnify}.
   *  for information on how to calculate the hash value
   */
  transactionHash?: {};
  /**
   * Status of the transaction ("PAID", "PENDING" or "FAILED")
   */
  paymentStatus?: 'PAID' | 'PENDING' | 'FAILED' | string;
  /**
   * Payment method used on the transaction ("CARD", "ACCOUNT_TRANSFER", "USSD", "PHONE_NUMBER")
   */
  paymentMethods?: MonnifyPaymentMethods[];
  /**
   * Object containing specifications on how payments to this reserve account should be split.
   */
  incomeSplitConfig?: MonnifySplitOptions[];
  /**
   * Redirect URL
   */
  redirectUrl?: string;
  /**
   * When you need to pass extra data to the API.
   */
  metadata?: object;

  'data-custom-button'?: string;
}

export interface MonnifySplitOptions {
  /**
   * The unique reference for the sub account that should receive the split.
   */
  subAccountCode: string;
  /**
   * Boolean to determine if the sub account should bear transaction fees or not
   */
  feeBearer?: boolean;
  /**
   * The percentage of the transaction fee to be borne by the sub account
   */
  feePercentage?: number;
  /**
   * The percentage of the amount paid to be split into the sub account.
   */
  splitPercentage?: string;
  /**
   * The percentage of the amount paid to be split into the sub account.
   */
  splitAmount?: number;
}

export type MonnifyPaymentMethods = 'CARD' | 'ACCOUNT_TRANSFER' | 'USSD' | 'PHONE_NUMBER';