com.softlayer.api.service.billing.payment.card.Transaction Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
package com.softlayer.api.service.billing.payment.card;
import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Account;
import com.softlayer.api.service.billing.Order;
import java.math.BigDecimal;
import java.util.GregorianCalendar;
/**
* The SoftLayer_Billing_Payment_Card_Transaction data type contains general information relating to attempted credit card transactions.
*
* @see SoftLayer_Billing_Payment_Card_Transaction
*/
@ApiType("SoftLayer_Billing_Payment_Card_Transaction")
public class Transaction extends com.softlayer.api.service.billing.payment.Transaction {
/**
* The account to which a transaction belongs.
*/
@ApiProperty
protected Account account;
public Account getAccount() {
return account;
}
public void setAccount(Account account) {
this.account = account;
}
@ApiProperty
protected Order order;
public Order getOrder() {
return order;
}
public void setOrder(Order order) {
this.order = order;
}
/**
* The account ID to which the credit card and billing information is associated with.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long accountId;
public Long getAccountId() {
return accountId;
}
public void setAccountId(Long accountId) {
accountIdSpecified = true;
this.accountId = accountId;
}
protected boolean accountIdSpecified;
public boolean isAccountIdSpecified() {
return accountIdSpecified;
}
public void unsetAccountId() {
accountId = null;
accountIdSpecified = false;
}
/**
* The total amount of the attempted transaction, represented in decimal format as US Dollars ($USD).
*/
@ApiProperty(canBeNullOrNotSet = true)
protected BigDecimal amount;
public BigDecimal getAmount() {
return amount;
}
public void setAmount(BigDecimal amount) {
amountSpecified = true;
this.amount = amount;
}
protected boolean amountSpecified;
public boolean isAmountSpecified() {
return amountSpecified;
}
public void unsetAmount() {
amount = null;
amountSpecified = false;
}
/**
* The physical street address. Reserve information such as "apartment #123" or "Suite 2" for line 1.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String billingAddressLine1;
public String getBillingAddressLine1() {
return billingAddressLine1;
}
public void setBillingAddressLine1(String billingAddressLine1) {
billingAddressLine1Specified = true;
this.billingAddressLine1 = billingAddressLine1;
}
protected boolean billingAddressLine1Specified;
public boolean isBillingAddressLine1Specified() {
return billingAddressLine1Specified;
}
public void unsetBillingAddressLine1() {
billingAddressLine1 = null;
billingAddressLine1Specified = false;
}
/**
* The second line in the address. Information such as suite number goes here.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String billingAddressLine2;
public String getBillingAddressLine2() {
return billingAddressLine2;
}
public void setBillingAddressLine2(String billingAddressLine2) {
billingAddressLine2Specified = true;
this.billingAddressLine2 = billingAddressLine2;
}
protected boolean billingAddressLine2Specified;
public boolean isBillingAddressLine2Specified() {
return billingAddressLine2Specified;
}
public void unsetBillingAddressLine2() {
billingAddressLine2 = null;
billingAddressLine2Specified = false;
}
/**
* The city in which a customer's account resides.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String billingCity;
public String getBillingCity() {
return billingCity;
}
public void setBillingCity(String billingCity) {
billingCitySpecified = true;
this.billingCity = billingCity;
}
protected boolean billingCitySpecified;
public boolean isBillingCitySpecified() {
return billingCitySpecified;
}
public void unsetBillingCity() {
billingCity = null;
billingCitySpecified = false;
}
/**
* The 2-character Country code for an account's address. (i.e. US)
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String billingCountryCode;
public String getBillingCountryCode() {
return billingCountryCode;
}
public void setBillingCountryCode(String billingCountryCode) {
billingCountryCodeSpecified = true;
this.billingCountryCode = billingCountryCode;
}
protected boolean billingCountryCodeSpecified;
public boolean isBillingCountryCodeSpecified() {
return billingCountryCodeSpecified;
}
public void unsetBillingCountryCode() {
billingCountryCode = null;
billingCountryCodeSpecified = false;
}
/**
* The email address associated with a customer account.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String billingEmail;
public String getBillingEmail() {
return billingEmail;
}
public void setBillingEmail(String billingEmail) {
billingEmailSpecified = true;
this.billingEmail = billingEmail;
}
protected boolean billingEmailSpecified;
public boolean isBillingEmailSpecified() {
return billingEmailSpecified;
}
public void unsetBillingEmail() {
billingEmail = null;
billingEmailSpecified = false;
}
/**
* the company name for an account.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String billingNameCompany;
public String getBillingNameCompany() {
return billingNameCompany;
}
public void setBillingNameCompany(String billingNameCompany) {
billingNameCompanySpecified = true;
this.billingNameCompany = billingNameCompany;
}
protected boolean billingNameCompanySpecified;
public boolean isBillingNameCompanySpecified() {
return billingNameCompanySpecified;
}
public void unsetBillingNameCompany() {
billingNameCompany = null;
billingNameCompanySpecified = false;
}
/**
* The first name of the customer account owner.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String billingNameFirst;
public String getBillingNameFirst() {
return billingNameFirst;
}
public void setBillingNameFirst(String billingNameFirst) {
billingNameFirstSpecified = true;
this.billingNameFirst = billingNameFirst;
}
protected boolean billingNameFirstSpecified;
public boolean isBillingNameFirstSpecified() {
return billingNameFirstSpecified;
}
public void unsetBillingNameFirst() {
billingNameFirst = null;
billingNameFirstSpecified = false;
}
/**
* The last name of the customer account owner.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String billingNameLast;
public String getBillingNameLast() {
return billingNameLast;
}
public void setBillingNameLast(String billingNameLast) {
billingNameLastSpecified = true;
this.billingNameLast = billingNameLast;
}
protected boolean billingNameLastSpecified;
public boolean isBillingNameLastSpecified() {
return billingNameLastSpecified;
}
public void unsetBillingNameLast() {
billingNameLast = null;
billingNameLastSpecified = false;
}
/**
* The fax number associated with a customer account.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String billingPhoneFax;
public String getBillingPhoneFax() {
return billingPhoneFax;
}
public void setBillingPhoneFax(String billingPhoneFax) {
billingPhoneFaxSpecified = true;
this.billingPhoneFax = billingPhoneFax;
}
protected boolean billingPhoneFaxSpecified;
public boolean isBillingPhoneFaxSpecified() {
return billingPhoneFaxSpecified;
}
public void unsetBillingPhoneFax() {
billingPhoneFax = null;
billingPhoneFaxSpecified = false;
}
/**
* The phone number associated with a customer account.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String billingPhoneVoice;
public String getBillingPhoneVoice() {
return billingPhoneVoice;
}
public void setBillingPhoneVoice(String billingPhoneVoice) {
billingPhoneVoiceSpecified = true;
this.billingPhoneVoice = billingPhoneVoice;
}
protected boolean billingPhoneVoiceSpecified;
public boolean isBillingPhoneVoiceSpecified() {
return billingPhoneVoiceSpecified;
}
public void unsetBillingPhoneVoice() {
billingPhoneVoice = null;
billingPhoneVoiceSpecified = false;
}
/**
* The Zip or Postal Code for the billing address on an account.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String billingPostalCode;
public String getBillingPostalCode() {
return billingPostalCode;
}
public void setBillingPostalCode(String billingPostalCode) {
billingPostalCodeSpecified = true;
this.billingPostalCode = billingPostalCode;
}
protected boolean billingPostalCodeSpecified;
public boolean isBillingPostalCodeSpecified() {
return billingPostalCodeSpecified;
}
public void unsetBillingPostalCode() {
billingPostalCode = null;
billingPostalCodeSpecified = false;
}
/**
* The State for the account.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String billingState;
public String getBillingState() {
return billingState;
}
public void setBillingState(String billingState) {
billingStateSpecified = true;
this.billingState = billingState;
}
protected boolean billingStateSpecified;
public boolean isBillingStateSpecified() {
return billingStateSpecified;
}
public void unsetBillingState() {
billingState = null;
billingStateSpecified = false;
}
/**
* The last 4 digits of a customer's credit card.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long cardAccountLast4;
public Long getCardAccountLast4() {
return cardAccountLast4;
}
public void setCardAccountLast4(Long cardAccountLast4) {
cardAccountLast4Specified = true;
this.cardAccountLast4 = cardAccountLast4;
}
protected boolean cardAccountLast4Specified;
public boolean isCardAccountLast4Specified() {
return cardAccountLast4Specified;
}
public void unsetCardAccountLast4() {
cardAccountLast4 = null;
cardAccountLast4Specified = false;
}
/**
* The month (MM) in which a customer's payment card will expire.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long cardExpirationMonth;
public Long getCardExpirationMonth() {
return cardExpirationMonth;
}
public void setCardExpirationMonth(Long cardExpirationMonth) {
cardExpirationMonthSpecified = true;
this.cardExpirationMonth = cardExpirationMonth;
}
protected boolean cardExpirationMonthSpecified;
public boolean isCardExpirationMonthSpecified() {
return cardExpirationMonthSpecified;
}
public void unsetCardExpirationMonth() {
cardExpirationMonth = null;
cardExpirationMonthSpecified = false;
}
/**
* The year (YYYY) in which a customer's payment card will expire.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long cardExpirationYear;
public Long getCardExpirationYear() {
return cardExpirationYear;
}
public void setCardExpirationYear(Long cardExpirationYear) {
cardExpirationYearSpecified = true;
this.cardExpirationYear = cardExpirationYear;
}
protected boolean cardExpirationYearSpecified;
public boolean isCardExpirationYearSpecified() {
return cardExpirationYearSpecified;
}
public void unsetCardExpirationYear() {
cardExpirationYear = null;
cardExpirationYearSpecified = false;
}
/**
* The type of payment issued (i.e. Visa, MasterCard, American Express).
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String cardType;
public String getCardType() {
return cardType;
}
public void setCardType(String cardType) {
cardTypeSpecified = true;
this.cardType = cardType;
}
protected boolean cardTypeSpecified;
public boolean isCardTypeSpecified() {
return cardTypeSpecified;
}
public void unsetCardType() {
cardType = null;
cardTypeSpecified = false;
}
/**
* The date that the transaction was attempted.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected GregorianCalendar createDate;
public GregorianCalendar getCreateDate() {
return createDate;
}
public void setCreateDate(GregorianCalendar createDate) {
createDateSpecified = true;
this.createDate = createDate;
}
protected boolean createDateSpecified;
public boolean isCreateDateSpecified() {
return createDateSpecified;
}
public void unsetCreateDate() {
createDate = null;
createDateSpecified = false;
}
/**
* The unique identifier for a single credit card transaction request.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long id;
public Long getId() {
return id;
}
public void setId(Long id) {
idSpecified = true;
this.id = id;
}
protected boolean idSpecified;
public boolean isIdSpecified() {
return idSpecified;
}
public void unsetId() {
id = null;
idSpecified = false;
}
/**
* Unique identifier of the invoice to which funds will be applied.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long invoiceId;
public Long getInvoiceId() {
return invoiceId;
}
public void setInvoiceId(Long invoiceId) {
invoiceIdSpecified = true;
this.invoiceId = invoiceId;
}
protected boolean invoiceIdSpecified;
public boolean isInvoiceIdSpecified() {
return invoiceIdSpecified;
}
public void unsetInvoiceId() {
invoiceId = null;
invoiceIdSpecified = false;
}
/**
* The date that the transaction was modified.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected GregorianCalendar modifyDate;
public GregorianCalendar getModifyDate() {
return modifyDate;
}
public void setModifyDate(GregorianCalendar modifyDate) {
modifyDateSpecified = true;
this.modifyDate = modifyDate;
}
protected boolean modifyDateSpecified;
public boolean isModifyDateSpecified() {
return modifyDateSpecified;
}
public void unsetModifyDate() {
modifyDate = null;
modifyDateSpecified = false;
}
/**
* The IP address from which the transaction originates.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String orderFromIpAddress;
public String getOrderFromIpAddress() {
return orderFromIpAddress;
}
public void setOrderFromIpAddress(String orderFromIpAddress) {
orderFromIpAddressSpecified = true;
this.orderFromIpAddress = orderFromIpAddress;
}
protected boolean orderFromIpAddressSpecified;
public boolean isOrderFromIpAddressSpecified() {
return orderFromIpAddressSpecified;
}
public void unsetOrderFromIpAddress() {
orderFromIpAddress = null;
orderFromIpAddressSpecified = false;
}
/**
* A code used by the financial institution to refer to the requested transaction.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String referenceCode;
public String getReferenceCode() {
return referenceCode;
}
public void setReferenceCode(String referenceCode) {
referenceCodeSpecified = true;
this.referenceCode = referenceCode;
}
protected boolean referenceCodeSpecified;
public boolean isReferenceCodeSpecified() {
return referenceCodeSpecified;
}
public void unsetReferenceCode() {
referenceCode = null;
referenceCodeSpecified = false;
}
/**
* The unique identifier of the request submitted to the financial institution.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String requestId;
public String getRequestId() {
return requestId;
}
public void setRequestId(String requestId) {
requestIdSpecified = true;
this.requestId = requestId;
}
protected boolean requestIdSpecified;
public boolean isRequestIdSpecified() {
return requestIdSpecified;
}
public void unsetRequestId() {
requestId = null;
requestIdSpecified = false;
}
/**
* The status code returned from the financial institution.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long returnStatus;
public Long getReturnStatus() {
return returnStatus;
}
public void setReturnStatus(Long returnStatus) {
returnStatusSpecified = true;
this.returnStatus = returnStatus;
}
protected boolean returnStatusSpecified;
public boolean isReturnStatusSpecified() {
return returnStatusSpecified;
}
public void unsetReturnStatus() {
returnStatus = null;
returnStatusSpecified = false;
}
/**
* A serialized, delimited string of the transaction request sent to the financial institution.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String serializedReply;
public String getSerializedReply() {
return serializedReply;
}
public void setSerializedReply(String serializedReply) {
serializedReplySpecified = true;
this.serializedReply = serializedReply;
}
protected boolean serializedReplySpecified;
public boolean isSerializedReplySpecified() {
return serializedReplySpecified;
}
public void unsetSerializedReply() {
serializedReply = null;
serializedReplySpecified = false;
}
/**
* A serialized, delimited string of the transaction request sent to the financial institution.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String serializedRequest;
public String getSerializedRequest() {
return serializedRequest;
}
public void setSerializedRequest(String serializedRequest) {
serializedRequestSpecified = true;
this.serializedRequest = serializedRequest;
}
protected boolean serializedRequestSpecified;
public boolean isSerializedRequestSpecified() {
return serializedRequestSpecified;
}
public void unsetSerializedRequest() {
serializedRequest = null;
serializedRequestSpecified = false;
}
public static class Mask extends com.softlayer.api.service.billing.payment.Transaction.Mask {
public com.softlayer.api.service.Account.Mask account() {
return withSubMask("account", com.softlayer.api.service.Account.Mask.class);
}
public com.softlayer.api.service.billing.Order.Mask order() {
return withSubMask("order", com.softlayer.api.service.billing.Order.Mask.class);
}
public Mask accountId() {
withLocalProperty("accountId");
return this;
}
public Mask amount() {
withLocalProperty("amount");
return this;
}
public Mask billingAddressLine1() {
withLocalProperty("billingAddressLine1");
return this;
}
public Mask billingAddressLine2() {
withLocalProperty("billingAddressLine2");
return this;
}
public Mask billingCity() {
withLocalProperty("billingCity");
return this;
}
public Mask billingCountryCode() {
withLocalProperty("billingCountryCode");
return this;
}
public Mask billingEmail() {
withLocalProperty("billingEmail");
return this;
}
public Mask billingNameCompany() {
withLocalProperty("billingNameCompany");
return this;
}
public Mask billingNameFirst() {
withLocalProperty("billingNameFirst");
return this;
}
public Mask billingNameLast() {
withLocalProperty("billingNameLast");
return this;
}
public Mask billingPhoneFax() {
withLocalProperty("billingPhoneFax");
return this;
}
public Mask billingPhoneVoice() {
withLocalProperty("billingPhoneVoice");
return this;
}
public Mask billingPostalCode() {
withLocalProperty("billingPostalCode");
return this;
}
public Mask billingState() {
withLocalProperty("billingState");
return this;
}
public Mask cardAccountLast4() {
withLocalProperty("cardAccountLast4");
return this;
}
public Mask cardExpirationMonth() {
withLocalProperty("cardExpirationMonth");
return this;
}
public Mask cardExpirationYear() {
withLocalProperty("cardExpirationYear");
return this;
}
public Mask cardType() {
withLocalProperty("cardType");
return this;
}
public Mask createDate() {
withLocalProperty("createDate");
return this;
}
public Mask id() {
withLocalProperty("id");
return this;
}
public Mask invoiceId() {
withLocalProperty("invoiceId");
return this;
}
public Mask modifyDate() {
withLocalProperty("modifyDate");
return this;
}
public Mask orderFromIpAddress() {
withLocalProperty("orderFromIpAddress");
return this;
}
public Mask referenceCode() {
withLocalProperty("referenceCode");
return this;
}
public Mask requestId() {
withLocalProperty("requestId");
return this;
}
public Mask returnStatus() {
withLocalProperty("returnStatus");
return this;
}
public Mask serializedReply() {
withLocalProperty("serializedReply");
return this;
}
public Mask serializedRequest() {
withLocalProperty("serializedRequest");
return this;
}
}
}