com.softlayer.api.service.billing.payment.card.ManualPayment 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
API client for accessing the SoftLayer API
The newest version!
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.Entity;
import com.softlayer.api.service.billing.payment.paypal.Transaction;
import com.softlayer.api.service.ticket.Attachment;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.List;

/**
 * The SoftLayer_Billing_Payment_Card_ManualPayment data type contains general information related to requesting a manual payment. This supports enablement of 3D Secure via Cardinal Cruise implementation that allows for credit card authentication and is currently limited to specified merchants. 
 *
 * @see SoftLayer_Billing_Payment_Card_ManualPayment
 */
@ApiType("SoftLayer_Billing_Payment_Card_ManualPayment")
public class ManualPayment extends Entity {

    @ApiProperty
    protected Account account;

    public Account getAccount() {
        return account;
    }

    public void setAccount(Account account) {
        this.account = account;
    }

    /**
     * This is the credit card transaction data tied to a credit card manual payment.
     */
    @ApiProperty
    protected com.softlayer.api.service.billing.payment.card.Transaction authorizedCreditCardTransaction;

    public com.softlayer.api.service.billing.payment.card.Transaction getAuthorizedCreditCardTransaction() {
        return authorizedCreditCardTransaction;
    }

    public void setAuthorizedCreditCardTransaction(com.softlayer.api.service.billing.payment.card.Transaction authorizedCreditCardTransaction) {
        this.authorizedCreditCardTransaction = authorizedCreditCardTransaction;
    }

    /**
     * This is the PayPal transaction data tied to a PayPal manual payment.
     */
    @ApiProperty
    protected Transaction authorizedPayPalTransaction;

    public Transaction getAuthorizedPayPalTransaction() {
        return authorizedPayPalTransaction;
    }

    public void setAuthorizedPayPalTransaction(Transaction authorizedPayPalTransaction) {
        this.authorizedPayPalTransaction = authorizedPayPalTransaction;
    }

    /**
     * The SoftLayer_Billing_Payment_Card_Transaction tied to the capture performed as part of this manual payment. This will only exist if the manual payment was performed with a credit card.
     */
    @ApiProperty
    protected com.softlayer.api.service.billing.payment.card.Transaction captureCreditCardTransaction;

    public com.softlayer.api.service.billing.payment.card.Transaction getCaptureCreditCardTransaction() {
        return captureCreditCardTransaction;
    }

    public void setCaptureCreditCardTransaction(com.softlayer.api.service.billing.payment.card.Transaction captureCreditCardTransaction) {
        this.captureCreditCardTransaction = captureCreditCardTransaction;
    }

    /**
     * The SoftLayer_Billing_Payment_PayPal_Transaction tied to the capture performed as part of this manual payment. This will only exist if the manual payment was performed via PayPal.
     */
    @ApiProperty
    protected Transaction capturePayPalTransaction;

    public Transaction getCapturePayPalTransaction() {
        return capturePayPalTransaction;
    }

    public void setCapturePayPalTransaction(Transaction capturePayPalTransaction) {
        this.capturePayPalTransaction = capturePayPalTransaction;
    }

    /**
     * These are tickets tied to a credit card manual payment.
     */
    @ApiProperty
    protected List ticketAttachmentReferences;

    public List getTicketAttachmentReferences() {
        if (ticketAttachmentReferences == null) {
            ticketAttachmentReferences = new ArrayList();
        }
        return ticketAttachmentReferences;
    }

