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

public class ApplePayDetails
extends Object

ApplePayDetails

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`ApplePayDetails.FundingSourceEnum`	The funding source that should be used when multiple sources are available.
`static class`	`ApplePayDetails.TypeEnum`	applepay**

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_APPLE_PAY_TOKEN`
`static String`	`JSON_PROPERTY_CHECKOUT_ATTEMPT_ID`
`static String`	`JSON_PROPERTY_FUNDING_SOURCE`
`static String`	`JSON_PROPERTY_RECURRING_DETAIL_REFERENCE`
`static String`	`JSON_PROPERTY_SDK_DATA`
`static String`	`JSON_PROPERTY_STORED_PAYMENT_METHOD_ID`
`static String`	`JSON_PROPERTY_TYPE`

Constructor Summary

Constructors
Constructor Description

ApplePayDetails()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`ApplePayDetails`	`applePayToken(String applePayToken)`	The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.
`ApplePayDetails`	`checkoutAttemptId(String checkoutAttemptId)`	The checkout attempt identifier.
`boolean`	`equals(Object o)`	Return true if this ApplePayDetails object is equal to o.
`static ApplePayDetails`	`fromJson(String jsonString)`	Create an instance of ApplePayDetails given an JSON string
`ApplePayDetails`	`fundingSource(ApplePayDetails.FundingSourceEnum fundingSource)`	The funding source that should be used when multiple sources are available.
`String`	`getApplePayToken()`	The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.
`String`	`getCheckoutAttemptId()`	The checkout attempt identifier.
`Map<String,Object>`	`getExplicitNulls()`	Returns a map of properties to be merged into the JSON payload as explicit null values.
`ApplePayDetails.FundingSourceEnum`	`getFundingSource()`	The funding source that should be used when multiple sources are available.
`String`	`getRecurringDetailReference()`	Deprecated. // deprecated since Adyen Checkout API v49: Use `storedPaymentMethodId` instead.
`String`	`getSdkData()`	Base64-encoded JSON object containing SDK related parameters required by the SDK
`String`	`getStoredPaymentMethodId()`	This is the `recurringDetailReference` returned in the response when you created the token.
`ApplePayDetails.TypeEnum`	`getType()`	applepay
`int`	`hashCode()`
`ApplePayDetails`	`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.
`ApplePayDetails`	`recurringDetailReference(String recurringDetailReference)`	Deprecated. since Adyen Checkout API v49 Use `storedPaymentMethodId` instead.
`ApplePayDetails`	`sdkData(String sdkData)`	Base64-encoded JSON object containing SDK related parameters required by the SDK
`void`	`setApplePayToken(String applePayToken)`	The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.
`void`	`setCheckoutAttemptId(String checkoutAttemptId)`	The checkout attempt identifier.
`void`	`setFundingSource(ApplePayDetails.FundingSourceEnum fundingSource)`	The funding source that should be used when multiple sources are available.
`void`	`setIncludeNullValues(boolean includeNullValues)`	Sets whether null values should be explicitly serialized in the JSON payload.
`void`	`setRecurringDetailReference(String recurringDetailReference)`	Deprecated. since Adyen Checkout API v49 Use `storedPaymentMethodId` instead.
`void`	`setSdkData(String sdkData)`	Base64-encoded JSON object containing SDK related parameters required by the SDK
`void`	`setStoredPaymentMethodId(String storedPaymentMethodId)`	This is the `recurringDetailReference` returned in the response when you created the token.
`void`	`setType(ApplePayDetails.TypeEnum type)`	applepay
`ApplePayDetails`	`storedPaymentMethodId(String storedPaymentMethodId)`	This is the `recurringDetailReference` returned in the response when you created the token.
`String`	`toJson()`	Convert an instance of ApplePayDetails to an JSON string
`String`	`toString()`
`ApplePayDetails`	`type(ApplePayDetails.TypeEnum type)`	applepay

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

- Field Detail
  - JSON_PROPERTY_APPLE_PAY_TOKEN
```
public static final String JSON_PROPERTY_APPLE_PAY_TOKEN
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CHECKOUT_ATTEMPT_ID
```
public static final String JSON_PROPERTY_CHECKOUT_ATTEMPT_ID
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_FUNDING_SOURCE
```
public static final String JSON_PROPERTY_FUNDING_SOURCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_RECURRING_DETAIL_REFERENCE
```
public static final String JSON_PROPERTY_RECURRING_DETAIL_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SDK_DATA
```
public static final String JSON_PROPERTY_SDK_DATA
```
    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
  - JSON_PROPERTY_TYPE
