Type Alias Invoice

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;
    paidAmount?: number;
    paidAsset?: CryptoCurrencyCode;
    paidAt?: Date;
    paidBtnName?: PaidBtnName;
    paidBtnUrl?: string;
    paidFiatRate?: number;
    payload?: any;
    usdRate?: number;
}

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

Type declaration

  • 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

  • OptionalacceptedAssets?: CryptoCurrencyCode[]

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

  • Optionalcomment?: string

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

  • Optionaldescription?: string

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

  • OptionalexpirationDate?: Date

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

  • Optionalfee?: number

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

  • OptionalfeeAsset?: CryptoCurrencyCode

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

  • OptionalhiddenMessage?: string

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

  • OptionalisPaidAnonymously?: boolean

    Is invoice paid anonymously, only for paid invoice

  • OptionalpaidAmount?: number

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

  • OptionalpaidAsset?: CryptoCurrencyCode

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

  • OptionalpaidAt?: Date

    Invoice paid date, only for paid invoice

  • OptionalpaidBtnName?: PaidBtnName

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

  • OptionalpaidBtnUrl?: string

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

  • OptionalpaidFiatRate?: number

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

  • Optionalpayload?: 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

  • OptionalusdRate?: number

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

Settings

Member Visibility