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

public class UpiCollectDetails
extends Object

UpiCollectDetails

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class UpiCollectDetails.TypeEnum
upi_collect**

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_BILLING_SEQUENCE_NUMBER`
`static String`	`JSON_PROPERTY_CHECKOUT_ATTEMPT_ID`
`static String`	`JSON_PROPERTY_RECURRING_DETAIL_REFERENCE`
`static String`	`JSON_PROPERTY_SDK_DATA`
`static String`	`JSON_PROPERTY_SHOPPER_NOTIFICATION_REFERENCE`
`static String`	`JSON_PROPERTY_STORED_PAYMENT_METHOD_ID`
`static String`	`JSON_PROPERTY_TYPE`
`static String`	`JSON_PROPERTY_VIRTUAL_PAYMENT_ADDRESS`

Constructor Summary

Constructors
Constructor Description

UpiCollectDetails()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`UpiCollectDetails`	`billingSequenceNumber(String billingSequenceNumber)`	The sequence number for the debit.
`UpiCollectDetails`	`checkoutAttemptId(String checkoutAttemptId)`	The checkout attempt identifier.
`boolean`	`equals(Object o)`	Return true if this UpiCollectDetails object is equal to o.
`static UpiCollectDetails`	`fromJson(String jsonString)`	Create an instance of UpiCollectDetails given an JSON string
`String`	`getBillingSequenceNumber()`	The sequence number for the debit.
`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.
`String`	`getRecurringDetailReference()`	Deprecated. since Adyen Checkout API v49 Use `storedPaymentMethodId` instead.
`String`	`getSdkData()`	Base64-encoded JSON object containing SDK related parameters required by the SDK
`String`	`getShopperNotificationReference()`	The `shopperNotificationReference` returned in the response when you requested to notify the shopper.
`String`	`getStoredPaymentMethodId()`	This is the `recurringDetailReference` returned in the response when you created the token.
`UpiCollectDetails.TypeEnum`	`getType()`	upi_collect
`String`	`getVirtualPaymentAddress()`	The virtual payment address for UPI.
`int`	`hashCode()`
`UpiCollectDetails`	`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.
`UpiCollectDetails`	`recurringDetailReference(String recurringDetailReference)`	Deprecated. since Adyen Checkout API v49 Use `storedPaymentMethodId` instead.
`UpiCollectDetails`	`sdkData(String sdkData)`	Base64-encoded JSON object containing SDK related parameters required by the SDK
`void`	`setBillingSequenceNumber(String billingSequenceNumber)`	The sequence number for the debit.
`void`	`setCheckoutAttemptId(String checkoutAttemptId)`	The checkout attempt identifier.
`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`	`setShopperNotificationReference(String shopperNotificationReference)`	The `shopperNotificationReference` returned in the response when you requested to notify the shopper.
`void`	`setStoredPaymentMethodId(String storedPaymentMethodId)`	This is the `recurringDetailReference` returned in the response when you created the token.
`void`	`setType(UpiCollectDetails.TypeEnum type)`	upi_collect
`void`	`setVirtualPaymentAddress(String virtualPaymentAddress)`	The virtual payment address for UPI.
`UpiCollectDetails`	`shopperNotificationReference(String shopperNotificationReference)`	The `shopperNotificationReference` returned in the response when you requested to notify the shopper.
`UpiCollectDetails`	`storedPaymentMethodId(String storedPaymentMethodId)`	This is the `recurringDetailReference` returned in the response when you created the token.
`String`	`toJson()`	Convert an instance of UpiCollectDetails to an JSON string
`String`	`toString()`
`UpiCollectDetails`	`type(UpiCollectDetails.TypeEnum type)`	upi_collect
`UpiCollectDetails`	`virtualPaymentAddress(String virtualPaymentAddress)`	The virtual payment address for UPI.

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

- Field Detail
  - JSON_PROPERTY_BILLING_SEQUENCE_NUMBER
```
public static final String JSON_PROPERTY_BILLING_SEQUENCE_NUMBER
```
    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_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_SHOPPER_NOTIFICATION_REFERENCE
```
public static final String JSON_PROPERTY_SHOPPER_NOTIFICATION_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
  - JSON_PROPERTY_TYPE
```
public static final String JSON_PROPERTY_TYPE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_VIRTUAL_PAYMENT_ADDRESS
```
public static final String JSON_PROPERTY_VIRTUAL_PAYMENT_ADDRESS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - UpiCollectDetails
```
public UpiCollectDetails()
```
- Method Detail
  - billingSequenceNumber
```
public UpiCollectDetails billingSequenceNumber(String billingSequenceNumber)
```
    The sequence number for the debit. For example, send **2** if this is the second debit for the subscription. The sequence number is included in the notification sent to the shopper.
    
    Parameters:
    
    billingSequenceNumber - The sequence number for the debit. For example, send **2** if this is the second debit for the subscription. The sequence number is included in the notification sent to the shopper.
    
    Returns:
    
    the current UpiCollectDetails instance, allowing for method chaining
  - getBillingSequenceNumber
