java.lang.Object
- com.adyen.model.checkout.CheckoutForwardRequestOptions

public class CheckoutForwardRequestOptions
extends Object

CheckoutForwardRequestOptions

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_ACCOUNT_UPDATE`
`static String`	`JSON_PROPERTY_DRY_RUN`
`static String`	`JSON_PROPERTY_NETWORK_TOKEN`
`static String`	`JSON_PROPERTY_NETWORK_TX_REFERENCE_PATHS`
`static String`	`JSON_PROPERTY_TOKENIZE`
`static String`	`JSON_PROPERTY_TRANSACTION_LINK_ID_PATHS`

Constructor Summary

Constructors
Constructor Description

CheckoutForwardRequestOptions()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`CheckoutForwardRequestOptions`	`accountUpdate(Boolean accountUpdate)`	Whether to check for a card account update (true) or not (false)
`CheckoutForwardRequestOptions`	`addNetworkTxReferencePathsItem(String networkTxReferencePathsItem)`
`CheckoutForwardRequestOptions`	`addTransactionLinkIdPathsItem(String transactionLinkIdPathsItem)`
`CheckoutForwardRequestOptions`	`dryRun(Boolean dryRun)`	Set to true to receive a copy of the request Adyen is making to the third party in the response.
`boolean`	`equals(Object o)`	Return true if this CheckoutForwardRequestOptions object is equal to o.
`static CheckoutForwardRequestOptions`	`fromJson(String jsonString)`	Create an instance of CheckoutForwardRequestOptions given an JSON string
`Boolean`	`getAccountUpdate()`	Whether to check for a card account update (true) or not (false)
`Boolean`	`getDryRun()`	Set to true to receive a copy of the request Adyen is making to the third party in the response.
`Map<String,Object>`	`getExplicitNulls()`	Returns a map of properties to be merged into the JSON payload as explicit null values.
`CheckoutNetworkTokenOption`	`getNetworkToken()`	Get networkToken
`List<String>`	`getNetworkTxReferencePaths()`	Set in tokenize:true case when forwarding PAN.
`Boolean`	`getTokenize()`	Set to true, the payment details are [tokenized](https://docs.adyen.com/online-payments/tokenization).
`List<String>`	`getTransactionLinkIdPaths()`	Set in tokenize:true case when forwarding PAN.
`int`	`hashCode()`
`CheckoutForwardRequestOptions`	`includeNullValues(boolean includeNullValues)`	Configures whether null values are explicitly serialized in the JSON payload.
`boolean`	`isIncludeNullValues()`	Returns whether null values are explicitly serialized in the JSON payload.
`CheckoutForwardRequestOptions`	`networkToken(CheckoutNetworkTokenOption networkToken)`	networkToken
`CheckoutForwardRequestOptions`	`networkTxReferencePaths(List<String> networkTxReferencePaths)`	Set in tokenize:true case when forwarding PAN.
`void`	`setAccountUpdate(Boolean accountUpdate)`	Whether to check for a card account update (true) or not (false)
`void`	`setDryRun(Boolean dryRun)`	Set to true to receive a copy of the request Adyen is making to the third party in the response.
`void`	`setIncludeNullValues(boolean includeNullValues)`	Sets whether null values should be explicitly serialized in the JSON payload.
`void`	`setNetworkToken(CheckoutNetworkTokenOption networkToken)`	networkToken
`void`	`setNetworkTxReferencePaths(List<String> networkTxReferencePaths)`	Set in tokenize:true case when forwarding PAN.
`void`	`setTokenize(Boolean tokenize)`	Set to true, the payment details are [tokenized](https://docs.adyen.com/online-payments/tokenization).
`void`	`setTransactionLinkIdPaths(List<String> transactionLinkIdPaths)`	Set in tokenize:true case when forwarding PAN.
`String`	`toJson()`	Convert an instance of CheckoutForwardRequestOptions to an JSON string
`CheckoutForwardRequestOptions`	`tokenize(Boolean tokenize)`	Set to true, the payment details are [tokenized](https://docs.adyen.com/online-payments/tokenization).
`String`	`toString()`
`CheckoutForwardRequestOptions`	`transactionLinkIdPaths(List<String> transactionLinkIdPaths)`	Set in tokenize:true case when forwarding PAN.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - JSON_PROPERTY_ACCOUNT_UPDATE
```
public static final String JSON_PROPERTY_ACCOUNT_UPDATE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DRY_RUN
```
public static final String JSON_PROPERTY_DRY_RUN
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_NETWORK_TOKEN
```
public static final String JSON_PROPERTY_NETWORK_TOKEN
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_NETWORK_TX_REFERENCE_PATHS
```
public static final String JSON_PROPERTY_NETWORK_TX_REFERENCE_PATHS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TOKENIZE
```
public static final String JSON_PROPERTY_TOKENIZE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TRANSACTION_LINK_ID_PATHS
```
public static final String JSON_PROPERTY_TRANSACTION_LINK_ID_PATHS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CheckoutForwardRequestOptions
```
public CheckoutForwardRequestOptions()
```
- Method Detail
  - accountUpdate
```
public CheckoutForwardRequestOptions accountUpdate(Boolean accountUpdate)
```
    Whether to check for a card account update (true) or not (false)
    
    Parameters:
    
    accountUpdate - Whether to check for a card account update (true) or not (false)
    
    Returns:
    
    the current CheckoutForwardRequestOptions instance, allowing for method chaining
  - getAccountUpdate
```
public Boolean getAccountUpdate()
```
    Whether to check for a card account update (true) or not (false)
    
    Returns:
    
    accountUpdate Whether to check for a card account update (true) or not (false)
  - setAccountUpdate
```
public void setAccountUpdate(Boolean accountUpdate)
```
    Whether to check for a card account update (true) or not (false)
    
    Parameters:
    
    accountUpdate - Whether to check for a card account update (true) or not (false)
  - dryRun
```
public CheckoutForwardRequestOptions dryRun(Boolean dryRun)
```
    Set to **true** to receive a copy of the request Adyen is making to the third party in the response. Any sensitive information will be masked in the response you receive. This functionality is only available in the test environment.
    
    Parameters:
    
    dryRun - Set to **true** to receive a copy of the request Adyen is making to the third party in the response. Any sensitive information will be masked in the response you receive. This functionality is only available in the test environment.
    
    Returns:
    
    the current CheckoutForwardRequestOptions instance, allowing for method chaining
  - getDryRun
```
public Boolean getDryRun()
```
    Set to **true** to receive a copy of the request Adyen is making to the third party in the response. Any sensitive information will be masked in the response you receive. This functionality is only available in the test environment.
    
    Returns:
    
    dryRun Set to **true** to receive a copy of the request Adyen is making to the third party in the response. Any sensitive information will be masked in the response you receive. This functionality is only available in the test environment.
  - setDryRun
```
public void setDryRun(Boolean dryRun)
```
    Set to **true** to receive a copy of the request Adyen is making to the third party in the response. Any sensitive information will be masked in the response you receive. This functionality is only available in the test environment.
    
    Parameters:
    
    dryRun - Set to **true** to receive a copy of the request Adyen is making to the third party in the response. Any sensitive information will be masked in the response you receive. This functionality is only available in the test environment.
  - networkToken
```
public CheckoutForwardRequestOptions networkToken(CheckoutNetworkTokenOption networkToken)
```
    networkToken
    
    Parameters:
    
    networkToken -
    
    Returns:
    
    the current CheckoutForwardRequestOptions instance, allowing for method chaining
  - getNetworkToken
```
public CheckoutNetworkTokenOption getNetworkToken()
```
    Get networkToken
    
    Returns:
    
    networkToken
  - setNetworkToken
```
public void setNetworkToken(CheckoutNetworkTokenOption networkToken)
```
    networkToken
    
    Parameters:
    
    networkToken -
  - networkTxReferencePaths
```
public CheckoutForwardRequestOptions networkTxReferencePaths(List<String> networkTxReferencePaths)
```
    Set in tokenize:true case when forwarding PAN. Addresses to the possible location(s) of networkTxReference in the incoming 3rd party response
    
    Parameters:
    
    networkTxReferencePaths - Set in tokenize:true case when forwarding PAN. Addresses to the possible location(s) of networkTxReference in the incoming 3rd party response
    
    Returns:
    
    the current CheckoutForwardRequestOptions instance, allowing for method chaining
  - addNetworkTxReferencePathsItem
```
public CheckoutForwardRequestOptions addNetworkTxReferencePathsItem(String networkTxReferencePathsItem)
```
  - getNetworkTxReferencePaths
```
public List<String> getNetworkTxReferencePaths()
```
    Set in tokenize:true case when forwarding PAN. Addresses to the possible location(s) of networkTxReference in the incoming 3rd party response
    
    Returns:
    
    networkTxReferencePaths Set in tokenize:true case when forwarding PAN. Addresses to the possible location(s) of networkTxReference in the incoming 3rd party response
  - setNetworkTxReferencePaths
```
public void setNetworkTxReferencePaths(List<String> networkTxReferencePaths)
```
    Set in tokenize:true case when forwarding PAN. Addresses to the possible location(s) of networkTxReference in the incoming 3rd party response
    
    Parameters:
    
    networkTxReferencePaths - Set in tokenize:true case when forwarding PAN. Addresses to the possible location(s) of networkTxReference in the incoming 3rd party response
  - tokenize
```
public CheckoutForwardRequestOptions tokenize(Boolean tokenize)
```
    Set to **true**, the payment details are [tokenized](https://docs.adyen.com/online-payments/tokenization).
    
    Parameters:
    
    tokenize - Set to **true**, the payment details are [tokenized](https://docs.adyen.com/online-payments/tokenization).
    
    Returns:
    
    the current CheckoutForwardRequestOptions instance, allowing for method chaining
  - getTokenize
```
public Boolean getTokenize()
```
    Set to **true**, the payment details are [tokenized](https://docs.adyen.com/online-payments/tokenization).
    
    Returns:
    
    tokenize Set to **true**, the payment details are [tokenized](https://docs.adyen.com/online-payments/tokenization).
  - setTokenize
```
public void setTokenize(Boolean tokenize)
```
    Set to **true**, the payment details are [tokenized](https://docs.adyen.com/online-payments/tokenization).
    
    Parameters:
    
    tokenize - Set to **true**, the payment details are [tokenized](https://docs.adyen.com/online-payments/tokenization).
  - transactionLinkIdPaths
```
public CheckoutForwardRequestOptions transactionLinkIdPaths(List<String> transactionLinkIdPaths)
```
    Set in tokenize:true case when forwarding PAN. Addresses to the possible location(s) of transactionLinkId in the incoming 3rd party response
    
    Parameters:
    
    transactionLinkIdPaths - Set in tokenize:true case when forwarding PAN. Addresses to the possible location(s) of transactionLinkId in the incoming 3rd party response
    
    Returns:
    
    the current CheckoutForwardRequestOptions instance, allowing for method chaining
  - addTransactionLinkIdPathsItem
```
public CheckoutForwardRequestOptions addTransactionLinkIdPathsItem(String transactionLinkIdPathsItem)
```
  - getTransactionLinkIdPaths
```
public List<String> getTransactionLinkIdPaths()
```
    Set in tokenize:true case when forwarding PAN. Addresses to the possible location(s) of transactionLinkId in the incoming 3rd party response
    
    Returns:
    
    transactionLinkIdPaths Set in tokenize:true case when forwarding PAN. Addresses to the possible location(s) of transactionLinkId in the incoming 3rd party response
  - setTransactionLinkIdPaths
```
public void setTransactionLinkIdPaths(List<String> transactionLinkIdPaths)
```
    Set in tokenize:true case when forwarding PAN. Addresses to the possible location(s) of transactionLinkId in the incoming 3rd party response
    
    Parameters:
    
    transactionLinkIdPaths - Set in tokenize:true case when forwarding PAN. Addresses to the possible location(s) of transactionLinkId in the incoming 3rd party response
  - includeNullValues
```
public CheckoutForwardRequestOptions includeNullValues(boolean includeNullValues)
```
    Configures whether null values are explicitly serialized in the JSON payload. Default is false.
  - isIncludeNullValues
```
public boolean isIncludeNullValues()
```
    Returns whether null values are explicitly serialized in the JSON payload.
  - setIncludeNullValues
```
public void setIncludeNullValues(boolean includeNullValues)
```
    Sets whether null values should be explicitly serialized in the JSON payload. Default is false.
  - equals
```
public boolean equals(Object o)
```
    Return true if this CheckoutForwardRequestOptions object is equal to o.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getExplicitNulls
```
public Map<String,Object> getExplicitNulls()
```
    Returns a map of properties to be merged into the JSON payload as explicit null values.
  - fromJson
```
public static CheckoutForwardRequestOptions fromJson(String jsonString)
                                              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of CheckoutForwardRequestOptions given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of CheckoutForwardRequestOptions
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to CheckoutForwardRequestOptions
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of CheckoutForwardRequestOptions to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class CheckoutForwardRequestOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_ACCOUNT_UPDATE

JSON_PROPERTY_DRY_RUN

JSON_PROPERTY_NETWORK_TOKEN

JSON_PROPERTY_NETWORK_TX_REFERENCE_PATHS

JSON_PROPERTY_TOKENIZE

JSON_PROPERTY_TRANSACTION_LINK_ID_PATHS

Constructor Detail

CheckoutForwardRequestOptions

Method Detail

accountUpdate

getAccountUpdate

setAccountUpdate

dryRun

getDryRun

setDryRun

networkToken

getNetworkToken

setNetworkToken

networkTxReferencePaths

addNetworkTxReferencePathsItem

getNetworkTxReferencePaths

setNetworkTxReferencePaths

tokenize

getTokenize

setTokenize

transactionLinkIdPaths

addTransactionLinkIdPathsItem

getTransactionLinkIdPaths

setTransactionLinkIdPaths

includeNullValues

isIncludeNullValues

setIncludeNullValues

equals

hashCode

toString

getExplicitNulls

fromJson

toJson