    /**
     * 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 unique identifier of an attempted credit card transaction.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long authorizedCreditCardTransactionId;

    public Long getAuthorizedCreditCardTransactionId() {
        return authorizedCreditCardTransactionId;
    }

    public void setAuthorizedCreditCardTransactionId(Long authorizedCreditCardTransactionId) {
        authorizedCreditCardTransactionIdSpecified = true;
        this.authorizedCreditCardTransactionId = authorizedCreditCardTransactionId;
    }

    protected boolean authorizedCreditCardTransactionIdSpecified;

    public boolean isAuthorizedCreditCardTransactionIdSpecified() {
        return authorizedCreditCardTransactionIdSpecified;
    }

    public void unsetAuthorizedCreditCardTransactionId() {
        authorizedCreditCardTransactionId = null;
        authorizedCreditCardTransactionIdSpecified = false;
    }

    /**
     * The unique identifier of an attempted PayPal transaction.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long authorizedPayPalTransactionId;

    public Long getAuthorizedPayPalTransactionId() {
        return authorizedPayPalTransactionId;
    }

    public void setAuthorizedPayPalTransactionId(Long authorizedPayPalTransactionId) {
        authorizedPayPalTransactionIdSpecified = true;
        this.authorizedPayPalTransactionId = authorizedPayPalTransactionId;
    }

    protected boolean authorizedPayPalTransactionIdSpecified;

    public boolean isAuthorizedPayPalTransactionIdSpecified() {
        return authorizedPayPalTransactionIdSpecified;
    }

    public void unsetAuthorizedPayPalTransactionId() {
        authorizedPayPalTransactionId = null;
        authorizedPayPalTransactionIdSpecified = 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 cancel URL is the page to which PayPal redirects if payment is not approved.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String cancelUrl;

    public String getCancelUrl() {
        return cancelUrl;
    }

    public void setCancelUrl(String cancelUrl) {
        cancelUrlSpecified = true;
        this.cancelUrl = cancelUrl;
    }

    protected boolean cancelUrlSpecified;

    public boolean isCancelUrlSpecified() {
        return cancelUrlSpecified;
    }

    public void unsetCancelUrl() {
        cancelUrl = null;
        cancelUrlSpecified = false;
    }

    /**
     * A hash value of the credit card number.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String cardAccountHash;

    public String getCardAccountHash() {
        return cardAccountHash;
    }

    public void setCardAccountHash(String cardAccountHash) {
        cardAccountHashSpecified = true;
        this.cardAccountHash = cardAccountHash;
    }

    protected boolean cardAccountHashSpecified;

    public boolean isCardAccountHashSpecified() {
        return cardAccountHashSpecified;
    }

    public void unsetCardAccountHash() {
        cardAccountHash = null;
        cardAccountHashSpecified = false;
    }

    /**
     * The last 4 digits of a customer's credit card.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String cardAccountLast4;

    public String getCardAccountLast4() {
        return cardAccountLast4;
    }

    public void setCardAccountLast4(String cardAccountLast4) {
        cardAccountLast4Specified = true;
        this.cardAccountLast4 = cardAccountLast4;
    }

    protected boolean cardAccountLast4Specified;

    public boolean isCardAccountLast4Specified() {
        return cardAccountLast4Specified;
    }

    public void unsetCardAccountLast4() {
        cardAccountLast4 = null;
        cardAccountLast4Specified = false;
    }

    /**
     * The card number submitted in the change request.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String cardAccountNumber;

    public String getCardAccountNumber() {
        return cardAccountNumber;
    }

    public void setCardAccountNumber(String cardAccountNumber) {
        cardAccountNumberSpecified = true;
        this.cardAccountNumber = cardAccountNumber;
    }

    protected boolean cardAccountNumberSpecified;

    public boolean isCardAccountNumberSpecified() {
        return cardAccountNumberSpecified;
    }

    public void unsetCardAccountNumber() {
        cardAccountNumber = null;
        cardAccountNumberSpecified = false;
    }

    /**
     * The month (MM) in which a customer's payment card will expire.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String cardExpirationMonth;

    public String getCardExpirationMonth() {
        return cardExpirationMonth;
    }

    public void setCardExpirationMonth(String 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 String cardExpirationYear;

    public String getCardExpirationYear() {
        return cardExpirationYear;
    }

    public void setCardExpirationYear(String cardExpirationYear) {
        cardExpirationYearSpecified = true;
        this.cardExpirationYear = cardExpirationYear;
    }

    protected boolean cardExpirationYearSpecified;

    public boolean isCardExpirationYearSpecified() {
        return cardExpirationYearSpecified;
    }

    public void unsetCardExpirationYear() {
        cardExpirationYear = null;
        cardExpirationYearSpecified = false;
    }

    /**
     * The method key of the type payment issued (Visa - 001, Mastercard - 002, American Express - 003, Discover - 004, PayPal - paypal).
     */
    @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 credit card verification number submitted in the change request.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String creditCardVerificationNumber;

    public String getCreditCardVerificationNumber() {
        return creditCardVerificationNumber;
    }

    public void setCreditCardVerificationNumber(String creditCardVerificationNumber) {
        creditCardVerificationNumberSpecified = true;
        this.creditCardVerificationNumber = creditCardVerificationNumber;
    }

    protected boolean creditCardVerificationNumberSpecified;

    public boolean isCreditCardVerificationNumberSpecified() {
        return creditCardVerificationNumberSpecified;
    }

    public void unsetCreditCardVerificationNumber() {
        creditCardVerificationNumber = null;
        creditCardVerificationNumberSpecified = false;
    }

