@benshi.ai/js-sdk/src/modules/Payments/typings.ts

Benshi SDK

import { CurrencyCode } from "../../core/commonTypes";

export enum PaymentsTypes {
    DeferredPayment = "deferred_payment",
    PaymentMethod = "payment_method"
}

export enum PaymentsMethodType {
    BankCard = "bank_card",
    BankTransfer = "bank_transfer",
    CashOnDelivery = "cash_on_delivery",
    Cheque = "cheque",
    Credit = "credit",
    PointOfSale = "point_of_sale",
    Other = "other"
}

export enum DeferredPaymentType {
    PaymentProcessed = "payment_processed"
}

export interface DeferredPaymentProperties {
    id: string,
    /**
     * this `order_id` will map with the IDs
     * within both `Checkout` and `Delivery` events
     */
    order_id: string;
    action: DeferredPaymentType,
    account_balance: number,
    payment_amount: number,
    currency: CurrencyCode,
    is_successful: boolean,
    type?: PaymentsMethodType,
    meta?: any
}
/**
 * @internal
 */
export interface InternalDeferredPaymentProperties {
    usd_rate: number
}

export interface PaymentMethodProperties {
    order_id: string,
	type: PaymentsMethodType,
	payment_amount: number
	currency: CurrencyCode // required - ISO 4217,
	meta?: any
}

/**
 * @internal
 */
export interface InternalPaymentMethodProperties {
    usd_rate: number
}