```
public static final String JSON_PROPERTY_TYPE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ApplePayDetails
```
public ApplePayDetails()
```
- Method Detail
  - applePayToken
```
public ApplePayDetails applePayToken(String applePayToken)
```
    The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.
    
    Parameters:
    
    applePayToken - The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.
    
    Returns:
    
    the current ApplePayDetails instance, allowing for method chaining
  - getApplePayToken
```
public String getApplePayToken()
```
    The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.
    
    Returns:
    
    applePayToken The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.
  - setApplePayToken
```
public void setApplePayToken(String applePayToken)
```
    The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.
    
    Parameters:
    
    applePayToken - The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.
  - checkoutAttemptId
```
public ApplePayDetails checkoutAttemptId(String checkoutAttemptId)
```
    The checkout attempt identifier.
    
    Parameters:
    
    checkoutAttemptId - The checkout attempt identifier.
    
    Returns:
    
    the current ApplePayDetails instance, allowing for method chaining
  - getCheckoutAttemptId
```
public String getCheckoutAttemptId()
```
    The checkout attempt identifier.
    
    Returns:
    
    checkoutAttemptId The checkout attempt identifier.
  - setCheckoutAttemptId
```
public void setCheckoutAttemptId(String checkoutAttemptId)
```
    The checkout attempt identifier.
    
    Parameters:
    
    checkoutAttemptId - The checkout attempt identifier.
  - fundingSource
```
public ApplePayDetails fundingSource(ApplePayDetails.FundingSourceEnum fundingSource)
```
    The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.
    
    Parameters:
    
    fundingSource - The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.
    
    Returns:
    
    the current ApplePayDetails instance, allowing for method chaining
  - getFundingSource
```
public ApplePayDetails.FundingSourceEnum getFundingSource()
```
    The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.
    
    Returns:
    
    fundingSource The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.
  - setFundingSource
```
public void setFundingSource(ApplePayDetails.FundingSourceEnum fundingSource)
```
    The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.
    
    Parameters:
    
    fundingSource - The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.
  - recurringDetailReference
```
@Deprecated
public ApplePayDetails recurringDetailReference(String recurringDetailReference)
```
    Deprecated.
    since Adyen Checkout API v49 Use `storedPaymentMethodId` instead.
    
    This is the `recurringDetailReference` returned in the response when you created the token.
    
    Parameters:
    
    recurringDetailReference - This is the `recurringDetailReference` returned in the response when you created the token.
    
    Returns:
    
    the current ApplePayDetails instance, allowing for method chaining
  - getRecurringDetailReference
```
@Deprecated
public String getRecurringDetailReference()
```
    Deprecated.
    // deprecated since Adyen Checkout API v49: Use `storedPaymentMethodId` instead.
    
    This is the `recurringDetailReference` returned in the response when you created the token.
    
    Returns:
    
    recurringDetailReference This is the `recurringDetailReference` returned in the response when you created the token.
  - setRecurringDetailReference
```
@Deprecated
public void setRecurringDetailReference(String recurringDetailReference)
```
    Deprecated.
    since Adyen Checkout API v49 Use `storedPaymentMethodId` instead.
    
    This is the `recurringDetailReference` returned in the response when you created the token.
    
    Parameters:
    
    recurringDetailReference - This is the `recurringDetailReference` returned in the response when you created the token.
  - sdkData
```
public ApplePayDetails sdkData(String sdkData)
```
    Base64-encoded JSON object containing SDK related parameters required by the SDK
    
    Parameters:
    
    sdkData - Base64-encoded JSON object containing SDK related parameters required by the SDK
    
    Returns:
    
    the current ApplePayDetails instance, allowing for method chaining
  - getSdkData
```
public String getSdkData()
```
    Base64-encoded JSON object containing SDK related parameters required by the SDK
    
    Returns:
    
    sdkData Base64-encoded JSON object containing SDK related parameters required by the SDK
  - setSdkData
```
public void setSdkData(String sdkData)
```
    Base64-encoded JSON object containing SDK related parameters required by the SDK
    
    Parameters:
    
    sdkData - Base64-encoded JSON object containing SDK related parameters required by the SDK
  - storedPaymentMethodId
```
public ApplePayDetails storedPaymentMethodId(String storedPaymentMethodId)
```
    This is the `recurringDetailReference` returned in the response when you created the token.
    
    Parameters:
    
    storedPaymentMethodId - This is the `recurringDetailReference` returned in the response when you created the token.
    
    Returns:
    
    the current ApplePayDetails instance, allowing for method chaining
  - getStoredPaymentMethodId
```
public String getStoredPaymentMethodId()
```
    This is the `recurringDetailReference` returned in the response when you created the token.
    
    Returns:
    
    storedPaymentMethodId This is the `recurringDetailReference` returned in the response when you created the token.
  - setStoredPaymentMethodId
```
public void setStoredPaymentMethodId(String storedPaymentMethodId)
```
    This is the `recurringDetailReference` returned in the response when you created the token.
    
    Parameters:
    
    storedPaymentMethodId - This is the `recurringDetailReference` returned in the response when you created the token.
  - type
```
public ApplePayDetails type(ApplePayDetails.TypeEnum type)
```
    **applepay**
    
    Parameters:
    
    type - **applepay**
    
    Returns:
    
    the current ApplePayDetails instance, allowing for method chaining
  - getType
```
public ApplePayDetails.TypeEnum getType()
```
    **applepay**
    
    Returns:
    
    type **applepay**
  - setType
```
public void setType(ApplePayDetails.TypeEnum type)
```
    **applepay**
    
    Parameters:
    
    type - **applepay**
  - includeNullValues
```
public ApplePayDetails 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 ApplePayDetails 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 ApplePayDetails fromJson(String jsonString)
                                throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of ApplePayDetails given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of ApplePayDetails
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to ApplePayDetails
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of ApplePayDetails to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class ApplePayDetails

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_APPLE_PAY_TOKEN

JSON_PROPERTY_CHECKOUT_ATTEMPT_ID

JSON_PROPERTY_FUNDING_SOURCE

JSON_PROPERTY_RECURRING_DETAIL_REFERENCE

JSON_PROPERTY_SDK_DATA

JSON_PROPERTY_STORED_PAYMENT_METHOD_ID

JSON_PROPERTY_TYPE

Constructor Detail

ApplePayDetails

Method Detail

applePayToken

getApplePayToken

setApplePayToken

checkoutAttemptId

getCheckoutAttemptId

setCheckoutAttemptId

fundingSource

getFundingSource

setFundingSource

recurringDetailReference

getRecurringDetailReference

setRecurringDetailReference

sdkData

getSdkData

setSdkData

storedPaymentMethodId

getStoredPaymentMethodId

setStoredPaymentMethodId

type

getType

setType

includeNullValues

isIncludeNullValues

setIncludeNullValues

equals

hashCode

toString

getExplicitNulls

fromJson

toJson