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

public class CheckoutForwardRequest
extends Object

CheckoutForwardRequest

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_AMOUNT`
`static String`	`JSON_PROPERTY_BASE_URL`
`static String`	`JSON_PROPERTY_MERCHANT_ACCOUNT`
`static String`	`JSON_PROPERTY_MERCHANT_REFERENCE`
`static String`	`JSON_PROPERTY_OPTIONS`
`static String`	`JSON_PROPERTY_PAYMENT_METHOD`
`static String`	`JSON_PROPERTY_REQUEST`
`static String`	`JSON_PROPERTY_SHOPPER_REFERENCE`
`static String`	`JSON_PROPERTY_STORED_PAYMENT_METHOD_ID`

Constructor Summary

Constructors
Constructor Description

CheckoutForwardRequest()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`CheckoutForwardRequest`	`amount(Amount amount)`	amount
`CheckoutForwardRequest`	`baseUrl(String baseUrl)`	The base URL of the third party API, where Adyen will send the request to forward the payment details.
`boolean`	`equals(Object o)`	Return true if this CheckoutForwardRequest object is equal to o.
`static CheckoutForwardRequest`	`fromJson(String jsonString)`	Create an instance of CheckoutForwardRequest given an JSON string
`Amount`	`getAmount()`	Get amount
`String`	`getBaseUrl()`	The base URL of the third party API, where Adyen will send the request to forward the payment details.
`Map<String,Object>`	`getExplicitNulls()`	Returns a map of properties to be merged into the JSON payload as explicit null values.
`String`	`getMerchantAccount()`	Your merchant account.
`String`	`getMerchantReference()`	Merchant defined payment reference.
`CheckoutForwardRequestOptions`	`getOptions()`	Get options
`CheckoutForwardRequestCard`	`getPaymentMethod()`	Get paymentMethod
`CheckoutOutgoingForwardRequest`	`getRequest()`	Get request
`String`	`getShopperReference()`	Your reference to uniquely identify this shopper, for example user ID or account ID.
`String`	`getStoredPaymentMethodId()`	The unique identifier of the token that you want to forward to the third party.
`int`	`hashCode()`
`CheckoutForwardRequest`	`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.
`CheckoutForwardRequest`	`merchantAccount(String merchantAccount)`	Your merchant account.
`CheckoutForwardRequest`	`merchantReference(String merchantReference)`	Merchant defined payment reference.
`CheckoutForwardRequest`	`options(CheckoutForwardRequestOptions options)`	options
`CheckoutForwardRequest`	`paymentMethod(CheckoutForwardRequestCard paymentMethod)`	paymentMethod
`CheckoutForwardRequest`	`request(CheckoutOutgoingForwardRequest request)`	request
`void`	`setAmount(Amount amount)`	amount
`void`	`setBaseUrl(String baseUrl)`	The base URL of the third party API, where Adyen will send the request to forward the payment details.
`void`	`setIncludeNullValues(boolean includeNullValues)`	Sets whether null values should be explicitly serialized in the JSON payload.
`void`	`setMerchantAccount(String merchantAccount)`	Your merchant account.
`void`	`setMerchantReference(String merchantReference)`	Merchant defined payment reference.
`void`	`setOptions(CheckoutForwardRequestOptions options)`	options
`void`	`setPaymentMethod(CheckoutForwardRequestCard paymentMethod)`	paymentMethod
`void`	`setRequest(CheckoutOutgoingForwardRequest request)`	request
`void`	`setShopperReference(String shopperReference)`	Your reference to uniquely identify this shopper, for example user ID or account ID.
`void`	`setStoredPaymentMethodId(String storedPaymentMethodId)`	The unique identifier of the token that you want to forward to the third party.
`CheckoutForwardRequest`	`shopperReference(String shopperReference)`	Your reference to uniquely identify this shopper, for example user ID or account ID.
`CheckoutForwardRequest`	`storedPaymentMethodId(String storedPaymentMethodId)`	The unique identifier of the token that you want to forward to the third party.
`String`	`toJson()`	Convert an instance of CheckoutForwardRequest to an JSON string
`String`	`toString()`

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

- Field Detail
  - JSON_PROPERTY_AMOUNT
