Package com.checkout.payments.request
Class Device
- java.lang.Object
-
- com.checkout.payments.request.Device
-
public final class Device extends java.lang.Objectdevice Details of the device from which the payment originated.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDevice.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 newDeviceinstance.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Device.DeviceBuilderbuilder()booleanequals(java.lang.Object o)java.lang.StringgetAcceptHeader()The exact content of the HTTP Accept headers as sent to the 3DS Requestor from the cardholder’s browser.java.lang.StringgetColorDepth()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.BooleangetIframePaymentAllowed()Indicates whether the Payments API is enabled for all parent frames.java.lang.BooleangetIncognito()Specifies if the browser is in incognito mode.java.lang.BooleangetJailbroken()Specifies if the device is jailbroken.java.lang.BooleangetJavaEnabled()Specifies if the browser has the ability to execute Java, as reported by the browser's navigator.javaEnabled property.java.lang.BooleangetJavascriptEnabled()Specifies if the browser has the ability to execute Javascript, as reported by the browser's navigator.javascriptEnabled property.java.lang.StringgetLanguage()The browser language, as reported by the browser's navigator.language property.NetworkgetNetwork()Details of the device network.ProvidergetProvider()Details of the device ID provider.java.lang.BooleangetRooted()Specifies if the device is rooted.java.lang.StringgetScreenHeight()The total height of the device screen in pixels, as reported by the browser's screen.height property.java.lang.StringgetScreenWidth()The total width of the device screen in pixels, as reported by the browser's screen.width property.java.lang.StringgetTimestamp()The UTC date and time the payment was performed as reported by the device.java.lang.StringgetTimezone()The time difference between UTC time and the local time reported by the browser, in minutes.java.lang.StringgetUserAgent()The contents of the HTTP User-Agent request header.java.lang.StringgetUserAgentClientHint()The raw Sec-CH-UA header value.java.lang.BooleangetVirtualMachine()Specifies if the device is running in a virtual machine.inthashCode()voidsetAcceptHeader(java.lang.String acceptHeader)The exact content of the HTTP Accept headers as sent to the 3DS Requestor from the cardholder’s browser.voidsetColorDepth(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.voidsetIframePaymentAllowed(java.lang.Boolean iframePaymentAllowed)Indicates whether the Payments API is enabled for all parent frames.voidsetIncognito(java.lang.Boolean incognito)Specifies if the browser is in incognito mode.voidsetJailbroken(java.lang.Boolean jailbroken)Specifies if the device is jailbroken.voidsetJavaEnabled(java.lang.Boolean javaEnabled)Specifies if the browser has the ability to execute Java, as reported by the browser's navigator.javaEnabled property.voidsetJavascriptEnabled(java.lang.Boolean javascriptEnabled)Specifies if the browser has the ability to execute Javascript, as reported by the browser's navigator.javascriptEnabled property.voidsetLanguage(java.lang.String language)The browser language, as reported by the browser's navigator.language property.voidsetNetwork(Network network)Details of the device network.voidsetProvider(Provider provider)Details of the device ID provider.voidsetRooted(java.lang.Boolean rooted)Specifies if the device is rooted.voidsetScreenHeight(java.lang.String screenHeight)The total height of the device screen in pixels, as reported by the browser's screen.height property.voidsetScreenWidth(java.lang.String screenWidth)The total width of the device screen in pixels, as reported by the browser's screen.width property.voidsetTimestamp(java.lang.String timestamp)The UTC date and time the payment was performed as reported by the device.voidsetTimezone(java.lang.String timezone)The time difference between UTC time and the local time reported by the browser, in minutes.voidsetUserAgent(java.lang.String userAgent)The contents of the HTTP User-Agent request header.voidsetUserAgentClientHint(java.lang.String userAgentClientHint)The raw Sec-CH-UA header value.voidsetVirtualMachine(java.lang.Boolean virtualMachine)Specifies if the device is running in a virtual machine.java.lang.StringtoString()
-
-
-
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 newDeviceinstance.- Parameters:
userAgent- The contents of the HTTP User-Agent request header. This field is required to process the device with the risk engine. [Optional] <= 2048network- 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 ] charactersvirtualMachine- 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 ] characterscolorDepth- 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 ] charactersscreenHeight- The total height of the device screen in pixels, as reported by the browser's screen.height property. [Optional] [ 1 .. 6 ] charactersscreenWidth- The total width of the device screen in pixels, as reported by the browser's screen.width property. [Optional] [ 1 .. 6 ] charactersuserAgentClientHint- 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
-
builder
public static Device.DeviceBuilder builder()
-
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:
equalsin classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
-