java.lang.Object
- com.adyen.model.recurring.NotifyShopperRequest

public class NotifyShopperRequest
extends Object

NotifyShopperRequest

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_AMOUNT`
`static String`	`JSON_PROPERTY_BILLING_DATE`
`static String`	`JSON_PROPERTY_BILLING_SEQUENCE_NUMBER`
`static String`	`JSON_PROPERTY_DISPLAYED_REFERENCE`
`static String`	`JSON_PROPERTY_MERCHANT_ACCOUNT`
`static String`	`JSON_PROPERTY_RECURRING_DETAIL_REFERENCE`
`static String`	`JSON_PROPERTY_REFERENCE`
`static String`	`JSON_PROPERTY_SHOPPER_REFERENCE`
`static String`	`JSON_PROPERTY_STORED_PAYMENT_METHOD_ID`

Constructor Summary

Constructors
Constructor Description

NotifyShopperRequest()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`NotifyShopperRequest`	`amount(Amount amount)`	amount
`NotifyShopperRequest`	`billingDate(String billingDate)`	Date on which the subscription amount will be debited from the shopper.
`NotifyShopperRequest`	`billingSequenceNumber(String billingSequenceNumber)`	Sequence of the debit.
`NotifyShopperRequest`	`displayedReference(String displayedReference)`	Reference of Pre-debit notification that is displayed to the shopper.
`boolean`	`equals(Object o)`	Return true if this NotifyShopperRequest object is equal to o.
`static NotifyShopperRequest`	`fromJson(String jsonString)`	Create an instance of NotifyShopperRequest given an JSON string
`Amount`	`getAmount()`	amount
`String`	`getBillingDate()`	Date on which the subscription amount will be debited from the shopper.
`String`	`getBillingSequenceNumber()`	Sequence of the debit.
`String`	`getDisplayedReference()`	Reference of Pre-debit notification that is displayed to the shopper.
`String`	`getMerchantAccount()`	The merchant account identifier with which you want to process the transaction.
`String`	`getRecurringDetailReference()`	This is the `recurringDetailReference` returned in the response when you created the token.
`String`	`getReference()`	Pre-debit notification reference sent by the merchant.
`String`	`getShopperReference()`	The ID that uniquely identifies the shopper.
`String`	`getStoredPaymentMethodId()`	This is the `recurringDetailReference` returned in the response when you created the token.
`int`	`hashCode()`
`NotifyShopperRequest`	`merchantAccount(String merchantAccount)`	The merchant account identifier with which you want to process the transaction.
`NotifyShopperRequest`	`recurringDetailReference(String recurringDetailReference)`	This is the `recurringDetailReference` returned in the response when you created the token.
`NotifyShopperRequest`	`reference(String reference)`	Pre-debit notification reference sent by the merchant.
`void`	`setAmount(Amount amount)`	amount
`void`	`setBillingDate(String billingDate)`	Date on which the subscription amount will be debited from the shopper.
`void`	`setBillingSequenceNumber(String billingSequenceNumber)`	Sequence of the debit.
`void`	`setDisplayedReference(String displayedReference)`	Reference of Pre-debit notification that is displayed to the shopper.
`void`	`setMerchantAccount(String merchantAccount)`	The merchant account identifier with which you want to process the transaction.
`void`	`setRecurringDetailReference(String recurringDetailReference)`	This is the `recurringDetailReference` returned in the response when you created the token.
`void`	`setReference(String reference)`	Pre-debit notification reference sent by the merchant.
`void`	`setShopperReference(String shopperReference)`	The ID that uniquely identifies the shopper.
`void`	`setStoredPaymentMethodId(String storedPaymentMethodId)`	This is the `recurringDetailReference` returned in the response when you created the token.
`NotifyShopperRequest`	`shopperReference(String shopperReference)`	The ID that uniquely identifies the shopper.
`NotifyShopperRequest`	`storedPaymentMethodId(String storedPaymentMethodId)`	This is the `recurringDetailReference` returned in the response when you created the token.
`String`	`toJson()`	Convert an instance of NotifyShopperRequest 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_BILLING_DATE
```
public static final String JSON_PROPERTY_BILLING_DATE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_BILLING_SEQUENCE_NUMBER
```
public static final String JSON_PROPERTY_BILLING_SEQUENCE_NUMBER
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DISPLAYED_REFERENCE
```
public static final String JSON_PROPERTY_DISPLAYED_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MERCHANT_ACCOUNT
```
public static final String JSON_PROPERTY_MERCHANT_ACCOUNT
```
    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_REFERENCE