```
public String getBillingSequenceNumber()
```
    The sequence number for the debit. For example, send **2** if this is the second debit for the subscription. The sequence number is included in the notification sent to the shopper.
    
    Returns:
    
    billingSequenceNumber The sequence number for the debit. For example, send **2** if this is the second debit for the subscription. The sequence number is included in the notification sent to the shopper.
  - setBillingSequenceNumber
```
public void setBillingSequenceNumber(String billingSequenceNumber)
```
    The sequence number for the debit. For example, send **2** if this is the second debit for the subscription. The sequence number is included in the notification sent to the shopper.
    
    Parameters:
    
    billingSequenceNumber - The sequence number for the debit. For example, send **2** if this is the second debit for the subscription. The sequence number is included in the notification sent to the shopper.
  - checkoutAttemptId
```
public UpiCollectDetails checkoutAttemptId(String checkoutAttemptId)
```
    The checkout attempt identifier.
    
    Parameters:
    
    checkoutAttemptId - The checkout attempt identifier.
    
    Returns:
    
    the current UpiCollectDetails 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.
  - recurringDetailReference
```
@Deprecated
public UpiCollectDetails 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 UpiCollectDetails instance, allowing for method chaining
  - getRecurringDetailReference
```
@Deprecated
public String getRecurringDetailReference()
```
    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 UpiCollectDetails 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 UpiCollectDetails 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
  - shopperNotificationReference
```
public UpiCollectDetails shopperNotificationReference(String shopperNotificationReference)
```
    The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used for recurring payment only.
    
    Parameters:
    
    shopperNotificationReference - The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used for recurring payment only.
    
    Returns:
    
    the current UpiCollectDetails instance, allowing for method chaining
  - getShopperNotificationReference
```
public String getShopperNotificationReference()
```
    The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used for recurring payment only.
    
    Returns:
    
    shopperNotificationReference The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used for recurring payment only.
  - setShopperNotificationReference
```
public void setShopperNotificationReference(String shopperNotificationReference)
```
    The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used for recurring payment only.
    
    Parameters:
    
    shopperNotificationReference - The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used for recurring payment only.
  - storedPaymentMethodId
```
public UpiCollectDetails 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 UpiCollectDetails 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 UpiCollectDetails type(UpiCollectDetails.TypeEnum type)
```
    **upi_collect**
    
    Parameters:
    
    type - **upi_collect**
    
    Returns:
    
    the current UpiCollectDetails instance, allowing for method chaining
  - getType
```
public UpiCollectDetails.TypeEnum getType()
```
    **upi_collect**
    
    Returns:
    
    type **upi_collect**
  - setType
```
public void setType(UpiCollectDetails.TypeEnum type)
```
    **upi_collect**
    
    Parameters:
    
    type - **upi_collect**
  - virtualPaymentAddress
```
public UpiCollectDetails virtualPaymentAddress(String virtualPaymentAddress)
```
    The virtual payment address for UPI.
    
    Parameters:
    
    virtualPaymentAddress - The virtual payment address for UPI.
    
    Returns:
    
    the current UpiCollectDetails instance, allowing for method chaining
  - getVirtualPaymentAddress
```
public String getVirtualPaymentAddress()
```
    The virtual payment address for UPI.
    
    Returns:
    
    virtualPaymentAddress The virtual payment address for UPI.
  - setVirtualPaymentAddress
```
public void setVirtualPaymentAddress(String virtualPaymentAddress)
```
    The virtual payment address for UPI.
    
    Parameters:
    
    virtualPaymentAddress - The virtual payment address for UPI.
  - includeNullValues
```
public UpiCollectDetails 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 UpiCollectDetails 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 UpiCollectDetails fromJson(String jsonString)
                                  throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of UpiCollectDetails given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of UpiCollectDetails
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to UpiCollectDetails
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of UpiCollectDetails to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class UpiCollectDetails

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_BILLING_SEQUENCE_NUMBER

JSON_PROPERTY_CHECKOUT_ATTEMPT_ID

JSON_PROPERTY_RECURRING_DETAIL_REFERENCE

JSON_PROPERTY_SDK_DATA

JSON_PROPERTY_SHOPPER_NOTIFICATION_REFERENCE

JSON_PROPERTY_STORED_PAYMENT_METHOD_ID

JSON_PROPERTY_TYPE

JSON_PROPERTY_VIRTUAL_PAYMENT_ADDRESS

Constructor Detail

UpiCollectDetails

Method Detail

billingSequenceNumber

getBillingSequenceNumber

setBillingSequenceNumber

checkoutAttemptId

getCheckoutAttemptId

setCheckoutAttemptId

recurringDetailReference

getRecurringDetailReference

setRecurringDetailReference

sdkData

getSdkData

setSdkData

shopperNotificationReference

getShopperNotificationReference

setShopperNotificationReference

storedPaymentMethodId

getStoredPaymentMethodId

setStoredPaymentMethodId

type

getType

setType

virtualPaymentAddress

getVirtualPaymentAddress

setVirtualPaymentAddress

includeNullValues

isIncludeNullValues

setIncludeNullValues

equals

hashCode

toString

getExplicitNulls

fromJson

toJson