Package com.adyen.model.recurring
Class RecurringDetail
- java.lang.Object
-
- com.adyen.model.recurring.RecurringDetail
-
public class RecurringDetail extends Object
RecurringDetail
-
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_ADDITIONAL_DATAstatic StringJSON_PROPERTY_ALIASstatic StringJSON_PROPERTY_ALIAS_TYPEstatic StringJSON_PROPERTY_BANKstatic StringJSON_PROPERTY_BILLING_ADDRESSstatic StringJSON_PROPERTY_CARDstatic StringJSON_PROPERTY_CONTRACT_TYPESstatic StringJSON_PROPERTY_CREATION_DATEstatic StringJSON_PROPERTY_FIRST_PSP_REFERENCEstatic StringJSON_PROPERTY_NAMEstatic StringJSON_PROPERTY_NETWORK_TX_REFERENCEstatic StringJSON_PROPERTY_PAYMENT_METHOD_VARIANTstatic StringJSON_PROPERTY_RECURRING_DETAIL_REFERENCEstatic StringJSON_PROPERTY_SHOPPER_NAMEstatic StringJSON_PROPERTY_SOCIAL_SECURITY_NUMBERstatic StringJSON_PROPERTY_TOKEN_DETAILSstatic StringJSON_PROPERTY_VARIANT
-
Constructor Summary
Constructors Constructor Description RecurringDetail()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description RecurringDetailaddContractTypesItem(String contractTypesItem)RecurringDetailadditionalData(Map<String,String> additionalData)RecurringDetailalias(String alias)RecurringDetailaliasType(String aliasType)RecurringDetailbank(BankAccount bank)RecurringDetailbillingAddress(Address billingAddress)RecurringDetailcard(Card card)RecurringDetailcontractTypes(List<String> contractTypes)RecurringDetailcreationDate(OffsetDateTime creationDate)booleanequals(Object o)Return true if this RecurringDetail object is equal to o.RecurringDetailfirstPspReference(String firstPspReference)static RecurringDetailfromJson(String jsonString)Create an instance of RecurringDetail given an JSON stringMap<String,String>getAdditionalData()This field contains additional data, which may be returned in a particular response.StringgetAlias()The alias of the credit card number.StringgetAliasType()The alias type of the credit card number.BankAccountgetBank()Get bankAddressgetBillingAddress()Get billingAddressCardgetCard()Get cardList<String>getContractTypes()Types of recurring contracts.OffsetDateTimegetCreationDate()The date when the recurring details were created.StringgetFirstPspReference()The `pspReference` of the first recurring payment that created the recurring detail.StringgetName()An optional descriptive name for this recurring detail.StringgetNetworkTxReference()Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa.StringgetPaymentMethodVariant()The type or sub-brand of a payment method used, e.g.StringgetRecurringDetailReference()The reference that uniquely identifies the recurring detail.NamegetShopperName()Get shopperNameStringgetSocialSecurityNumber()A shopper's social security number (only in countries where it is legal to collect).TokenDetailsgetTokenDetails()Get tokenDetailsStringgetVariant()The payment method, such as “mc\", \"visa\", \"ideal\", \"paypal\".inthashCode()RecurringDetailname(String name)RecurringDetailnetworkTxReference(String networkTxReference)RecurringDetailpaymentMethodVariant(String paymentMethodVariant)RecurringDetailputAdditionalDataItem(String key, String additionalDataItem)RecurringDetailrecurringDetailReference(String recurringDetailReference)voidsetAdditionalData(Map<String,String> additionalData)This field contains additional data, which may be returned in a particular response.voidsetAlias(String alias)The alias of the credit card number.voidsetAliasType(String aliasType)The alias type of the credit card number.voidsetBank(BankAccount bank)bankvoidsetBillingAddress(Address billingAddress)billingAddressvoidsetCard(Card card)cardvoidsetContractTypes(List<String> contractTypes)Types of recurring contracts.voidsetCreationDate(OffsetDateTime creationDate)The date when the recurring details were created.voidsetFirstPspReference(String firstPspReference)The `pspReference` of the first recurring payment that created the recurring detail.voidsetName(String name)An optional descriptive name for this recurring detail.voidsetNetworkTxReference(String networkTxReference)Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa.voidsetPaymentMethodVariant(String paymentMethodVariant)The type or sub-brand of a payment method used, e.g.voidsetRecurringDetailReference(String recurringDetailReference)The reference that uniquely identifies the recurring detail.voidsetShopperName(Name shopperName)shopperNamevoidsetSocialSecurityNumber(String socialSecurityNumber)A shopper's social security number (only in countries where it is legal to collect).voidsetTokenDetails(TokenDetails tokenDetails)tokenDetailsvoidsetVariant(String variant)The payment method, such as “mc\", \"visa\", \"ideal\", \"paypal\".RecurringDetailshopperName(Name shopperName)RecurringDetailsocialSecurityNumber(String socialSecurityNumber)StringtoJson()Convert an instance of RecurringDetail to an JSON stringRecurringDetailtokenDetails(TokenDetails tokenDetails)StringtoString()RecurringDetailvariant(String variant)
-
-
-
Field Detail
-
JSON_PROPERTY_ADDITIONAL_DATA
public static final String JSON_PROPERTY_ADDITIONAL_DATA
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ALIAS
public static final String JSON_PROPERTY_ALIAS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ALIAS_TYPE
public static final String JSON_PROPERTY_ALIAS_TYPE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_BANK
public static final String JSON_PROPERTY_BANK
- See Also:
- Constant Field Values
-
JSON_PROPERTY_BILLING_ADDRESS
public static final String JSON_PROPERTY_BILLING_ADDRESS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CARD
public static final String JSON_PROPERTY_CARD
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CONTRACT_TYPES
public static final String JSON_PROPERTY_CONTRACT_TYPES
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CREATION_DATE
public static final String JSON_PROPERTY_CREATION_DATE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_FIRST_PSP_REFERENCE
public static final String JSON_PROPERTY_FIRST_PSP_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_NAME
public static final String JSON_PROPERTY_NAME
- See Also:
- Constant Field Values
-
JSON_PROPERTY_NETWORK_TX_REFERENCE
public static final String JSON_PROPERTY_NETWORK_TX_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PAYMENT_METHOD_VARIANT
public static final String JSON_PROPERTY_PAYMENT_METHOD_VARIANT
- 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_SHOPPER_NAME
public static final String JSON_PROPERTY_SHOPPER_NAME
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SOCIAL_SECURITY_NUMBER
public static final String JSON_PROPERTY_SOCIAL_SECURITY_NUMBER
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TOKEN_DETAILS
public static final String JSON_PROPERTY_TOKEN_DETAILS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_VARIANT
public static final String JSON_PROPERTY_VARIANT
- See Also:
- Constant Field Values
-
-
Method Detail
-
additionalData
public RecurringDetail additionalData(Map<String,String> additionalData)
-
putAdditionalDataItem
public RecurringDetail putAdditionalDataItem(String key, String additionalDataItem)
-
getAdditionalData
public Map<String,String> getAdditionalData()
This field contains additional data, which may be returned in a particular response. The additionalData object consists of entries, each of which includes the key and value.- Returns:
- additionalData
-
setAdditionalData
public void setAdditionalData(Map<String,String> additionalData)
This field contains additional data, which may be returned in a particular response. The additionalData object consists of entries, each of which includes the key and value.- Parameters:
additionalData-
-
alias
public RecurringDetail alias(String alias)
-
getAlias
public String getAlias()
The alias of the credit card number. Applies only to recurring contracts storing credit card details- Returns:
- alias
-
setAlias
public void setAlias(String alias)
The alias of the credit card number. Applies only to recurring contracts storing credit card details- Parameters:
alias-
-
aliasType
public RecurringDetail aliasType(String aliasType)
-
getAliasType
public String getAliasType()
The alias type of the credit card number. Applies only to recurring contracts storing credit card details.- Returns:
- aliasType
-
setAliasType
public void setAliasType(String aliasType)
The alias type of the credit card number. Applies only to recurring contracts storing credit card details.- Parameters:
aliasType-
-
bank
public RecurringDetail bank(BankAccount bank)
-
getBank
public BankAccount getBank()
Get bank- Returns:
- bank
-
setBank
public void setBank(BankAccount bank)
bank- Parameters:
bank-
-
billingAddress
public RecurringDetail billingAddress(Address billingAddress)
-
getBillingAddress
public Address getBillingAddress()
Get billingAddress- Returns:
- billingAddress
-
setBillingAddress
public void setBillingAddress(Address billingAddress)
billingAddress- Parameters:
billingAddress-
-
card
public RecurringDetail card(Card card)
-
getCard
public Card getCard()
Get card- Returns:
- card
-
setCard
public void setCard(Card card)
card- Parameters:
card-
-
contractTypes
public RecurringDetail contractTypes(List<String> contractTypes)
-
addContractTypesItem
public RecurringDetail addContractTypesItem(String contractTypesItem)
-
getContractTypes
public List<String> getContractTypes()
Types of recurring contracts.- Returns:
- contractTypes
-
setContractTypes
public void setContractTypes(List<String> contractTypes)
Types of recurring contracts.- Parameters:
contractTypes-
-
creationDate
public RecurringDetail creationDate(OffsetDateTime creationDate)
-
getCreationDate
public OffsetDateTime getCreationDate()
The date when the recurring details were created.- Returns:
- creationDate
-
setCreationDate
public void setCreationDate(OffsetDateTime creationDate)
The date when the recurring details were created.- Parameters:
creationDate-
-
firstPspReference
public RecurringDetail firstPspReference(String firstPspReference)
-
getFirstPspReference
public String getFirstPspReference()
The `pspReference` of the first recurring payment that created the recurring detail.- Returns:
- firstPspReference
-
setFirstPspReference
public void setFirstPspReference(String firstPspReference)
The `pspReference` of the first recurring payment that created the recurring detail.- Parameters:
firstPspReference-
-
name
public RecurringDetail name(String name)
-
getName
public String getName()
An optional descriptive name for this recurring detail.- Returns:
- name
-
setName
public void setName(String name)
An optional descriptive name for this recurring detail.- Parameters:
name-
-
networkTxReference
public RecurringDetail networkTxReference(String networkTxReference)
-
getNetworkTxReference
public String getNetworkTxReference()
Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. This contains either the Mastercard Trace ID or the Visa Transaction ID.- Returns:
- networkTxReference
-
setNetworkTxReference
public void setNetworkTxReference(String networkTxReference)
Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. This contains either the Mastercard Trace ID or the Visa Transaction ID.- Parameters:
networkTxReference-
-
paymentMethodVariant
public RecurringDetail paymentMethodVariant(String paymentMethodVariant)
-
getPaymentMethodVariant
public String getPaymentMethodVariant()
The type or sub-brand of a payment method used, e.g. Visa Debit, Visa Corporate, etc. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant).- Returns:
- paymentMethodVariant
-
setPaymentMethodVariant
public void setPaymentMethodVariant(String paymentMethodVariant)
The type or sub-brand of a payment method used, e.g. Visa Debit, Visa Corporate, etc. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant).- Parameters:
paymentMethodVariant-
-
recurringDetailReference
public RecurringDetail recurringDetailReference(String recurringDetailReference)
-
getRecurringDetailReference
public String getRecurringDetailReference()
The reference that uniquely identifies the recurring detail.- Returns:
- recurringDetailReference
-
setRecurringDetailReference
public void setRecurringDetailReference(String recurringDetailReference)
The reference that uniquely identifies the recurring detail.- Parameters:
recurringDetailReference-
-
shopperName
public RecurringDetail shopperName(Name shopperName)
-
getShopperName
public Name getShopperName()
Get shopperName- Returns:
- shopperName
-
setShopperName
public void setShopperName(Name shopperName)
shopperName- Parameters:
shopperName-
-
socialSecurityNumber
public RecurringDetail socialSecurityNumber(String socialSecurityNumber)
-
getSocialSecurityNumber
public String getSocialSecurityNumber()
A shopper's social security number (only in countries where it is legal to collect).- Returns:
- socialSecurityNumber
-
setSocialSecurityNumber
public void setSocialSecurityNumber(String socialSecurityNumber)
A shopper's social security number (only in countries where it is legal to collect).- Parameters:
socialSecurityNumber-
-
tokenDetails
public RecurringDetail tokenDetails(TokenDetails tokenDetails)
-
getTokenDetails
public TokenDetails getTokenDetails()
Get tokenDetails- Returns:
- tokenDetails
-
setTokenDetails
public void setTokenDetails(TokenDetails tokenDetails)
tokenDetails- Parameters:
tokenDetails-
-
variant
public RecurringDetail variant(String variant)
-
getVariant
public String getVariant()
The payment method, such as “mc\", \"visa\", \"ideal\", \"paypal\".- Returns:
- variant
-
setVariant
public void setVariant(String variant)
The payment method, such as “mc\", \"visa\", \"ideal\", \"paypal\".- Parameters:
variant-
-
equals
public boolean equals(Object o)
Return true if this RecurringDetail object is equal to o.
-
fromJson
public static RecurringDetail fromJson(String jsonString) throws com.fasterxml.jackson.core.JsonProcessingException
Create an instance of RecurringDetail given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of RecurringDetail
- Throws:
com.fasterxml.jackson.core.JsonProcessingException- if the JSON string is invalid with respect to RecurringDetail
-
toJson
public String toJson() throws com.fasterxml.jackson.core.JsonProcessingException
Convert an instance of RecurringDetail to an JSON string- Returns:
- JSON string
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
-
-