```
public static final String JSON_PROPERTY_REFERENCE
```
    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
  - NotifyShopperRequest
```
public NotifyShopperRequest()
```
- Method Detail
  - amount
```
public NotifyShopperRequest amount(Amount amount)
```
    amount
    
    Parameters:
    
    amount -
    
    Returns:
    
    the current NotifyShopperRequest instance, allowing for method chaining
  - getAmount
```
public Amount getAmount()
```
    amount
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(Amount amount)
```
    amount
    
    Parameters:
    
    amount -
  - billingDate
```
public NotifyShopperRequest billingDate(String billingDate)
```
    Date on which the subscription amount will be debited from the shopper. In YYYY-MM-DD format
    
    Parameters:
    
    billingDate -
    
    Returns:
    
    the current NotifyShopperRequest instance, allowing for method chaining
  - getBillingDate
```
public String getBillingDate()
```
    Date on which the subscription amount will be debited from the shopper. In YYYY-MM-DD format
    
    Returns:
    
    billingDate
  - setBillingDate
```
public void setBillingDate(String billingDate)
```
    Date on which the subscription amount will be debited from the shopper. In YYYY-MM-DD format
    
    Parameters:
    
    billingDate -
  - billingSequenceNumber
```
public NotifyShopperRequest billingSequenceNumber(String billingSequenceNumber)
```
    Sequence of the debit. Depends on Frequency and Billing Attempts Rule.
    
    Parameters:
    
    billingSequenceNumber -
    
    Returns:
    
    the current NotifyShopperRequest instance, allowing for method chaining
  - getBillingSequenceNumber
```
public String getBillingSequenceNumber()
```
    Sequence of the debit. Depends on Frequency and Billing Attempts Rule.
    
    Returns:
    
    billingSequenceNumber
  - setBillingSequenceNumber
```
public void setBillingSequenceNumber(String billingSequenceNumber)
```
    Sequence of the debit. Depends on Frequency and Billing Attempts Rule.
    
    Parameters:
    
    billingSequenceNumber -
  - displayedReference
```
public NotifyShopperRequest displayedReference(String displayedReference)
```
    Reference of Pre-debit notification that is displayed to the shopper. Optional field. Maps to reference if missing
    
    Parameters:
    
    displayedReference -
    
    Returns:
    
    the current NotifyShopperRequest instance, allowing for method chaining
  - getDisplayedReference
```
public String getDisplayedReference()
```
    Reference of Pre-debit notification that is displayed to the shopper. Optional field. Maps to reference if missing
    
    Returns:
    
    displayedReference
  - setDisplayedReference
```
public void setDisplayedReference(String displayedReference)
```
    Reference of Pre-debit notification that is displayed to the shopper. Optional field. Maps to reference if missing
    
    Parameters:
    
    displayedReference -
  - merchantAccount
```
public NotifyShopperRequest merchantAccount(String merchantAccount)
```
    The merchant account identifier with which you want to process the transaction.
    
    Parameters:
    
    merchantAccount -
    
    Returns:
    
    the current NotifyShopperRequest instance, allowing for method chaining
  - getMerchantAccount
```
public String getMerchantAccount()
```
    The merchant account identifier with which you want to process the transaction.
    
    Returns:
    
    merchantAccount
  - setMerchantAccount
```
public void setMerchantAccount(String merchantAccount)
```
    The merchant account identifier with which you want to process the transaction.
    
    Parameters:
    
    merchantAccount -
  - recurringDetailReference
```
public NotifyShopperRequest recurringDetailReference(String recurringDetailReference)
```
    This is the `recurringDetailReference` returned in the response when you created the token.
    
    Parameters:
    
    recurringDetailReference -
    
    Returns:
    
    the current NotifyShopperRequest instance, allowing for method chaining
  - getRecurringDetailReference
```
public String getRecurringDetailReference()
```
    This is the `recurringDetailReference` returned in the response when you created the token.
    
    Returns:
    
    recurringDetailReference
  - setRecurringDetailReference
```
public void setRecurringDetailReference(String recurringDetailReference)
```
    This is the `recurringDetailReference` returned in the response when you created the token.
    
    Parameters:
    
    recurringDetailReference -
  - reference
```
public NotifyShopperRequest reference(String reference)
```
    Pre-debit notification reference sent by the merchant. This is a mandatory field
    
    Parameters:
    
    reference -
    
    Returns:
    
    the current NotifyShopperRequest instance, allowing for method chaining
  - getReference
```
public String getReference()
```
    Pre-debit notification reference sent by the merchant. This is a mandatory field
    
    Returns:
    
    reference
  - setReference
```
public void setReference(String reference)
```
    Pre-debit notification reference sent by the merchant. This is a mandatory field
    
    Parameters:
    
    reference -
  - shopperReference
```
public NotifyShopperRequest shopperReference(String shopperReference)
```
    The ID that uniquely identifies the shopper. This `shopperReference` must be the same as the `shopperReference` used in the initial payment.
    
    Parameters:
    
    shopperReference -
    
    Returns:
    
    the current NotifyShopperRequest instance, allowing for method chaining
  - getShopperReference
```
public String getShopperReference()
```
    The ID that uniquely identifies the shopper. This `shopperReference` must be the same as the `shopperReference` used in the initial payment.
    
    Returns:
    
    shopperReference
  - setShopperReference
```
public void setShopperReference(String shopperReference)
```
    The ID that uniquely identifies the shopper. This `shopperReference` must be the same as the `shopperReference` used in the initial payment.
    
    Parameters:
    
    shopperReference -
  - storedPaymentMethodId
```
public NotifyShopperRequest storedPaymentMethodId(String storedPaymentMethodId)
```
    This is the `recurringDetailReference` returned in the response when you created the token.
    
    Parameters:
    
    storedPaymentMethodId -
    
    Returns:
    
    the current NotifyShopperRequest instance, allowing for method chaining
  - getStoredPaymentMethodId
```
public String getStoredPaymentMethodId()
```
    This is the `recurringDetailReference` returned in the response when you created the token.
    
    Returns:
    
    storedPaymentMethodId
  - setStoredPaymentMethodId
```
public void setStoredPaymentMethodId(String storedPaymentMethodId)
```
    This is the `recurringDetailReference` returned in the response when you created the token.
    
    Parameters:
    
    storedPaymentMethodId -
  - equals
```
public boolean equals(Object o)
```
    Return true if this NotifyShopperRequest 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
  - fromJson
```
public static NotifyShopperRequest fromJson(String jsonString)
                                     throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of NotifyShopperRequest given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of NotifyShopperRequest
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to NotifyShopperRequest
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of NotifyShopperRequest to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class NotifyShopperRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_AMOUNT

JSON_PROPERTY_BILLING_DATE

JSON_PROPERTY_BILLING_SEQUENCE_NUMBER

JSON_PROPERTY_DISPLAYED_REFERENCE

JSON_PROPERTY_MERCHANT_ACCOUNT

JSON_PROPERTY_RECURRING_DETAIL_REFERENCE

JSON_PROPERTY_REFERENCE

JSON_PROPERTY_SHOPPER_REFERENCE

JSON_PROPERTY_STORED_PAYMENT_METHOD_ID

Constructor Detail

NotifyShopperRequest

Method Detail

amount

getAmount

setAmount

billingDate

getBillingDate

setBillingDate

billingSequenceNumber

getBillingSequenceNumber

setBillingSequenceNumber

displayedReference

getDisplayedReference

setDisplayedReference

merchantAccount

getMerchantAccount

setMerchantAccount

recurringDetailReference

getRecurringDetailReference

setRecurringDetailReference

reference

getReference

setReference

shopperReference

getShopperReference

setShopperReference

storedPaymentMethodId

getStoredPaymentMethodId

setStoredPaymentMethodId

equals

hashCode

toString

fromJson

toJson