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

    Interface IWithdrawSuccess

    interface IWithdrawSuccess {
        data: {
            amount: string;
            created_at_utc: number;
            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";
            fee: string;
            id: string;
            params: { fee: { conf_target: number; plan: FeePlan; value: 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";
            sendmany?: { [key: string]: number };
            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: "completed"
            | "error";
            tx_url: string;
            type: WithdrawType;
            wallet_hash?: string;
        };
        status: "success";
    }
    Index

    Properties

    Properties

    data: {
        amount: string;
        created_at_utc: number;
        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";
        fee: string;
        id: string;
        params: { fee: { conf_target: number; plan: FeePlan; value: 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";
        sendmany?: { [key: string]: number };
        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: "completed"
        | "error";
        tx_url: string;
        type: WithdrawType;
        wallet_hash?: string;
    }

    Type declaration

    • amount: string

      Transfer amount in cryptocurrency

    • created_at_utc: number

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

    • 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"

      Code column from supported cryptocurrencies

    • fee: string

      Transaction fee stated in the transfer

    • id: string

      Internal Plisio operation ID

    • params: { fee: { conf_target: number; plan: FeePlan; value: string } }
      • fee: { conf_target: number; plan: FeePlan; value: string }
        • conf_target: number

          Estimated fee parameter to confirm the transaction in the “conf_target” blocks

        • plan: FeePlan

          The Plisio’s fee plan name

        • value: string

          fee value

    • 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"
    • Optionalsendmany?: { [key: string]: number }

      Pairs of hashes and values (if type=mass_cash_out)

    • 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"

      Name of the fiat currency (only USD available)

    • source_rate: string

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

    • status: "completed" | "error"

      Specifies whether the operation was completed or not (completed, error)

    • tx_url: string

      Link to the cryptocurrency block explorer

    • type: WithdrawType

      “cash_out” or “mass_cash_out” depending on the request

    • Optionalwallet_hash?: string

      Destination hash (if type=cash_out)

    status: "success"