Class ChangeRequest
- java.lang.Object
-
- com.softlayer.api.Type
-
- com.softlayer.api.service.Entity
-
- com.softlayer.api.service.billing.payment.card.ChangeRequest
-
@ApiType("SoftLayer_Billing_Payment_Card_ChangeRequest") public class ChangeRequest extends Entity
The SoftLayer_Billing_Payment_Card_ChangeRequest data type contains general information relating to attempted credit card information changes. This supports enablement of 3D Secure via Cardinal Cruise implementation that allows for credit card authentication and is currently limited to specified merchants.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ChangeRequest.Mask
-
Field Summary
Fields Modifier and Type Field Description protected Account
account
protected Long
accountId
The account ID to which the credit card and billing information is associated with.protected boolean
accountIdSpecified
protected BigDecimal
amount
The total amount of the attempted transaction, represented in decimal format as US Dollars ($USD).protected boolean
amountSpecified
protected Transaction
authorizedCreditCardTransaction
The SoftLayer_Billing_Payment_Card_Transaction tied to the authorization performed as part of this change request.protected String
billingAddressLine1
The physical street address.protected boolean
billingAddressLine1Specified
protected String
billingAddressLine2
The second line in the address.protected boolean
billingAddressLine2Specified
protected String
billingCity
The city in which a customer's account resides.protected boolean
billingCitySpecified
protected String
billingCountryCode
The 2-character Country code for an account's address.protected boolean
billingCountryCodeSpecified
protected String
billingEmail
The email address associated with a customer account.protected boolean
billingEmailSpecified
protected String
billingNameCompany
the company name for an account.protected boolean
billingNameCompanySpecified
protected String
billingNameFirst
The first name of the customer account owner.protected boolean
billingNameFirstSpecified
protected String
billingNameLast
The last name of the customer account ownerprotected boolean
billingNameLastSpecified
protected String
billingPhoneFax
The fax number associated with a customer account.protected boolean
billingPhoneFaxSpecified
protected String
billingPhoneVoice
The phone number associated with a customer account.protected boolean
billingPhoneVoiceSpecified
protected String
billingPostalCode
The Zip or Postal Code for the billing address on an account.protected boolean
billingPostalCodeSpecified
protected String
billingState
The State for the account.protected boolean
billingStateSpecified
protected Transaction
captureCreditCardTransaction
The SoftLayer_Billing_Payment_Card_Transaction tied to the capture of funds performed as part of this change request.protected String
cardAccountLast4
The last 4 digits of a customer's credit card.protected boolean
cardAccountLast4Specified
protected String
cardAccountNumber
The card number submitted in the change request.protected boolean
cardAccountNumberSpecified
protected String
cardExpirationMonth
The month (MM) in which a customer's payment card will expire.protected boolean
cardExpirationMonthSpecified
protected String
cardExpirationYear
The year (YYYY) in which a customer's payment card will expire.protected boolean
cardExpirationYearSpecified
protected String
cardNickname
protected boolean
cardNicknameSpecified
protected String
cardType
The type of payment card a customer has.protected boolean
cardTypeSpecified
protected String
creditCardVerificationNumber
The credit card verification number submitted in the change request.protected boolean
creditCardVerificationNumberSpecified
protected String
currencyShortName
Describes the currency selected for paymentprotected boolean
currencyShortNameSpecified
protected String
deviceFingerprintId
Device Fingerprint Identifier - Used internally and can safely be ignored.protected boolean
deviceFingerprintIdSpecified
protected Long
id
The unique identifier for a single change request.protected boolean
idSpecified
protected String
notes
the notes stored about a customer's payment card.protected boolean
notesSpecified
protected String
payerAuthenticationEnrollmentReferenceId
The purpose of this property is to allow enablement of 3D Secure (3DS).protected boolean
payerAuthenticationEnrollmentReferenceIdSpecified
protected String
payerAuthenticationWebToken
"Continue with Consumer Authentication" decoded response JWT (JSON Web Token) after successful authentication.protected boolean
payerAuthenticationWebTokenSpecified
protected Long
paymentRoleId
protected boolean
paymentRoleIdSpecified
protected String
paymentType
The description of the type of payment sent in a change transaction.protected boolean
paymentTypeSpecified
protected Long
ticketAttachmentReferenceCount
A count of these are tickets tied to a credit card change request.protected List<Attachment>
ticketAttachmentReferences
These are tickets tied to a credit card change request.protected Long
ticketId
Unique identifier for a ticket discussing the switch between payment methods.protected boolean
ticketIdSpecified
-
Fields inherited from class com.softlayer.api.Type
unknownProperties
-
-
Constructor Summary
Constructors Constructor Description ChangeRequest()
-
Method Summary
-
Methods inherited from class com.softlayer.api.Type
getUnknownProperties, setUnknownProperties
-
-
-
-
Field Detail
-
account
@ApiProperty protected Account account
-
authorizedCreditCardTransaction
@ApiProperty protected Transaction authorizedCreditCardTransaction
The SoftLayer_Billing_Payment_Card_Transaction tied to the authorization performed as part of this change request.
-
captureCreditCardTransaction
@ApiProperty protected Transaction captureCreditCardTransaction
The SoftLayer_Billing_Payment_Card_Transaction tied to the capture of funds performed as part of this change request.
-
ticketAttachmentReferences
@ApiProperty protected List<Attachment> ticketAttachmentReferences
These are tickets tied to a credit card change request.
-
accountId
@ApiProperty(canBeNullOrNotSet=true) protected Long accountId
The account ID to which the credit card and billing information is associated with.
-
accountIdSpecified
protected boolean accountIdSpecified
-
amount
@ApiProperty(canBeNullOrNotSet=true) protected BigDecimal amount
The total amount of the attempted transaction, represented in decimal format as US Dollars ($USD).
-
amountSpecified
protected boolean amountSpecified
-
billingAddressLine1
@ApiProperty(canBeNullOrNotSet=true) protected String billingAddressLine1
The physical street address. Reserve information such as "apartment #123" or "Suite 2" for line 1.
-
billingAddressLine1Specified
protected boolean billingAddressLine1Specified
-
billingAddressLine2
@ApiProperty(canBeNullOrNotSet=true) protected String billingAddressLine2
The second line in the address. Information such as suite number goes here.
-
billingAddressLine2Specified
protected boolean billingAddressLine2Specified
-
billingCity
@ApiProperty(canBeNullOrNotSet=true) protected String billingCity
The city in which a customer's account resides.
-
billingCitySpecified
protected boolean billingCitySpecified
-
billingCountryCode
@ApiProperty(canBeNullOrNotSet=true) protected String billingCountryCode
The 2-character Country code for an account's address. (i.e. US)
-
billingCountryCodeSpecified
protected boolean billingCountryCodeSpecified
-
billingEmail
@ApiProperty(canBeNullOrNotSet=true) protected String billingEmail
The email address associated with a customer account.
-
billingEmailSpecified
protected boolean billingEmailSpecified
-
billingNameCompany
@ApiProperty(canBeNullOrNotSet=true) protected String billingNameCompany
the company name for an account.
-
billingNameCompanySpecified
protected boolean billingNameCompanySpecified
-
billingNameFirst
@ApiProperty(canBeNullOrNotSet=true) protected String billingNameFirst
The first name of the customer account owner.
-
billingNameFirstSpecified
protected boolean billingNameFirstSpecified
-
billingNameLast
@ApiProperty(canBeNullOrNotSet=true) protected String billingNameLast
The last name of the customer account owner
-
billingNameLastSpecified
protected boolean billingNameLastSpecified
-
billingPhoneFax
@ApiProperty(canBeNullOrNotSet=true) protected String billingPhoneFax
The fax number associated with a customer account.
-
billingPhoneFaxSpecified
protected boolean billingPhoneFaxSpecified
-
billingPhoneVoice
@ApiProperty(canBeNullOrNotSet=true) protected String billingPhoneVoice
The phone number associated with a customer account.
-
billingPhoneVoiceSpecified
protected boolean billingPhoneVoiceSpecified
-
billingPostalCode
@ApiProperty(canBeNullOrNotSet=true) protected String billingPostalCode
The Zip or Postal Code for the billing address on an account.
-
billingPostalCodeSpecified
protected boolean billingPostalCodeSpecified
-
billingState
@ApiProperty(canBeNullOrNotSet=true) protected String billingState
The State for the account.
-
billingStateSpecified
protected boolean billingStateSpecified
-
cardAccountLast4
@ApiProperty(canBeNullOrNotSet=true) protected String cardAccountLast4
The last 4 digits of a customer's credit card.
-
cardAccountLast4Specified
protected boolean cardAccountLast4Specified
-
cardAccountNumber
@ApiProperty(canBeNullOrNotSet=true) protected String cardAccountNumber
The card number submitted in the change request.
-
cardAccountNumberSpecified
protected boolean cardAccountNumberSpecified
-
cardExpirationMonth
@ApiProperty(canBeNullOrNotSet=true) protected String cardExpirationMonth
The month (MM) in which a customer's payment card will expire.
-
cardExpirationMonthSpecified
protected boolean cardExpirationMonthSpecified
-
cardExpirationYear
@ApiProperty(canBeNullOrNotSet=true) protected String cardExpirationYear
The year (YYYY) in which a customer's payment card will expire.
-
cardExpirationYearSpecified
protected boolean cardExpirationYearSpecified
-
cardNickname
@ApiProperty(canBeNullOrNotSet=true) protected String cardNickname
-
cardNicknameSpecified
protected boolean cardNicknameSpecified
-
cardType
@ApiProperty(canBeNullOrNotSet=true) protected String cardType
The type of payment card a customer has. (i.e. Visa, MasterCard, American Express).
-
cardTypeSpecified
protected boolean cardTypeSpecified
-
creditCardVerificationNumber
@ApiProperty(canBeNullOrNotSet=true) protected String creditCardVerificationNumber
The credit card verification number submitted in the change request.
-
creditCardVerificationNumberSpecified
protected boolean creditCardVerificationNumberSpecified
-
currencyShortName
@ApiProperty(canBeNullOrNotSet=true) protected String currencyShortName
Describes the currency selected for payment
-
currencyShortNameSpecified
protected boolean currencyShortNameSpecified
-
deviceFingerprintId
@ApiProperty(canBeNullOrNotSet=true) protected String deviceFingerprintId
Device Fingerprint Identifier - Used internally and can safely be ignored.
-
deviceFingerprintIdSpecified
protected boolean deviceFingerprintIdSpecified
-
id
@ApiProperty(canBeNullOrNotSet=true) protected Long id
The unique identifier for a single change request.
-
idSpecified
protected boolean idSpecified
-
notes
@ApiProperty(canBeNullOrNotSet=true) protected String notes
the notes stored about a customer's payment card.
-
notesSpecified
protected boolean notesSpecified
-
payerAuthenticationEnrollmentReferenceId
@ApiProperty(canBeNullOrNotSet=true) protected String payerAuthenticationEnrollmentReferenceId
The purpose of this property is to allow enablement of 3D Secure (3DS). This is the Reference ID that corresponds to the device data for Payer Authentication. In order to properly enable 3DS, this will require implementation of Cardinal Cruise Hybrid.
Please refer to https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/360668/Cardinal+Cruise+Hybrid and view section under "DFReferenceId / ReferenceId" to populate this property accordingly.
-
payerAuthenticationEnrollmentReferenceIdSpecified
protected boolean payerAuthenticationEnrollmentReferenceIdSpecified
-
payerAuthenticationWebToken
@ApiProperty(canBeNullOrNotSet=true) protected String payerAuthenticationWebToken
"Continue with Consumer Authentication" decoded response JWT (JSON Web Token) after successful authentication. The response is part of the implementation of Cardinal Cruise Hybrid.
Please refer to https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/360668/Cardinal+Cruise+Hybrid and view section under "Continue with Consumer Authentication" to populate this property accordingly based on the CCA response.
-
payerAuthenticationWebTokenSpecified
protected boolean payerAuthenticationWebTokenSpecified
-
paymentRoleId
@ApiProperty(canBeNullOrNotSet=true) protected Long paymentRoleId
-
paymentRoleIdSpecified
protected boolean paymentRoleIdSpecified
-
paymentType
@ApiProperty(canBeNullOrNotSet=true) protected String paymentType
The description of the type of payment sent in a change transaction.
-
paymentTypeSpecified
protected boolean paymentTypeSpecified
-
ticketId
@ApiProperty(canBeNullOrNotSet=true) protected Long ticketId
Unique identifier for a ticket discussing the switch between payment methods.
-
ticketIdSpecified
protected boolean ticketIdSpecified
-
ticketAttachmentReferenceCount
@ApiProperty protected Long ticketAttachmentReferenceCount
A count of these are tickets tied to a credit card change request.
-
-
Method Detail
-
getAccount
public Account getAccount()
-
setAccount
public void setAccount(Account account)
-
getAuthorizedCreditCardTransaction
public Transaction getAuthorizedCreditCardTransaction()
-
setAuthorizedCreditCardTransaction
public void setAuthorizedCreditCardTransaction(Transaction authorizedCreditCardTransaction)
-
getCaptureCreditCardTransaction
public Transaction getCaptureCreditCardTransaction()
-
setCaptureCreditCardTransaction
public void setCaptureCreditCardTransaction(Transaction captureCreditCardTransaction)
-
getTicketAttachmentReferences
public List<Attachment> getTicketAttachmentReferences()
-
getAccountId
public Long getAccountId()
-
setAccountId
public void setAccountId(Long accountId)
-
isAccountIdSpecified
public boolean isAccountIdSpecified()
-
unsetAccountId
public void unsetAccountId()
-
getAmount
public BigDecimal getAmount()
-
setAmount
public void setAmount(BigDecimal amount)
-
isAmountSpecified
public boolean isAmountSpecified()
-
unsetAmount
public void unsetAmount()
-
getBillingAddressLine1
public String getBillingAddressLine1()
-
setBillingAddressLine1
public void setBillingAddressLine1(String billingAddressLine1)
-
isBillingAddressLine1Specified
public boolean isBillingAddressLine1Specified()
-
unsetBillingAddressLine1
public void unsetBillingAddressLine1()
-
getBillingAddressLine2
public String getBillingAddressLine2()
-
setBillingAddressLine2
public void setBillingAddressLine2(String billingAddressLine2)
-
isBillingAddressLine2Specified
public boolean isBillingAddressLine2Specified()
-
unsetBillingAddressLine2
public void unsetBillingAddressLine2()
-
getBillingCity
public String getBillingCity()
-
setBillingCity
public void setBillingCity(String billingCity)
-
isBillingCitySpecified
public boolean isBillingCitySpecified()
-
unsetBillingCity
public void unsetBillingCity()
-
getBillingCountryCode
public String getBillingCountryCode()
-
setBillingCountryCode
public void setBillingCountryCode(String billingCountryCode)
-
isBillingCountryCodeSpecified
public boolean isBillingCountryCodeSpecified()
-
unsetBillingCountryCode
public void unsetBillingCountryCode()
-
getBillingEmail
public String getBillingEmail()
-
setBillingEmail
public void setBillingEmail(String billingEmail)
-
isBillingEmailSpecified
public boolean isBillingEmailSpecified()
-
unsetBillingEmail
public void unsetBillingEmail()
-
getBillingNameCompany
public String getBillingNameCompany()
-
setBillingNameCompany
public void setBillingNameCompany(String billingNameCompany)
-
isBillingNameCompanySpecified
public boolean isBillingNameCompanySpecified()
-
unsetBillingNameCompany
public void unsetBillingNameCompany()
-
getBillingNameFirst
public String getBillingNameFirst()
-
setBillingNameFirst
public void setBillingNameFirst(String billingNameFirst)
-
isBillingNameFirstSpecified
public boolean isBillingNameFirstSpecified()
-
unsetBillingNameFirst
public void unsetBillingNameFirst()
-
getBillingNameLast
public String getBillingNameLast()
-
setBillingNameLast
public void setBillingNameLast(String billingNameLast)
-
isBillingNameLastSpecified
public boolean isBillingNameLastSpecified()
-
unsetBillingNameLast
public void unsetBillingNameLast()
-
getBillingPhoneFax
public String getBillingPhoneFax()
-
setBillingPhoneFax
public void setBillingPhoneFax(String billingPhoneFax)
-
isBillingPhoneFaxSpecified
public boolean isBillingPhoneFaxSpecified()
-
unsetBillingPhoneFax
public void unsetBillingPhoneFax()
-
getBillingPhoneVoice
public String getBillingPhoneVoice()
-
setBillingPhoneVoice
public void setBillingPhoneVoice(String billingPhoneVoice)
-
isBillingPhoneVoiceSpecified
public boolean isBillingPhoneVoiceSpecified()
-
unsetBillingPhoneVoice
public void unsetBillingPhoneVoice()
-
getBillingPostalCode
public String getBillingPostalCode()
-
setBillingPostalCode
public void setBillingPostalCode(String billingPostalCode)
-
isBillingPostalCodeSpecified
public boolean isBillingPostalCodeSpecified()
-
unsetBillingPostalCode
public void unsetBillingPostalCode()
-
getBillingState
public String getBillingState()
-
setBillingState
public void setBillingState(String billingState)
-
isBillingStateSpecified
public boolean isBillingStateSpecified()
-
unsetBillingState
public void unsetBillingState()
-
getCardAccountLast4
public String getCardAccountLast4()
-
setCardAccountLast4
public void setCardAccountLast4(String cardAccountLast4)
-
isCardAccountLast4Specified
public boolean isCardAccountLast4Specified()
-
unsetCardAccountLast4
public void unsetCardAccountLast4()
-
getCardAccountNumber
public String getCardAccountNumber()
-
setCardAccountNumber
public void setCardAccountNumber(String cardAccountNumber)
-
isCardAccountNumberSpecified
public boolean isCardAccountNumberSpecified()
-
unsetCardAccountNumber
public void unsetCardAccountNumber()
-
getCardExpirationMonth
public String getCardExpirationMonth()
-
setCardExpirationMonth
public void setCardExpirationMonth(String cardExpirationMonth)
-
isCardExpirationMonthSpecified
public boolean isCardExpirationMonthSpecified()
-
unsetCardExpirationMonth
public void unsetCardExpirationMonth()
-
getCardExpirationYear
public String getCardExpirationYear()
-
setCardExpirationYear
public void setCardExpirationYear(String cardExpirationYear)
-
isCardExpirationYearSpecified
public boolean isCardExpirationYearSpecified()
-
unsetCardExpirationYear
public void unsetCardExpirationYear()
-
getCardNickname
public String getCardNickname()
-
setCardNickname
public void setCardNickname(String cardNickname)
-
isCardNicknameSpecified
public boolean isCardNicknameSpecified()
-
unsetCardNickname
public void unsetCardNickname()
-
getCardType
public String getCardType()
-
setCardType
public void setCardType(String cardType)
-
isCardTypeSpecified
public boolean isCardTypeSpecified()
-
unsetCardType
public void unsetCardType()
-
getCreditCardVerificationNumber
public String getCreditCardVerificationNumber()
-
setCreditCardVerificationNumber
public void setCreditCardVerificationNumber(String creditCardVerificationNumber)
-
isCreditCardVerificationNumberSpecified
public boolean isCreditCardVerificationNumberSpecified()
-
unsetCreditCardVerificationNumber
public void unsetCreditCardVerificationNumber()
-
getCurrencyShortName
public String getCurrencyShortName()
-
setCurrencyShortName
public void setCurrencyShortName(String currencyShortName)
-
isCurrencyShortNameSpecified
public boolean isCurrencyShortNameSpecified()
-
unsetCurrencyShortName
public void unsetCurrencyShortName()
-
getDeviceFingerprintId
public String getDeviceFingerprintId()
-
setDeviceFingerprintId
public void setDeviceFingerprintId(String deviceFingerprintId)
-
isDeviceFingerprintIdSpecified
public boolean isDeviceFingerprintIdSpecified()
-
unsetDeviceFingerprintId
public void unsetDeviceFingerprintId()
-
getId
public Long getId()
-
setId
public void setId(Long id)
-
isIdSpecified
public boolean isIdSpecified()
-
unsetId
public void unsetId()
-
getNotes
public String getNotes()
-
setNotes
public void setNotes(String notes)
-
isNotesSpecified
public boolean isNotesSpecified()
-
unsetNotes
public void unsetNotes()
-
getPayerAuthenticationEnrollmentReferenceId
public String getPayerAuthenticationEnrollmentReferenceId()
-
setPayerAuthenticationEnrollmentReferenceId
public void setPayerAuthenticationEnrollmentReferenceId(String payerAuthenticationEnrollmentReferenceId)
-
isPayerAuthenticationEnrollmentReferenceIdSpecified
public boolean isPayerAuthenticationEnrollmentReferenceIdSpecified()
-
unsetPayerAuthenticationEnrollmentReferenceId
public void unsetPayerAuthenticationEnrollmentReferenceId()
-
getPayerAuthenticationWebToken
public String getPayerAuthenticationWebToken()
-
setPayerAuthenticationWebToken
public void setPayerAuthenticationWebToken(String payerAuthenticationWebToken)
-
isPayerAuthenticationWebTokenSpecified
public boolean isPayerAuthenticationWebTokenSpecified()
-
unsetPayerAuthenticationWebToken
public void unsetPayerAuthenticationWebToken()
-
getPaymentRoleId
public Long getPaymentRoleId()
-
setPaymentRoleId
public void setPaymentRoleId(Long paymentRoleId)
-
isPaymentRoleIdSpecified
public boolean isPaymentRoleIdSpecified()
-
unsetPaymentRoleId
public void unsetPaymentRoleId()
-
getPaymentType
public String getPaymentType()
-
setPaymentType
public void setPaymentType(String paymentType)
-
isPaymentTypeSpecified
public boolean isPaymentTypeSpecified()
-
unsetPaymentType
public void unsetPaymentType()
-
getTicketId
public Long getTicketId()
-
setTicketId
public void setTicketId(Long ticketId)
-
isTicketIdSpecified
public boolean isTicketIdSpecified()
-
unsetTicketId
public void unsetTicketId()
-
getTicketAttachmentReferenceCount
public Long getTicketAttachmentReferenceCount()
-
setTicketAttachmentReferenceCount
public void setTicketAttachmentReferenceCount(Long ticketAttachmentReferenceCount)
-
-