Class Device


  • public final class Device
    extends java.lang.Object
    device Details of the device from which the payment originated.
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Device.DeviceBuilder  
    • Constructor Summary

      Constructors 
      Constructor Description
      Device()  
      Device​(java.lang.String userAgent, Network network, Provider provider, java.lang.String timestamp, java.lang.String timezone, java.lang.Boolean virtualMachine, java.lang.Boolean incognito, java.lang.Boolean jailbroken, java.lang.Boolean rooted, java.lang.Boolean javaEnabled, java.lang.Boolean javascriptEnabled, java.lang.String language, java.lang.String colorDepth, java.lang.String screenHeight, java.lang.String screenWidth, java.lang.String userAgentClientHint, java.lang.Boolean iframePaymentAllowed, java.lang.String acceptHeader)
      Creates a new Device instance.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static Device.DeviceBuilder builder()  
      boolean equals​(java.lang.Object o)  
      java.lang.String getAcceptHeader()
      The exact content of the HTTP Accept headers as sent to the 3DS Requestor from the cardholder’s browser.
      java.lang.String getColorDepth()
      The bit depth of the color palette for displaying images in bits per pixel, as reported by the browser's screen.colorDepth property.
      java.lang.Boolean getIframePaymentAllowed()
      Indicates whether the Payments API is enabled for all parent frames.
      java.lang.Boolean getIncognito()
      Specifies if the browser is in incognito mode.
      java.lang.Boolean getJailbroken()
      Specifies if the device is jailbroken.
      java.lang.Boolean getJavaEnabled()
      Specifies if the browser has the ability to execute Java, as reported by the browser's navigator.javaEnabled property.
      java.lang.Boolean getJavascriptEnabled()
      Specifies if the browser has the ability to execute Javascript, as reported by the browser's navigator.javascriptEnabled property.
      java.lang.String getLanguage()
      The browser language, as reported by the browser's navigator.language property.
      Network getNetwork()
      Details of the device network.
      Provider getProvider()
      Details of the device ID provider.
      java.lang.Boolean getRooted()
      Specifies if the device is rooted.
      java.lang.String getScreenHeight()
      The total height of the device screen in pixels, as reported by the browser's screen.height property.
      java.lang.String getScreenWidth()
      The total width of the device screen in pixels, as reported by the browser's screen.width property.
      java.lang.String getTimestamp()
      The UTC date and time the payment was performed as reported by the device.
      java.lang.String getTimezone()
      The time difference between UTC time and the local time reported by the browser, in minutes.
      java.lang.String getUserAgent()
      The contents of the HTTP User-Agent request header.
      java.lang.String getUserAgentClientHint()
      The raw Sec-CH-UA header value.
      java.lang.Boolean getVirtualMachine()
      Specifies if the device is running in a virtual machine.
      int hashCode()  
      void setAcceptHeader​(java.lang.String acceptHeader)
      The exact content of the HTTP Accept headers as sent to the 3DS Requestor from the cardholder’s browser.
      void setColorDepth​(java.lang.String colorDepth)
      The bit depth of the color palette for displaying images in bits per pixel, as reported by the browser's screen.colorDepth property.
      void setIframePaymentAllowed​(java.lang.Boolean iframePaymentAllowed)
      Indicates whether the Payments API is enabled for all parent frames.
      void setIncognito​(java.lang.Boolean incognito)
      Specifies if the browser is in incognito mode.
      void setJailbroken​(java.lang.Boolean jailbroken)
      Specifies if the device is jailbroken.
      void setJavaEnabled​(java.lang.Boolean javaEnabled)
      Specifies if the browser has the ability to execute Java, as reported by the browser's navigator.javaEnabled property.
      void setJavascriptEnabled​(java.lang.Boolean javascriptEnabled)
      Specifies if the browser has the ability to execute Javascript, as reported by the browser's navigator.javascriptEnabled property.
      void setLanguage​(java.lang.String language)
      The browser language, as reported by the browser's navigator.language property.
      void setNetwork​(Network network)
      Details of the device network.
      void setProvider​(Provider provider)
      Details of the device ID provider.
      void setRooted​(java.lang.Boolean rooted)
      Specifies if the device is rooted.
      void setScreenHeight​(java.lang.String screenHeight)
      The total height of the device screen in pixels, as reported by the browser's screen.height property.
      void setScreenWidth​(java.lang.String screenWidth)
      The total width of the device screen in pixels, as reported by the browser's screen.width property.
      void setTimestamp​(java.lang.String timestamp)
      The UTC date and time the payment was performed as reported by the device.
      void setTimezone​(java.lang.String timezone)
      The time difference between UTC time and the local time reported by the browser, in minutes.
      void setUserAgent​(java.lang.String userAgent)
      The contents of the HTTP User-Agent request header.
      void setUserAgentClientHint​(java.lang.String userAgentClientHint)
      The raw Sec-CH-UA header value.
      void setVirtualMachine​(java.lang.Boolean virtualMachine)
      Specifies if the device is running in a virtual machine.
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • Device

        public Device()
      • Device

        public Device​(java.lang.String userAgent,
                      Network network,
                      Provider provider,
                      java.lang.String timestamp,
                      java.lang.String timezone,
                      java.lang.Boolean virtualMachine,
                      java.lang.Boolean incognito,
                      java.lang.Boolean jailbroken,
                      java.lang.Boolean rooted,
                      java.lang.Boolean javaEnabled,
                      java.lang.Boolean javascriptEnabled,
                      java.lang.String language,
                      java.lang.String colorDepth,
                      java.lang.String screenHeight,
                      java.lang.String screenWidth,
                      java.lang.String userAgentClientHint,
                      java.lang.Boolean iframePaymentAllowed,
                      java.lang.String acceptHeader)
        Creates a new Device instance.
        Parameters:
        userAgent - The contents of the HTTP User-Agent request header. This field is required to process the device with the risk engine. [Optional] <= 2048
        network - Details of the device network. Either ipv4 or ipv6 is required field. [Optional]
        provider - Details of the device ID provider. [Optional]
        timestamp - The UTC date and time the payment was performed as reported by the device. Format – ISO 8601 code This field is required to process the device with the risk engine. [Optional]
        timezone - The time difference between UTC time and the local time reported by the browser, in minutes. This field is required to process the device with the risk engine. [Optional] [ 1 .. 5 ] characters
        virtualMachine - Specifies if the device is running in a virtual machine. [Optional]
        incognito - Specifies if the browser is in incognito mode. [Optional]
        jailbroken - Specifies if the device is jailbroken. [Optional]
        rooted - Specifies if the device is rooted. [Optional]
        javaEnabled - Specifies if the browser has the ability to execute Java, as reported by the browser's navigator.javaEnabled property. [Optional]
        javascriptEnabled - Specifies if the browser has the ability to execute Javascript, as reported by the browser's navigator.javascriptEnabled property. Only required for 3D Secure authentications processed with 3DS 2.2. If the payment is processed with an older 3DS version, this field is ignored. [Optional]
        language - The browser language, as reported by the browser's navigator.language property. Format – IETF BCP47 language tag [Optional] [ 1 .. 12 ] characters
        colorDepth - The bit depth of the color palette for displaying images in bits per pixel, as reported by the browser's screen.colorDepth property. [Optional] [ 1 .. 2 ] characters
        screenHeight - The total height of the device screen in pixels, as reported by the browser's screen.height property. [Optional] [ 1 .. 6 ] characters
        screenWidth - The total width of the device screen in pixels, as reported by the browser's screen.width property. [Optional] [ 1 .. 6 ] characters
        userAgentClientHint - The raw Sec-CH-UA header value. This field improves Google Single-Page Application (SPA) support, as it provides more accurate information about the customer's browser. [Optional]
        iframePaymentAllowed - Indicates whether the Payments API is enabled for all parent frames. [Optional]
        acceptHeader - The exact content of the HTTP Accept headers as sent to the 3DS Requestor from the cardholder’s browser. [Optional] <= 2048
    • Method Detail

      • getUserAgent

        public java.lang.String getUserAgent()
        The contents of the HTTP User-Agent request header. This field is required to process the device with the risk engine. [Optional] <= 2048
      • getNetwork

        public Network getNetwork()
        Details of the device network. Either ipv4 or ipv6 is required field. [Optional]
      • getProvider

        public Provider getProvider()
        Details of the device ID provider. [Optional]
      • getTimestamp

        public java.lang.String getTimestamp()
        The UTC date and time the payment was performed as reported by the device. Format – ISO 8601 code This field is required to process the device with the risk engine. [Optional]
      • getTimezone

        public java.lang.String getTimezone()
        The time difference between UTC time and the local time reported by the browser, in minutes. This field is required to process the device with the risk engine. [Optional] [ 1 .. 5 ] characters
      • getVirtualMachine

        public java.lang.Boolean getVirtualMachine()
        Specifies if the device is running in a virtual machine. [Optional]
      • getIncognito

        public java.lang.Boolean getIncognito()
        Specifies if the browser is in incognito mode. [Optional]
      • getJailbroken

        public java.lang.Boolean getJailbroken()
        Specifies if the device is jailbroken. [Optional]
      • getRooted

        public java.lang.Boolean getRooted()
        Specifies if the device is rooted. [Optional]
      • getJavaEnabled

        public java.lang.Boolean getJavaEnabled()
        Specifies if the browser has the ability to execute Java, as reported by the browser's navigator.javaEnabled property. [Optional]
      • getJavascriptEnabled

        public java.lang.Boolean getJavascriptEnabled()
        Specifies if the browser has the ability to execute Javascript, as reported by the browser's navigator.javascriptEnabled property. Only required for 3D Secure authentications processed with 3DS 2.2. If the payment is processed with an older 3DS version, this field is ignored. [Optional]
      • getLanguage

        public java.lang.String getLanguage()
        The browser language, as reported by the browser's navigator.language property. Format – IETF BCP47 language tag [Optional] [ 1 .. 12 ] characters
      • getColorDepth

        public java.lang.String getColorDepth()
        The bit depth of the color palette for displaying images in bits per pixel, as reported by the browser's screen.colorDepth property. [Optional] [ 1 .. 2 ] characters
      • getScreenHeight

        public java.lang.String getScreenHeight()
        The total height of the device screen in pixels, as reported by the browser's screen.height property. [Optional] [ 1 .. 6 ] characters
      • getScreenWidth

        public java.lang.String getScreenWidth()
        The total width of the device screen in pixels, as reported by the browser's screen.width property. [Optional] [ 1 .. 6 ] characters
      • getUserAgentClientHint

        public java.lang.String getUserAgentClientHint()
        The raw Sec-CH-UA header value. This field improves Google Single-Page Application (SPA) support, as it provides more accurate information about the customer's browser. [Optional]
      • getIframePaymentAllowed

        public java.lang.Boolean getIframePaymentAllowed()
        Indicates whether the Payments API is enabled for all parent frames. [Optional]
      • getAcceptHeader

        public java.lang.String getAcceptHeader()
        The exact content of the HTTP Accept headers as sent to the 3DS Requestor from the cardholder’s browser. [Optional] <= 2048
      • setUserAgent

        public void setUserAgent​(java.lang.String userAgent)
        The contents of the HTTP User-Agent request header. This field is required to process the device with the risk engine. [Optional] <= 2048
      • setNetwork

        public void setNetwork​(Network network)
        Details of the device network. Either ipv4 or ipv6 is required field. [Optional]
      • setProvider

        public void setProvider​(Provider provider)
        Details of the device ID provider. [Optional]
      • setTimestamp

        public void setTimestamp​(java.lang.String timestamp)
        The UTC date and time the payment was performed as reported by the device. Format – ISO 8601 code This field is required to process the device with the risk engine. [Optional]
      • setTimezone

        public void setTimezone​(java.lang.String timezone)
        The time difference between UTC time and the local time reported by the browser, in minutes. This field is required to process the device with the risk engine. [Optional] [ 1 .. 5 ] characters
      • setVirtualMachine

        public void setVirtualMachine​(java.lang.Boolean virtualMachine)
        Specifies if the device is running in a virtual machine. [Optional]
      • setIncognito

        public void setIncognito​(java.lang.Boolean incognito)
        Specifies if the browser is in incognito mode. [Optional]
      • setJailbroken

        public void setJailbroken​(java.lang.Boolean jailbroken)
        Specifies if the device is jailbroken. [Optional]
      • setRooted

        public void setRooted​(java.lang.Boolean rooted)
        Specifies if the device is rooted. [Optional]
      • setJavaEnabled

        public void setJavaEnabled​(java.lang.Boolean javaEnabled)
        Specifies if the browser has the ability to execute Java, as reported by the browser's navigator.javaEnabled property. [Optional]
      • setJavascriptEnabled

        public void setJavascriptEnabled​(java.lang.Boolean javascriptEnabled)
        Specifies if the browser has the ability to execute Javascript, as reported by the browser's navigator.javascriptEnabled property. Only required for 3D Secure authentications processed with 3DS 2.2. If the payment is processed with an older 3DS version, this field is ignored. [Optional]
      • setLanguage

        public void setLanguage​(java.lang.String language)
        The browser language, as reported by the browser's navigator.language property. Format – IETF BCP47 language tag [Optional] [ 1 .. 12 ] characters
      • setColorDepth

        public void setColorDepth​(java.lang.String colorDepth)
        The bit depth of the color palette for displaying images in bits per pixel, as reported by the browser's screen.colorDepth property. [Optional] [ 1 .. 2 ] characters
      • setScreenHeight

        public void setScreenHeight​(java.lang.String screenHeight)
        The total height of the device screen in pixels, as reported by the browser's screen.height property. [Optional] [ 1 .. 6 ] characters
      • setScreenWidth

        public void setScreenWidth​(java.lang.String screenWidth)
        The total width of the device screen in pixels, as reported by the browser's screen.width property. [Optional] [ 1 .. 6 ] characters
      • setUserAgentClientHint

        public void setUserAgentClientHint​(java.lang.String userAgentClientHint)
        The raw Sec-CH-UA header value. This field improves Google Single-Page Application (SPA) support, as it provides more accurate information about the customer's browser. [Optional]
      • setIframePaymentAllowed

        public void setIframePaymentAllowed​(java.lang.Boolean iframePaymentAllowed)
        Indicates whether the Payments API is enabled for all parent frames. [Optional]
      • setAcceptHeader

        public void setAcceptHeader​(java.lang.String acceptHeader)
        The exact content of the HTTP Accept headers as sent to the 3DS Requestor from the cardholder’s browser. [Optional] <= 2048
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object