    /**
     * Describes the currency selected for payment
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String currencyShortName;

    public String getCurrencyShortName() {
        return currencyShortName;
    }

    public void setCurrencyShortName(String currencyShortName) {
        currencyShortNameSpecified = true;
        this.currencyShortName = currencyShortName;
    }

    protected boolean currencyShortNameSpecified;

    public boolean isCurrencyShortNameSpecified() {
        return currencyShortNameSpecified;
    }

    public void unsetCurrencyShortName() {
        currencyShortName = null;
        currencyShortNameSpecified = false;
    }

    /**
     * Device Fingerprint Identifier - Used internally and can safely be ignored.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String deviceFingerprintId;

    public String getDeviceFingerprintId() {
        return deviceFingerprintId;
    }

    public void setDeviceFingerprintId(String deviceFingerprintId) {
        deviceFingerprintIdSpecified = true;
        this.deviceFingerprintId = deviceFingerprintId;
    }

    protected boolean deviceFingerprintIdSpecified;

    public boolean isDeviceFingerprintIdSpecified() {
        return deviceFingerprintIdSpecified;
    }

    public void unsetDeviceFingerprintId() {
        deviceFingerprintId = null;
        deviceFingerprintIdSpecified = false;
    }

    /**
     * The IP address from which the transaction originates.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String fromIpAddress;

    public String getFromIpAddress() {
        return fromIpAddress;
    }

    public void setFromIpAddress(String fromIpAddress) {
        fromIpAddressSpecified = true;
        this.fromIpAddress = fromIpAddress;
    }

    protected boolean fromIpAddressSpecified;

    public boolean isFromIpAddressSpecified() {
        return fromIpAddressSpecified;
    }

    public void unsetFromIpAddress() {
        fromIpAddress = null;
        fromIpAddressSpecified = false;
    }

    /**
     * The unique identifier for a single manual payment 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;
    }

    /**
     * Notes generated as a result of the payment request.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String notes;

    public String getNotes() {
        return notes;
    }

    public void setNotes(String notes) {
        notesSpecified = true;
        this.notes = notes;
    }

    protected boolean notesSpecified;

    public boolean isNotesSpecified() {
        return notesSpecified;
    }

    public void unsetNotes() {
        notes = null;
        notesSpecified = false;
    }

    /**
     * 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. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String payerAuthenticationEnrollmentReferenceId;

    public String getPayerAuthenticationEnrollmentReferenceId() {
        return payerAuthenticationEnrollmentReferenceId;
    }

    public void setPayerAuthenticationEnrollmentReferenceId(String payerAuthenticationEnrollmentReferenceId) {
        payerAuthenticationEnrollmentReferenceIdSpecified = true;
        this.payerAuthenticationEnrollmentReferenceId = payerAuthenticationEnrollmentReferenceId;
    }

    protected boolean payerAuthenticationEnrollmentReferenceIdSpecified;

    public boolean isPayerAuthenticationEnrollmentReferenceIdSpecified() {
        return payerAuthenticationEnrollmentReferenceIdSpecified;
    }

    public void unsetPayerAuthenticationEnrollmentReferenceId() {
        payerAuthenticationEnrollmentReferenceId = null;
        payerAuthenticationEnrollmentReferenceIdSpecified = false;
    }

    /**
     * "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. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String payerAuthenticationWebToken;

    public String getPayerAuthenticationWebToken() {
        return payerAuthenticationWebToken;
    }

    public void setPayerAuthenticationWebToken(String payerAuthenticationWebToken) {
        payerAuthenticationWebTokenSpecified = true;
        this.payerAuthenticationWebToken = payerAuthenticationWebToken;
    }

    protected boolean payerAuthenticationWebTokenSpecified;

    public boolean isPayerAuthenticationWebTokenSpecified() {
        return payerAuthenticationWebTokenSpecified;
    }

    public void unsetPayerAuthenticationWebToken() {
        payerAuthenticationWebToken = null;
        payerAuthenticationWebTokenSpecified = false;
    }

    /**
     * The description of the type of payment sent in a change transaction.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String paymentType;

    public String getPaymentType() {
        return paymentType;
    }

    public void setPaymentType(String paymentType) {
        paymentTypeSpecified = true;
        this.paymentType = paymentType;
    }

    protected boolean paymentTypeSpecified;

    public boolean isPaymentTypeSpecified() {
        return paymentTypeSpecified;
    }

    public void unsetPaymentType() {
        paymentType = null;
        paymentTypeSpecified = false;
    }

    /**
     * The return URL is the page to which PayPal redirects after payment is approved.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String returnUrl;

    public String getReturnUrl() {
        return returnUrl;
    }

    public void setReturnUrl(String returnUrl) {
        returnUrlSpecified = true;
        this.returnUrl = returnUrl;
    }

    protected boolean returnUrlSpecified;

    public boolean isReturnUrlSpecified() {
        return returnUrlSpecified;
    }

    public void unsetReturnUrl() {
        returnUrl = null;
        returnUrlSpecified = false;
    }

    /**
     * Describes the type of manual payment (PAYPAL or CREDIT_CARD).
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String type;

    public String getType() {
        return type;
    }

    public void setType(String type) {
        typeSpecified = true;
        this.type = type;
    }

    protected boolean typeSpecified;

    public boolean isTypeSpecified() {
        return typeSpecified;
    }

    public void unsetType() {
        type = null;
        typeSpecified = false;
    }

    /**
     * A count of these are tickets tied to a credit card manual payment.
     */
    @ApiProperty
    protected Long ticketAttachmentReferenceCount;

