Crypto Bot API
    Preparing search index...

    Type Alias Invoice

    Invoice type object for Client.getInvoices, Client.getInvoicesPaginate, Client.createInvoice methods results and ClientEmitter paid event emit

    type Invoice = {
        amount: string;
        botPayUrl: string;
        createdAt: Date;
        currency: CurrencyCode;
        currencyType: CurrencyType;
        hash: string;
        id: number;
        isAllowAnonymous: boolean;
        isAllowComments: boolean;
        miniAppPayUrl: string;
        status: InvoiceStatus;
        webAppPayUrl: string;
        acceptedAssets?: CryptoCurrencyCode[];
        comment?: string;
        description?: string;
        expirationDate?: Date;
        fee?: number;
        feeAsset?: CryptoCurrencyCode;
        hiddenMessage?: string;
        isPaidAnonymously?: boolean;
        isSwapped?: boolean;
        paidAmount?: number;
        paidAsset?: CryptoCurrencyCode;
        paidAt?: Date;
        paidBtnName?: PaidBtnName;
        paidBtnUrl?: string;
        paidFiatRate?: number;
        payload?: any;
        swappedOutput?: string;
        swappedRate?: number;
        swappedTo?: SwappableTargetCurrencies;
        swappedUid?: string;
        swappedUsdAmount?: string;
        swappedUsdRate?: number;
        swapTo?: SwappableTargetCurrencies;
        usdRate?: number;
    }
    Index

    Properties

    amount botPayUrl createdAt currency currencyType hash id isAllowAnonymous isAllowComments miniAppPayUrl status webAppPayUrl acceptedAssets? comment? description? expirationDate? fee? feeAsset? hiddenMessage? isPaidAnonymously? isSwapped? paidAmount? paidAsset? paidAt? paidBtnName? paidBtnUrl? paidFiatRate? payload? swappedOutput? swappedRate? swappedTo? swappedUid? swappedUsdAmount? swappedUsdRate? swapTo? usdRate?

    Properties

    amount: string

    Invoice amount

    botPayUrl: string

    Invoice pay url for user by bot

    createdAt: Date

    Invoice created date

    currency: CurrencyCode

    Invoice currency code

    currencyType: CurrencyType

    Invoice currency type

    hash: string

    Invoice hash

    id: number

    Invoice identifier

    isAllowAnonymous: boolean

    Is user can pay invoice anonymously

    isAllowComments: boolean

    Is invoice allow user comment

    miniAppPayUrl: string

    Invoice pay url for user by mini app

    status: InvoiceStatus

    Invoice status

    webAppPayUrl: string

    Invoice pay url for user by web app

    acceptedAssets?: CryptoCurrencyCode[]

    List of assets which can be used to pay the invoice, only if set in invoice creation

    comment?: string

    Invoice left user comment, only if set isAllowComments to true in invoice creation and user left comment

    description?: string

    Invoice displayed to user description, only if description passed in invoice creation

    expirationDate?: Date

    Expiration date, only if set pay limit time in invoice creation

    fee?: number

    Amount of service fees charged when the invoice was paid, only if status is InvoiceStatus.Paid

    feeAsset?: CryptoCurrencyCode

    Asset of service fees charged when the invoice was paid, only if status is InvoiceStatus.Paid

    hiddenMessage?: string

    Text of the hidden message, only if set in invoice creation

    isPaidAnonymously?: boolean

    Is invoice paid anonymously, only for paid invoice

    isSwapped?: boolean

    For invoices with the "paid" status, this flag indicates whether the swap was successful

    paidAmount?: number

    Amount of the invoice for which the invoice was paid, only if currency type is CurrencyType.Fiat and status is InvoiceStatus.Paid

    paidAsset?: CryptoCurrencyCode

    Cryptocurrency alphabetic code for which the invoice was paid, only if currency type is CurrencyType.Fiat and status is InvoiceStatus.Paid

    paidAt?: Date

    Invoice paid date, only for paid invoice

    paidBtnName?: PaidBtnName

    Invoice displayed to user paid button name, only if paidBtnName passed in invoice creation

    paidBtnUrl?: string

    Invoice displayed to user paid button url, only if paidBtnUrl passed in invoice creation

    paidFiatRate?: number

    The rate of the paid_asset valued in the fiat currency, only if currency type is CurrencyType.Fiat and status is InvoiceStatus.Paid

    payload?: any

    Invoice visible only to app payload, only if payload passed in invoice creation

    If for invoice creation passed not string in this field, will be converted by JSON.parse

    swappedOutput?: string

    If is_swapped is true, stores the amount received as a result of the swap(in the swapped_to asset)

    swappedRate?: number

    If is_swapped is true, stores the exchange rate at which the swap was executed

    swappedTo?: SwappableTargetCurrencies

    If is_swapped is true, stores the asset into which the swap was made

    swappedUid?: string

    If is_swapped is true, stores the unique identifier of the swap

    swappedUsdAmount?: string

    If is_swapped is true, stores the resulting swap amount in USD

    swappedUsdRate?: number

    If is_swapped is true, stores the USD exchange rate of the currency from swapped_to

    swapTo?: SwappableTargetCurrencies

    The asset that will be attempted to be swapped into after the user makes a payment

    usdRate?: number

    Price of the asset in USD, only if status is InvoiceStatus.Paid

    Settings

    Member Visibility

    On This Page

    Properties