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 Details
-
account
-
authorizedCreditCardTransaction
The SoftLayer_Billing_Payment_Card_Transaction tied to the authorization performed as part of this change request. -
captureCreditCardTransaction
The SoftLayer_Billing_Payment_Card_Transaction tied to the capture of funds performed as part of this change request. -
ticketAttachmentReferences
These are tickets tied to a credit card change request. -
accountId
The account ID to which the credit card and billing information is associated with. -
accountIdSpecified
protected boolean accountIdSpecified -
amount
The total amount of the attempted transaction, represented in decimal format as US Dollars ($USD). -
amountSpecified
protected boolean amountSpecified -
billingAddressLine1
The physical street address. Reserve information such as "apartment #123" or "Suite 2" for line 1. -
billingAddressLine1Specified
protected boolean billingAddressLine1Specified -
billingAddressLine2
The second line in the address. Information such as suite number goes here. -
billingAddressLine2Specified
protected boolean billingAddressLine2Specified -
billingCity
The city in which a customer's account resides. -
billingCitySpecified
protected boolean billingCitySpecified -
billingCountryCode
The 2-character Country code for an account's address. (i.e. US) -
billingCountryCodeSpecified
protected boolean billingCountryCodeSpecified -
billingEmail
The email address associated with a customer account. -
billingEmailSpecified
protected boolean billingEmailSpecified -
billingNameCompany
the company name for an account. -
billingNameCompanySpecified
protected boolean billingNameCompanySpecified -
billingNameFirst
The first name of the customer account owner. -
billingNameFirstSpecified
protected boolean billingNameFirstSpecified -
billingNameLast
The last name of the customer account owner -
billingNameLastSpecified
protected boolean billingNameLastSpecified -
billingPhoneFax
The fax number associated with a customer account. -
billingPhoneFaxSpecified
protected boolean billingPhoneFaxSpecified -
billingPhoneVoice
The phone number associated with a customer account. -
billingPhoneVoiceSpecified
protected boolean billingPhoneVoiceSpecified -
billingPostalCode
The Zip or Postal Code for the billing address on an account. -
billingPostalCodeSpecified
protected boolean billingPostalCodeSpecified -
billingState
The State for the account. -
billingStateSpecified
protected boolean billingStateSpecified -
cardAccountLast4
The last 4 digits of a customer's credit card. -
cardAccountLast4Specified
protected boolean cardAccountLast4Specified -
cardAccountNumber
The card number submitted in the change request. -
cardAccountNumberSpecified
protected boolean cardAccountNumberSpecified -
cardExpirationMonth
The month (MM) in which a customer's payment card will expire. -
cardExpirationMonthSpecified
protected boolean cardExpirationMonthSpecified -
cardExpirationYear
The year (YYYY) in which a customer's payment card will expire. -
cardExpirationYearSpecified
protected boolean cardExpirationYearSpecified -
cardNickname
-
cardNicknameSpecified
protected boolean cardNicknameSpecified -
cardType
The type of payment card a customer has. (i.e. Visa, MasterCard, American Express). -
cardTypeSpecified
protected boolean cardTypeSpecified -
creditCardVerificationNumber
The credit card verification number submitted in the change request. -
creditCardVerificationNumberSpecified
protected boolean creditCardVerificationNumberSpecified -
currencyShortName
Describes the currency selected for payment -
currencyShortNameSpecified
protected boolean currencyShortNameSpecified -
deviceFingerprintId
Device Fingerprint Identifier - Used internally and can safely be ignored. -
deviceFingerprintIdSpecified
protected boolean deviceFingerprintIdSpecified -
id
The unique identifier for a single change request. -
idSpecified
protected boolean idSpecified -
notes
the notes stored about a customer's payment card. -
notesSpecified
protected boolean notesSpecified -
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
"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
-
paymentRoleIdSpecified
protected boolean paymentRoleIdSpecified -
paymentType
The description of the type of payment sent in a change transaction. -
paymentTypeSpecified
protected boolean paymentTypeSpecified -
ticketId
Unique identifier for a ticket discussing the switch between payment methods. -
ticketIdSpecified
protected boolean ticketIdSpecified -
ticketAttachmentReferenceCount
A count of these are tickets tied to a credit card change request.
-
-
Constructor Details
-
ChangeRequest
public ChangeRequest()
-
-
Method Details
-
getAccount
-
setAccount
-
getAuthorizedCreditCardTransaction
-
setAuthorizedCreditCardTransaction
-
getCaptureCreditCardTransaction
-
setCaptureCreditCardTransaction
-
getTicketAttachmentReferences
-
getAccountId
-
setAccountId
-
isAccountIdSpecified
public boolean isAccountIdSpecified() -
unsetAccountId
public void unsetAccountId() -
getAmount
-
setAmount
-
isAmountSpecified
public boolean isAmountSpecified() -
unsetAmount
public void unsetAmount() -
getBillingAddressLine1
-
setBillingAddressLine1
-
isBillingAddressLine1Specified
public boolean isBillingAddressLine1Specified() -
unsetBillingAddressLine1
public void unsetBillingAddressLine1() -
getBillingAddressLine2
-
setBillingAddressLine2
-
isBillingAddressLine2Specified
public boolean isBillingAddressLine2Specified() -
unsetBillingAddressLine2
public void unsetBillingAddressLine2() -
getBillingCity
-
setBillingCity
-
isBillingCitySpecified
public boolean isBillingCitySpecified() -
unsetBillingCity
public void unsetBillingCity() -
getBillingCountryCode
-
setBillingCountryCode
-
isBillingCountryCodeSpecified
public boolean isBillingCountryCodeSpecified() -
unsetBillingCountryCode
public void unsetBillingCountryCode() -
getBillingEmail
-
setBillingEmail
-
isBillingEmailSpecified
public boolean isBillingEmailSpecified() -
unsetBillingEmail
public void unsetBillingEmail() -
getBillingNameCompany
-
setBillingNameCompany
-
isBillingNameCompanySpecified
public boolean isBillingNameCompanySpecified() -
unsetBillingNameCompany
public void unsetBillingNameCompany() -
getBillingNameFirst
-
setBillingNameFirst
-
isBillingNameFirstSpecified
public boolean isBillingNameFirstSpecified() -
unsetBillingNameFirst
public void unsetBillingNameFirst() -
getBillingNameLast
-
setBillingNameLast
-
isBillingNameLastSpecified
public boolean isBillingNameLastSpecified() -
unsetBillingNameLast
public void unsetBillingNameLast() -
getBillingPhoneFax
-
setBillingPhoneFax
-
isBillingPhoneFaxSpecified
public boolean isBillingPhoneFaxSpecified() -
unsetBillingPhoneFax
public void unsetBillingPhoneFax() -
getBillingPhoneVoice
-
setBillingPhoneVoice
-
isBillingPhoneVoiceSpecified
public boolean isBillingPhoneVoiceSpecified() -
unsetBillingPhoneVoice
public void unsetBillingPhoneVoice() -
getBillingPostalCode
-
setBillingPostalCode
-
isBillingPostalCodeSpecified
public boolean isBillingPostalCodeSpecified() -
unsetBillingPostalCode
public void unsetBillingPostalCode() -
getBillingState
-
setBillingState
-
isBillingStateSpecified
public boolean isBillingStateSpecified() -
unsetBillingState
public void unsetBillingState() -
getCardAccountLast4
-
setCardAccountLast4
-
isCardAccountLast4Specified
public boolean isCardAccountLast4Specified() -
unsetCardAccountLast4
public void unsetCardAccountLast4() -
getCardAccountNumber
-
setCardAccountNumber
-
isCardAccountNumberSpecified
public boolean isCardAccountNumberSpecified() -
unsetCardAccountNumber
public void unsetCardAccountNumber() -
getCardExpirationMonth
-
setCardExpirationMonth
-
isCardExpirationMonthSpecified
public boolean isCardExpirationMonthSpecified() -
unsetCardExpirationMonth
public void unsetCardExpirationMonth() -
getCardExpirationYear
-
setCardExpirationYear
-
isCardExpirationYearSpecified
public boolean isCardExpirationYearSpecified() -
unsetCardExpirationYear
public void unsetCardExpirationYear() -
getCardNickname
-
setCardNickname
-
isCardNicknameSpecified
public boolean isCardNicknameSpecified() -
unsetCardNickname
public void unsetCardNickname() -
getCardType
-
setCardType
-
isCardTypeSpecified
public boolean isCardTypeSpecified() -
unsetCardType
public void unsetCardType() -
getCreditCardVerificationNumber
-
setCreditCardVerificationNumber
-
isCreditCardVerificationNumberSpecified
public boolean isCreditCardVerificationNumberSpecified() -
unsetCreditCardVerificationNumber
public void unsetCreditCardVerificationNumber() -
getCurrencyShortName
-
setCurrencyShortName
-
isCurrencyShortNameSpecified
public boolean isCurrencyShortNameSpecified() -
unsetCurrencyShortName
public void unsetCurrencyShortName() -
getDeviceFingerprintId
-
setDeviceFingerprintId
-
isDeviceFingerprintIdSpecified
public boolean isDeviceFingerprintIdSpecified() -
unsetDeviceFingerprintId
public void unsetDeviceFingerprintId() -
getId
-
setId
-
isIdSpecified
public boolean isIdSpecified() -
unsetId
public void unsetId() -
getNotes
-
setNotes
-
isNotesSpecified
public boolean isNotesSpecified() -
unsetNotes
public void unsetNotes() -
getPayerAuthenticationEnrollmentReferenceId
-
setPayerAuthenticationEnrollmentReferenceId
public void setPayerAuthenticationEnrollmentReferenceId(String payerAuthenticationEnrollmentReferenceId) -
isPayerAuthenticationEnrollmentReferenceIdSpecified
public boolean isPayerAuthenticationEnrollmentReferenceIdSpecified() -
unsetPayerAuthenticationEnrollmentReferenceId
public void unsetPayerAuthenticationEnrollmentReferenceId() -
getPayerAuthenticationWebToken
-
setPayerAuthenticationWebToken
-
isPayerAuthenticationWebTokenSpecified
public boolean isPayerAuthenticationWebTokenSpecified() -
unsetPayerAuthenticationWebToken
public void unsetPayerAuthenticationWebToken() -
getPaymentRoleId
-
setPaymentRoleId
-
isPaymentRoleIdSpecified
public boolean isPaymentRoleIdSpecified() -
unsetPaymentRoleId
public void unsetPaymentRoleId() -
getPaymentType
-
setPaymentType
-
isPaymentTypeSpecified
public boolean isPaymentTypeSpecified() -
unsetPaymentType
public void unsetPaymentType() -
getTicketId
-
setTicketId
-
isTicketIdSpecified
public boolean isTicketIdSpecified() -
unsetTicketId
public void unsetTicketId() -
getTicketAttachmentReferenceCount
-
setTicketAttachmentReferenceCount
-