Type Alias CreateInvoiceBackendOptions

CreateInvoiceBackendOptions: {
    amount: string;
    accepted_assets?: string;
    allow_anonymous?: boolean;
    allow_comments?: boolean;
    asset?: CryptoCurrencyCode;
    currency_type?: Crypto | Fiat;
    description?: string;
    expires_in?: number;
    fiat?: FiatCurrencyCode;
    hidden_message?: string;
    paid_btn_name?: PaidBtnName;
    paid_btn_url?: string;
    payload?: string;
}

Backend options object type for Client.createInvoice method

Type declaration

  • amount: string

    Invoice amount

  • Optionalaccepted_assets?: string

    List of cryptocurrency alphabetic codes separated comma

  • Optionalallow_anonymous?: boolean

    Is can user pay invoice anonymously

  • Optionalallow_comments?: boolean

    Is can user leave a comment for invoice

  • Optionalasset?: CryptoCurrencyCode

    Invoice asset

  • Optionalcurrency_type?: Crypto | Fiat

    Currency type

  • Optionaldescription?: string

    Invoice description, displayed to user

  • Optionalexpires_in?: number

    You can set a payment time limit for the invoice in seconds

  • Optionalfiat?: FiatCurrencyCode

    Invoice fiat

  • Optionalhidden_message?: string

    Text of the message which will be presented to a user after the invoice is paid

  • Optionalpaid_btn_name?: PaidBtnName

    Text for button which will be shown when invoice was paid

  • Optionalpaid_btn_url?: string

    Url for button which will be shown when invoice was paid

  • Optionalpayload?: string

    Invoice payload, visible only for app

Settings

Member Visibility