```
public static final String JSON_PROPERTY_AMOUNT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_BASE_URL
```
public static final String JSON_PROPERTY_BASE_URL
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MERCHANT_ACCOUNT
```
public static final String JSON_PROPERTY_MERCHANT_ACCOUNT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MERCHANT_REFERENCE
```
public static final String JSON_PROPERTY_MERCHANT_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_OPTIONS
```
public static final String JSON_PROPERTY_OPTIONS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_PAYMENT_METHOD
```
public static final String JSON_PROPERTY_PAYMENT_METHOD
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_REQUEST
```
public static final String JSON_PROPERTY_REQUEST
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOPPER_REFERENCE
```
public static final String JSON_PROPERTY_SHOPPER_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_STORED_PAYMENT_METHOD_ID
```
public static final String JSON_PROPERTY_STORED_PAYMENT_METHOD_ID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CheckoutForwardRequest
```
public CheckoutForwardRequest()
```
- Method Detail
  - amount
```
public CheckoutForwardRequest amount(Amount amount)
```
    amount
    
    Parameters:
    
    amount -
    
    Returns:
    
    the current CheckoutForwardRequest instance, allowing for method chaining
  - getAmount
```
public Amount getAmount()
```
    Get amount
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(Amount amount)
```
    amount
    
    Parameters:
    
    amount -
  - baseUrl
```
public CheckoutForwardRequest baseUrl(String baseUrl)
```
    The base URL of the third party API, where Adyen will send the request to forward the payment details.
    
    Parameters:
    
    baseUrl - The base URL of the third party API, where Adyen will send the request to forward the payment details.
    
    Returns:
    
    the current CheckoutForwardRequest instance, allowing for method chaining
  - getBaseUrl
```
public String getBaseUrl()
```
    The base URL of the third party API, where Adyen will send the request to forward the payment details.
    
    Returns:
    
    baseUrl The base URL of the third party API, where Adyen will send the request to forward the payment details.
  - setBaseUrl
```
public void setBaseUrl(String baseUrl)
```
    The base URL of the third party API, where Adyen will send the request to forward the payment details.
    
    Parameters:
    
    baseUrl - The base URL of the third party API, where Adyen will send the request to forward the payment details.
  - merchantAccount
```
public CheckoutForwardRequest merchantAccount(String merchantAccount)
```
    Your merchant account.
    
    Parameters:
    
    merchantAccount - Your merchant account.
    
    Returns:
    
    the current CheckoutForwardRequest instance, allowing for method chaining
  - getMerchantAccount
```
public String getMerchantAccount()
```
    Your merchant account.
    
    Returns:
    
    merchantAccount Your merchant account.
  - setMerchantAccount
```
public void setMerchantAccount(String merchantAccount)
```
    Your merchant account.
    
    Parameters:
    
    merchantAccount - Your merchant account.
  - merchantReference
```
public CheckoutForwardRequest merchantReference(String merchantReference)
```
    Merchant defined payment reference.
    
    Parameters:
    
    merchantReference - Merchant defined payment reference.
    
    Returns:
    
    the current CheckoutForwardRequest instance, allowing for method chaining
  - getMerchantReference
```
public String getMerchantReference()
```
    Merchant defined payment reference.
    
    Returns:
    
    merchantReference Merchant defined payment reference.
  - setMerchantReference
```
public void setMerchantReference(String merchantReference)
```
    Merchant defined payment reference.
    
    Parameters:
    
    merchantReference - Merchant defined payment reference.
  - options
```
public CheckoutForwardRequest options(CheckoutForwardRequestOptions options)
```
    options
    
    Parameters:
    
    options -
    
    Returns:
    
    the current CheckoutForwardRequest instance, allowing for method chaining
  - getOptions
```
public CheckoutForwardRequestOptions getOptions()
```
    Get options
    
    Returns:
    
    options
  - setOptions
```
public void setOptions(CheckoutForwardRequestOptions options)
```
    options
    
    Parameters:
    
    options -
  - paymentMethod
```
public CheckoutForwardRequest paymentMethod(CheckoutForwardRequestCard paymentMethod)
```
    paymentMethod
    
    Parameters:
    
    paymentMethod -
    
    Returns:
    
    the current CheckoutForwardRequest instance, allowing for method chaining
  - getPaymentMethod
