@axonlabs/payments - v0.2.0
    Preparing search index...

    Interface ICreateInvoiceSuccessWhiteLabel

    interface ICreateInvoiceSuccessWhiteLabel {
        data: {
            amount: string;
            currency:
                | "ETH"
                | "ETH_BASE"
                | "BTC"
                | "LTC"
                | "DASH"
                | "TZEC"
                | "DOGE"
                | "BCH"
                | "XMR"
                | "USDT"
                | "USDC"
                | "USDC_BASE"
                | "SHIB"
                | "APE"
                | "BTT"
                | "USDT_TRX"
                | "TRX"
                | "BNB"
                | "BUSD"
                | "USDT_BSC"
                | "USDС_BSC"
                | "LB"
                | "ETC"
                | "TON"
                | "USDT_TON"
                | "SOL"
                | "USDT_SOL";
            expected_confirmations: string;
            expire_utc: number;
            invoice_commission: string;
            invoice_sum: string;
            invoice_total_sum: string;
            invoice_url: string;
            pending_amount: string;
            psys_cid: | "ETH"
            | "ETH_BASE"
            | "BTC"
            | "LTC"
            | "DASH"
            | "TZEC"
            | "DOGE"
            | "BCH"
            | "XMR"
            | "USDT"
            | "USDC"
            | "USDC_BASE"
            | "SHIB"
            | "APE"
            | "BTT"
            | "USDT_TRX"
            | "TRX"
            | "BNB"
            | "BUSD"
            | "USDT_BSC"
            | "USDС_BSC"
            | "LB"
            | "ETC"
            | "TON"
            | "USDT_TON"
            | "SOL"
            | "USDT_SOL";
            qr_code: string;
            source_currency: | "AED"
            | "AFN"
            | "ALL"
            | "AMD"
            | "ANG"
            | "AOA"
            | "ARS"
            | "AUD"
            | "AWG"
            | "AZN"
            | "BAM"
            | "BBD"
            | "BDT"
            | "BGN"
            | "BHD"
            | "BIF"
            | "BMD"
            | "BND"
            | "BOB"
            | "BRL"
            | "BSD"
            | "BTN"
            | "BWP"
            | "BYN"
            | "BYR"
            | "BZD"
            | "CAD"
            | "CDF"
            | "CHF"
            | "CLF"
            | "CLP"
            | "CNY"
            | "COP"
            | "CRC"
            | "CUC"
            | "CUP"
            | "CVE"
            | "CZK"
            | "DJF"
            | "DKK"
            | "DOP"
            | "DZD"
            | "EGP"
            | "ERN"
            | "ETB"
            | "EUR"
            | "FJD"
            | "FKP"
            | "GBP"
            | "GEL"
            | "GGP"
            | "GHS"
            | "GIP"
            | "GMD"
            | "GNF"
            | "GTQ"
            | "GYD"
            | "HKD"
            | "HNL"
            | "HRK"
            | "HTG"
            | "HUF"
            | "IDR"
            | "ILS"
            | "IMP"
            | "INR"
            | "IQD"
            | "IRR"
            | "ISK"
            | "JEP"
            | "JMD"
            | "JOD"
            | "JPY"
            | "KES"
            | "KGS"
            | "KHR"
            | "KMF"
            | "KPW"
            | "KRW"
            | "KWD"
            | "KYD"
            | "KZT"
            | "LAK"
            | "LBP"
            | "LKR"
            | "LRD"
            | "LSL"
            | "LTL"
            | "LVL"
            | "LYD"
            | "MAD"
            | "MDL"
            | "MGA"
            | "MKD"
            | "MMK"
            | "MNT"
            | "MOP"
            | "MRO"
            | "MUR"
            | "MVR"
            | "MWK"
            | "MXN"
            | "MYR"
            | "MZN"
            | "NAD"
            | "NGN"
            | "NIO"
            | "NOK"
            | "NPR"
            | "NZD"
            | "OMR"
            | "PAB"
            | "PEN"
            | "PGK"
            | "PHP"
            | "PKR"
            | "PLN"
            | "PYG"
            | "QAR"
            | "RON"
            | "RSD"
            | "RUB"
            | "RWF"
            | "SAR"
            | "SBD"
            | "SCR"
            | "SDG"
            | "SEK"
            | "SGD"
            | "SHP"
            | "SLL"
            | "SOS"
            | "SRD"
            | "STD"
            | "SVC"
            | "SYP"
            | "SZL"
            | "THB"
            | "TJS"
            | "TMT"
            | "TND"
            | "TOP"
            | "TRY"
            | "TTD"
            | "TWD"
            | "TZS"
            | "UAH"
            | "UGX"
            | "USD"
            | "UYU"
            | "UZS"
            | "VEF"
            | "VND"
            | "VUV"
            | "WST"
            | "XAF"
            | "XAG"
            | "XAU"
            | "XCD"
            | "XDR"
            | "XOF"
            | "XPF"
            | "YER"
            | "ZAR"
            | "ZMK"
            | "ZMW"
            | "ZWL";
            source_rate: string;
            status: | "new"
            | "pending"
            | "pending internal"
            | "expired"
            | "completed"
            | "mismatch"
            | "error"
            | "cancelled";
            txn_id: string;
            verify_hash: string;
            wallet_hash: string;
        };
        status: "success";
    }
    Index

    Properties

    Properties

    data: {
        amount: string;
        currency:
            | "ETH"
            | "ETH_BASE"
            | "BTC"
            | "LTC"
            | "DASH"
            | "TZEC"
            | "DOGE"
            | "BCH"
            | "XMR"
            | "USDT"
            | "USDC"
            | "USDC_BASE"
            | "SHIB"
            | "APE"
            | "BTT"
            | "USDT_TRX"
            | "TRX"
            | "BNB"
            | "BUSD"
            | "USDT_BSC"
            | "USDС_BSC"
            | "LB"
            | "ETC"
            | "TON"
            | "USDT_TON"
            | "SOL"
            | "USDT_SOL";
        expected_confirmations: string;
        expire_utc: number;
        invoice_commission: string;
        invoice_sum: string;
        invoice_total_sum: string;
        invoice_url: string;
        pending_amount: string;
        psys_cid: | "ETH"
        | "ETH_BASE"
        | "BTC"
        | "LTC"
        | "DASH"
        | "TZEC"
        | "DOGE"
        | "BCH"
        | "XMR"
        | "USDT"
        | "USDC"
        | "USDC_BASE"
        | "SHIB"
        | "APE"
        | "BTT"
        | "USDT_TRX"
        | "TRX"
        | "BNB"
        | "BUSD"
        | "USDT_BSC"
        | "USDС_BSC"
        | "LB"
        | "ETC"
        | "TON"
        | "USDT_TON"
        | "SOL"
        | "USDT_SOL";
        qr_code: string;
        source_currency: | "AED"
        | "AFN"
        | "ALL"
        | "AMD"
        | "ANG"
        | "AOA"
        | "ARS"
        | "AUD"
        | "AWG"
        | "AZN"
        | "BAM"
        | "BBD"
        | "BDT"
        | "BGN"
        | "BHD"
        | "BIF"
        | "BMD"
        | "BND"
        | "BOB"
        | "BRL"
        | "BSD"
        | "BTN"
        | "BWP"
        | "BYN"
        | "BYR"
        | "BZD"
        | "CAD"
        | "CDF"
        | "CHF"
        | "CLF"
        | "CLP"
        | "CNY"
        | "COP"
        | "CRC"
        | "CUC"
        | "CUP"
        | "CVE"
        | "CZK"
        | "DJF"
        | "DKK"
        | "DOP"
        | "DZD"
        | "EGP"
        | "ERN"
        | "ETB"
        | "EUR"
        | "FJD"
        | "FKP"
        | "GBP"
        | "GEL"
        | "GGP"
        | "GHS"
        | "GIP"
        | "GMD"
        | "GNF"
        | "GTQ"
        | "GYD"
        | "HKD"
        | "HNL"
        | "HRK"
        | "HTG"
        | "HUF"
        | "IDR"
        | "ILS"
        | "IMP"
        | "INR"
        | "IQD"
        | "IRR"
        | "ISK"
        | "JEP"
        | "JMD"
        | "JOD"
        | "JPY"
        | "KES"
        | "KGS"
        | "KHR"
        | "KMF"
        | "KPW"
        | "KRW"
        | "KWD"
        | "KYD"
        | "KZT"
        | "LAK"
        | "LBP"
        | "LKR"
        | "LRD"
        | "LSL"
        | "LTL"
        | "LVL"
        | "LYD"
        | "MAD"
        | "MDL"
        | "MGA"
        | "MKD"
        | "MMK"
        | "MNT"
        | "MOP"
        | "MRO"
        | "MUR"
        | "MVR"
        | "MWK"
        | "MXN"
        | "MYR"
        | "MZN"
        | "NAD"
        | "NGN"
        | "NIO"
        | "NOK"
        | "NPR"
        | "NZD"
        | "OMR"
        | "PAB"
        | "PEN"
        | "PGK"
        | "PHP"
        | "PKR"
        | "PLN"
        | "PYG"
        | "QAR"
        | "RON"
        | "RSD"
        | "RUB"
        | "RWF"
        | "SAR"
        | "SBD"
        | "SCR"
        | "SDG"
        | "SEK"
        | "SGD"
        | "SHP"
        | "SLL"
        | "SOS"
        | "SRD"
        | "STD"
        | "SVC"
        | "SYP"
        | "SZL"
        | "THB"
        | "TJS"
        | "TMT"
        | "TND"
        | "TOP"
        | "TRY"
        | "TTD"
        | "TWD"
        | "TZS"
        | "UAH"
        | "UGX"
        | "USD"
        | "UYU"
        | "UZS"
        | "VEF"
        | "VND"
        | "VUV"
        | "WST"
        | "XAF"
        | "XAG"
        | "XAU"
        | "XCD"
        | "XDR"
        | "XOF"
        | "XPF"
        | "YER"
        | "ZAR"
        | "ZMK"
        | "ZMW"
        | "ZWL";
        source_rate: string;
        status: | "new"
        | "pending"
        | "pending internal"
        | "expired"
        | "completed"
        | "mismatch"
        | "error"
        | "cancelled";
        txn_id: string;
        verify_hash: string;
        wallet_hash: string;
    }

    Type declaration

    • amount: string

      Invoice amount in the selected cryptocurrency

    • currency:
          | "ETH"
          | "ETH_BASE"
          | "BTC"
          | "LTC"
          | "DASH"
          | "TZEC"
          | "DOGE"
          | "BCH"
          | "XMR"
          | "USDT"
          | "USDC"
          | "USDC_BASE"
          | "SHIB"
          | "APE"
          | "BTT"
          | "USDT_TRX"
          | "TRX"
          | "BNB"
          | "BUSD"
          | "USDT_BSC"
          | "USDС_BSC"
          | "LB"
          | "ETC"
          | "TON"
          | "USDT_TON"
          | "SOL"
          | "USDT_SOL"

      Cryptocurrencies code (supported cryptocurrencies)

    • expected_confirmations: string

      How many confirmations expected to mark invoice completed

    • expire_utc: number

      Timestamp in the UTC timezone; it may need to be divided by 1000

    • invoice_commission: string

      Plisio commission

    • invoice_sum: string

      Shop pays commission: invoice amount - invoice_commission

      client pays commission: invoice amount

    • invoice_total_sum: string

      shop pays commission: invoice amount

      client pays commission: invoice_commission + invoice_sum

    • invoice_url: string

      Invoice URL

    • pending_amount: string

      The remaining amount to be paid in the selected cryptocurrency

    • psys_cid:
          | "ETH"
          | "ETH_BASE"
          | "BTC"
          | "LTC"
          | "DASH"
          | "TZEC"
          | "DOGE"
          | "BCH"
          | "XMR"
          | "USDT"
          | "USDC"
          | "USDC_BASE"
          | "SHIB"
          | "APE"
          | "BTT"
          | "USDT_TRX"
          | "TRX"
          | "BNB"
          | "BUSD"
          | "USDT_BSC"
          | "USDС_BSC"
          | "LB"
          | "ETC"
          | "TON"
          | "USDT_TON"
          | "SOL"
          | "USDT_SOL"

      Cryptocurrencies ID (supported cryptocurrencies)

    • qr_code: string

      QR code image in base64 format

    • source_currency:
          | "AED"
          | "AFN"
          | "ALL"
          | "AMD"
          | "ANG"
          | "AOA"
          | "ARS"
          | "AUD"
          | "AWG"
          | "AZN"
          | "BAM"
          | "BBD"
          | "BDT"
          | "BGN"
          | "BHD"
          | "BIF"
          | "BMD"
          | "BND"
          | "BOB"
          | "BRL"
          | "BSD"
          | "BTN"
          | "BWP"
          | "BYN"
          | "BYR"
          | "BZD"
          | "CAD"
          | "CDF"
          | "CHF"
          | "CLF"
          | "CLP"
          | "CNY"
          | "COP"
          | "CRC"
          | "CUC"
          | "CUP"
          | "CVE"
          | "CZK"
          | "DJF"
          | "DKK"
          | "DOP"
          | "DZD"
          | "EGP"
          | "ERN"
          | "ETB"
          | "EUR"
          | "FJD"
          | "FKP"
          | "GBP"
          | "GEL"
          | "GGP"
          | "GHS"
          | "GIP"
          | "GMD"
          | "GNF"
          | "GTQ"
          | "GYD"
          | "HKD"
          | "HNL"
          | "HRK"
          | "HTG"
          | "HUF"
          | "IDR"
          | "ILS"
          | "IMP"
          | "INR"
          | "IQD"
          | "IRR"
          | "ISK"
          | "JEP"
          | "JMD"
          | "JOD"
          | "JPY"
          | "KES"
          | "KGS"
          | "KHR"
          | "KMF"
          | "KPW"
          | "KRW"
          | "KWD"
          | "KYD"
          | "KZT"
          | "LAK"
          | "LBP"
          | "LKR"
          | "LRD"
          | "LSL"
          | "LTL"
          | "LVL"
          | "LYD"
          | "MAD"
          | "MDL"
          | "MGA"
          | "MKD"
          | "MMK"
          | "MNT"
          | "MOP"
          | "MRO"
          | "MUR"
          | "MVR"
          | "MWK"
          | "MXN"
          | "MYR"
          | "MZN"
          | "NAD"
          | "NGN"
          | "NIO"
          | "NOK"
          | "NPR"
          | "NZD"
          | "OMR"
          | "PAB"
          | "PEN"
          | "PGK"
          | "PHP"
          | "PKR"
          | "PLN"
          | "PYG"
          | "QAR"
          | "RON"
          | "RSD"
          | "RUB"
          | "RWF"
          | "SAR"
          | "SBD"
          | "SCR"
          | "SDG"
          | "SEK"
          | "SGD"
          | "SHP"
          | "SLL"
          | "SOS"
          | "SRD"
          | "STD"
          | "SVC"
          | "SYP"
          | "SZL"
          | "THB"
          | "TJS"
          | "TMT"
          | "TND"
          | "TOP"
          | "TRY"
          | "TTD"
          | "TWD"
          | "TZS"
          | "UAH"
          | "UGX"
          | "USD"
          | "UYU"
          | "UZS"
          | "VEF"
          | "VND"
          | "VUV"
          | "WST"
          | "XAF"
          | "XAG"
          | "XAU"
          | "XCD"
          | "XDR"
          | "XOF"
          | "XPF"
          | "YER"
          | "ZAR"
          | "ZMK"
          | "ZMW"
          | "ZWL"

      Fiat currency

    • source_rate: string

      Exchange rate from the “psys_cid” to the “source_currency” at the moment of transfer

    • status:
          | "new"
          | "pending"
          | "pending internal"
          | "expired"
          | "completed"
          | "mismatch"
          | "error"
          | "cancelled"

      Status of invoice

    • txn_id: string

      Plisio’s intertnal ID

    • verify_hash: string

      Hash to verify the “POST” data signed with your SHOP_API_KEY

    • wallet_hash: string

      Invoice hash

    status: "success"