    public Long getTicketAttachmentReferenceCount() {
        return ticketAttachmentReferenceCount;
    }

    public void setTicketAttachmentReferenceCount(Long ticketAttachmentReferenceCount) {
        this.ticketAttachmentReferenceCount = ticketAttachmentReferenceCount;
    }

    public static class Mask extends com.softlayer.api.service.Entity.Mask {

        public com.softlayer.api.service.Account.Mask account() {
            return withSubMask("account", com.softlayer.api.service.Account.Mask.class);
        }

        public Transaction.Mask authorizedCreditCardTransaction() {
            return withSubMask("authorizedCreditCardTransaction", Transaction.Mask.class);
        }

        public com.softlayer.api.service.billing.payment.paypal.Transaction.Mask authorizedPayPalTransaction() {
            return withSubMask("authorizedPayPalTransaction", com.softlayer.api.service.billing.payment.paypal.Transaction.Mask.class);
        }

        public Transaction.Mask captureCreditCardTransaction() {
            return withSubMask("captureCreditCardTransaction", Transaction.Mask.class);
        }

        public com.softlayer.api.service.billing.payment.paypal.Transaction.Mask capturePayPalTransaction() {
            return withSubMask("capturePayPalTransaction", com.softlayer.api.service.billing.payment.paypal.Transaction.Mask.class);
        }

        public com.softlayer.api.service.ticket.Attachment.Mask ticketAttachmentReferences() {
            return withSubMask("ticketAttachmentReferences", com.softlayer.api.service.ticket.Attachment.Mask.class);
        }

        public Mask accountId() {
            withLocalProperty("accountId");
            return this;
        }

        public Mask amount() {
            withLocalProperty("amount");
            return this;
        }

        public Mask authorizedCreditCardTransactionId() {
            withLocalProperty("authorizedCreditCardTransactionId");
            return this;
        }

        public Mask authorizedPayPalTransactionId() {
            withLocalProperty("authorizedPayPalTransactionId");
            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 cancelUrl() {
            withLocalProperty("cancelUrl");
            return this;
        }

        public Mask cardAccountHash() {
            withLocalProperty("cardAccountHash");
            return this;
        }

        public Mask cardAccountLast4() {
            withLocalProperty("cardAccountLast4");
            return this;
        }

        public Mask cardAccountNumber() {
            withLocalProperty("cardAccountNumber");
            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 creditCardVerificationNumber() {
            withLocalProperty("creditCardVerificationNumber");
            return this;
        }

        public Mask currencyShortName() {
            withLocalProperty("currencyShortName");
            return this;
        }

        public Mask deviceFingerprintId() {
            withLocalProperty("deviceFingerprintId");
            return this;
        }

        public Mask fromIpAddress() {
            withLocalProperty("fromIpAddress");
            return this;
        }

        public Mask id() {
            withLocalProperty("id");
            return this;
        }

        public Mask notes() {
            withLocalProperty("notes");
            return this;
        }

        public Mask payerAuthenticationEnrollmentReferenceId() {
            withLocalProperty("payerAuthenticationEnrollmentReferenceId");
            return this;
        }

        public Mask payerAuthenticationWebToken() {
            withLocalProperty("payerAuthenticationWebToken");
            return this;
        }

        public Mask paymentType() {
            withLocalProperty("paymentType");
            return this;
        }

        public Mask returnUrl() {
            withLocalProperty("returnUrl");
            return this;
        }

        public Mask type() {
            withLocalProperty("type");
            return this;
        }

        public Mask ticketAttachmentReferenceCount() {
            withLocalProperty("ticketAttachmentReferenceCount");
            return this;
        }

    }

}