```
public CheckoutForwardRequestCard getPaymentMethod()
```
    Get paymentMethod
    
    Returns:
    
    paymentMethod
  - setPaymentMethod
```
public void setPaymentMethod(CheckoutForwardRequestCard paymentMethod)
```
    paymentMethod
    
    Parameters:
    
    paymentMethod -
  - request
```
public CheckoutForwardRequest request(CheckoutOutgoingForwardRequest request)
```
    request
    
    Parameters:
    
    request -
    
    Returns:
    
    the current CheckoutForwardRequest instance, allowing for method chaining
  - getRequest
```
public CheckoutOutgoingForwardRequest getRequest()
```
    Get request
    
    Returns:
    
    request
  - setRequest
```
public void setRequest(CheckoutOutgoingForwardRequest request)
```
    request
    
    Parameters:
    
    request -
  - shopperReference
```
public CheckoutForwardRequest shopperReference(String shopperReference)
```
    Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.
    
    Parameters:
    
    shopperReference - Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.
    
    Returns:
    
    the current CheckoutForwardRequest instance, allowing for method chaining
  - getShopperReference
```
public String getShopperReference()
```
    Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.
    
    Returns:
    
    shopperReference Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.
  - setShopperReference
```
public void setShopperReference(String shopperReference)
```
    Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.
    
    Parameters:
    
    shopperReference - Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.
  - storedPaymentMethodId
```
public CheckoutForwardRequest storedPaymentMethodId(String storedPaymentMethodId)
```
    The unique identifier of the token that you want to forward to the third party. This is the `storedPaymentMethodId` you received in the webhook after you created the token.
    
    Parameters:
    
    storedPaymentMethodId - The unique identifier of the token that you want to forward to the third party. This is the `storedPaymentMethodId` you received in the webhook after you created the token.
    
    Returns:
    
    the current CheckoutForwardRequest instance, allowing for method chaining
  - getStoredPaymentMethodId
```
public String getStoredPaymentMethodId()
```
    The unique identifier of the token that you want to forward to the third party. This is the `storedPaymentMethodId` you received in the webhook after you created the token.
    
    Returns:
    
    storedPaymentMethodId The unique identifier of the token that you want to forward to the third party. This is the `storedPaymentMethodId` you received in the webhook after you created the token.
  - setStoredPaymentMethodId
```
public void setStoredPaymentMethodId(String storedPaymentMethodId)
```
    The unique identifier of the token that you want to forward to the third party. This is the `storedPaymentMethodId` you received in the webhook after you created the token.
    
    Parameters:
    
    storedPaymentMethodId - The unique identifier of the token that you want to forward to the third party. This is the `storedPaymentMethodId` you received in the webhook after you created the token.
  - includeNullValues
```
public CheckoutForwardRequest 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 CheckoutForwardRequest 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 CheckoutForwardRequest fromJson(String jsonString)
                                       throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of CheckoutForwardRequest given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of CheckoutForwardRequest
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to CheckoutForwardRequest
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of CheckoutForwardRequest to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class CheckoutForwardRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_AMOUNT

JSON_PROPERTY_BASE_URL

JSON_PROPERTY_MERCHANT_ACCOUNT

JSON_PROPERTY_MERCHANT_REFERENCE

JSON_PROPERTY_OPTIONS

JSON_PROPERTY_PAYMENT_METHOD

JSON_PROPERTY_REQUEST

JSON_PROPERTY_SHOPPER_REFERENCE

JSON_PROPERTY_STORED_PAYMENT_METHOD_ID

Constructor Detail

CheckoutForwardRequest

Method Detail

amount

getAmount

setAmount

baseUrl

getBaseUrl

setBaseUrl

merchantAccount

getMerchantAccount

setMerchantAccount

merchantReference

getMerchantReference

setMerchantReference

options

getOptions

setOptions

paymentMethod

getPaymentMethod

setPaymentMethod

request

getRequest

setRequest

shopperReference

getShopperReference

setShopperReference

storedPaymentMethodId

getStoredPaymentMethodId

setStoredPaymentMethodId

includeNullValues

isIncludeNullValues

setIncludeNullValues

equals

hashCode

toString

getExplicitNulls

fromJson

toJson