cngn-typescript-library/dist/utils/types.d.ts

A lightweight Typescript library to give you the best experience with managing your cNGN merchant account

export type Secrets = {
    apiKey: string;
    privateKey: string;
    encryptionKey: string;
};
export type IResponse<T> = {
    success: boolean;
    data?: T;
    error?: string;
};
export type AESEncryptionResponse = {
    iv: string;
    content: string;
};
export type Balance = {
    asset_type: string;
    asset_code: any;
    balance: string;
};
/** @deprecated Use of 'budpay' and 'bellbank' is deprecated. */
export type ProviderType = 'korapay' | 'budpay' | 'bellbank';
export declare enum TrxType {
    fiat_buy = "fiat_buy",
    crypto_deposit = "crypto_deposit",
    enaira_buy = "enaira_buy",
    fiat_redeem = "fiat_redeem",
    withdraw = "withdraw",
    enaira_redeem = "enaira_redeem",
    swap = "swap"
}
export declare enum Network {
    bsc = "bsc",
    atc = "atc",
    xbn = "xbn",
    eth = "eth",
    matic = "matic",
    trx = "trx",
    base = "base"
}
export declare enum AssetType {
    fiat = "fiat",
    wrapped = "wrapped",
    enaira = "enaira"
}
export declare enum Status {
    pending = "pending",
    pending_deposit = "pending_deposit",
    failed = "failed",
    rejected = "rejected",
    completed = "completed"
}
export interface IWithdraw {
    shouldSaveAddress?: boolean;
    amount: number;
    address: string;
    network: Network;
}
export interface RedeemAsset {
    amount: number;
    bankCode: string;
    accountNumber: string;
    saveDetails?: boolean;
}
export interface CreateVirtualAccount {
    provider: ProviderType;
    bank_code?: string;
}
export interface IVirtualAccount {
    accountReference: string;
    accountNumber: string;
}
export interface ExternalAccounts {
    xbn_address?: string | null;
    atc_address?: string | null;
    bsc_address?: string | null;
    eth_address?: string | null;
    base_address?: string | null;
    polygon_address?: string | null;
    tron_address?: string | null;
    bank_account_name?: string | null;
    bank_name?: string | null;
    bank_account_number?: string | null;
}
export interface IBanks {
    "name": string;
    "slug": string;
    "code": string;
    "country": string;
    "nibss_bank_code": string;
}
export interface UpdateExternalAccount {
    walletAddress?: ({
        bantuUserId: string;
        xbnAddress?: never;
        bscAddress?: never;
        atcAddress?: never;
        polygonAddress?: never;
        ethAddress?: never;
        tronAddress?: never;
        baseAddress?: never;
    } | {
        xbnAddress: string;
        bantuUserId?: never;
        bscAddress?: never;
        atcAddress?: never;
        polygonAddress?: never;
        ethAddress?: never;
        tronAddress?: never;
        baseAddress?: never;
    } | {
        bscAddress: string;
        bantuUserId?: never;
        xbnAddress?: never;
        atcAddress?: never;
        polygonAddress?: never;
        ethAddress?: never;
        tronAddress?: never;
        baseAddress?: never;
    } | {
        atcAddress: string;
        bantuUserId?: never;
        xbnAddress?: never;
        bscAddress?: never;
        polygonAddress?: never;
        ethAddress?: never;
        tronAddress?: never;
        baseAddress?: never;
    } | {
        polygonAddress: string;
        bantuUserId?: never;
        xbnAddress?: never;
        bscAddress?: never;
        atcAddress?: never;
        ethAddress?: never;
        tronAddress?: never;
        baseAddress?: never;
    } | {
        ethAddress: string;
        bantuUserId?: never;
        xbnAddress?: never;
        bscAddress?: never;
        atcAddress?: never;
        polygonAddress?: never;
        tronAddress?: never;
        baseAddress?: never;
    } | {
        tronAddress: string;
        bantuUserId?: never;
        xbnAddress?: never;
        bscAddress?: never;
        atcAddress?: never;
        polygonAddress?: never;
        ethAddress?: never;
        baseAddress?: never;
    } | {
        baseAddress: string;
        bantuUserId?: never;
        xbnAddress?: never;
        bscAddress?: never;
        atcAddress?: never;
        polygonAddress?: never;
        ethAddress?: never;
        tronAddress?: never;
    });
    bankDetails?: {
        bankName?: string;
        bankAccountName?: string;
        bankAccountNumber?: string;
    };
}
export interface IWithdrawResponse {
    trxRef: string;
    address: string;
}
export interface IPagination {
    count: number;
    pages: number;
    isLastPage: boolean;
    nextPage: number | null;
    previousPage: number | null;
}
export interface ITransactionPagination {
    data: Transactions[];
    pagination: IPagination;
}
export interface Transactions {
    id: string;
    from: string;
    receiver: Receiver;
    amount: string;
    description: string;
    createdAt: string;
    trx_ref: string;
    trx_type: string;
    network: string;
    asset_type: string;
    asset_symbol: string;
    base_trx_hash: string;
    extl_trx_hash: string;
    explorer_link: string;
    status: string;
}
interface Receiver {
    address?: string;
    bank?: string;
    accountNumber?: string;
}
export interface GeneratedWalletAddress {
    mnemonic: string | null;
    address: string;
    network: Network;
    privateKey: string;
}
export interface Swap {
    destinationNetwork: Network;
    destinationAddress: string;
    originNetwork: Network;
    callbackUrl?: string;
    senderAddress?: string;
}
export interface SwapResponse {
    receivableAddress: string;
    transactionId: string;
    reference: string;
}
export interface ISwapQuote {
    amount: number;
    destinationAddress: string;
    originNetwork: Network;
    destinationNetwork: Network;
}
export interface ISwapQuoteResponse {
    amountReceivable: string;
    networkFee: string;
    bridgeFee: string;
}
export {};