Package com.softlayer.api.service.billing.payment.card

Class ManualPayment

java.lang.Object
com.softlayer.api.Type
com.softlayer.api.service.Entity
com.softlayer.api.service.billing.payment.card.ManualPayment
@ApiType("SoftLayer_Billing_Payment_Card_ManualPayment")
public class ManualPayment
extends Entity
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 Also:
SoftLayer_Billing_Payment_Card_ManualPayment

  • Field Details

    • account

      @ApiProperty protected Account account

    • authorizedCreditCardTransaction

      @ApiProperty protected Transaction authorizedCreditCardTransaction
      This is the credit card transaction data tied to a credit card manual payment.

    • authorizedPayPalTransaction

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

    • captureCreditCardTransaction

      @ApiProperty protected Transaction captureCreditCardTransaction
      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.

    • capturePayPalTransaction

      @ApiProperty protected Transaction capturePayPalTransaction
      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.

    • ticketAttachmentReferences

      @ApiProperty protected List<Attachment> ticketAttachmentReferences
      These are tickets tied to a credit card manual payment.

    • 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

    • authorizedCreditCardTransactionId

      @ApiProperty(canBeNullOrNotSet=true) protected Long authorizedCreditCardTransactionId
      The unique identifier of an attempted credit card transaction.

    • authorizedCreditCardTransactionIdSpecified

      protected boolean authorizedCreditCardTransactionIdSpecified

    • authorizedPayPalTransactionId

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

    • authorizedPayPalTransactionIdSpecified

      protected boolean authorizedPayPalTransactionIdSpecified

    • 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

    • cancelUrl

      @ApiProperty(canBeNullOrNotSet=true) protected String cancelUrl
      The cancel URL is the page to which PayPal redirects if payment is not approved.

    • cancelUrlSpecified

      protected boolean cancelUrlSpecified

    • cardAccountHash

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

    • cardAccountHashSpecified

      protected boolean cardAccountHashSpecified

    • 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

    • cardType

      @ApiProperty(canBeNullOrNotSet=true) protected String cardType
      The method key of the type payment issued (Visa - 001, Mastercard - 002, American Express - 003, Discover - 004, PayPal - paypal).

    • 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

    • fromIpAddress

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

    • fromIpAddressSpecified

      protected boolean fromIpAddressSpecified

    • id

      @ApiProperty(canBeNullOrNotSet=true) protected Long id
      The unique identifier for a single manual payment request.

    • idSpecified

      protected boolean idSpecified

    • notes

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

    • 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

    • paymentType

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

    • paymentTypeSpecified

      protected boolean paymentTypeSpecified

    • returnUrl

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

    • returnUrlSpecified

      protected boolean returnUrlSpecified

    • type

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

    • typeSpecified

      protected boolean typeSpecified

    • ticketAttachmentReferenceCount

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

  • Constructor Details

    • ManualPayment

      public ManualPayment()

  • Method Details

    • getAccount

      public Account getAccount()

    • setAccount

      public void setAccount​(Account account)

    • getAuthorizedCreditCardTransaction

      public Transaction getAuthorizedCreditCardTransaction()

    • setAuthorizedCreditCardTransaction

      public void setAuthorizedCreditCardTransaction​(Transaction authorizedCreditCardTransaction)

    • getAuthorizedPayPalTransaction

      public Transaction getAuthorizedPayPalTransaction()

    • setAuthorizedPayPalTransaction

      public void setAuthorizedPayPalTransaction​(Transaction authorizedPayPalTransaction)

    • getCaptureCreditCardTransaction

      public Transaction getCaptureCreditCardTransaction()

    • setCaptureCreditCardTransaction

      public void setCaptureCreditCardTransaction​(Transaction captureCreditCardTransaction)

    • getCapturePayPalTransaction

      public Transaction getCapturePayPalTransaction()

    • setCapturePayPalTransaction

      public void setCapturePayPalTransaction​(Transaction capturePayPalTransaction)

    • 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()

    • getAuthorizedCreditCardTransactionId

      public Long getAuthorizedCreditCardTransactionId()

    • setAuthorizedCreditCardTransactionId

      public void setAuthorizedCreditCardTransactionId​(Long authorizedCreditCardTransactionId)

    • isAuthorizedCreditCardTransactionIdSpecified

      public boolean isAuthorizedCreditCardTransactionIdSpecified()

    • unsetAuthorizedCreditCardTransactionId

      public void unsetAuthorizedCreditCardTransactionId()

    • getAuthorizedPayPalTransactionId

      public Long getAuthorizedPayPalTransactionId()

    • setAuthorizedPayPalTransactionId

      public void setAuthorizedPayPalTransactionId​(Long authorizedPayPalTransactionId)

    • isAuthorizedPayPalTransactionIdSpecified

      public boolean isAuthorizedPayPalTransactionIdSpecified()

    • unsetAuthorizedPayPalTransactionId

      public void unsetAuthorizedPayPalTransactionId()

    • 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()

    • getCancelUrl

      public String getCancelUrl()

    • setCancelUrl

      public void setCancelUrl​(String cancelUrl)

    • isCancelUrlSpecified

      public boolean isCancelUrlSpecified()

    • unsetCancelUrl

      public void unsetCancelUrl()

    • getCardAccountHash

      public String getCardAccountHash()

    • setCardAccountHash

      public void setCardAccountHash​(String cardAccountHash)

    • isCardAccountHashSpecified

      public boolean isCardAccountHashSpecified()

    • unsetCardAccountHash

      public void unsetCardAccountHash()

    • 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()

    • 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()

    • getFromIpAddress

      public String getFromIpAddress()

    • setFromIpAddress

      public void setFromIpAddress​(String fromIpAddress)

    • isFromIpAddressSpecified

      public boolean isFromIpAddressSpecified()

    • unsetFromIpAddress

      public void unsetFromIpAddress()

    • 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()

    • getPaymentType

      public String getPaymentType()

    • setPaymentType

      public void setPaymentType​(String paymentType)

    • isPaymentTypeSpecified

      public boolean isPaymentTypeSpecified()

    • unsetPaymentType

      public void unsetPaymentType()

    • getReturnUrl

      public String getReturnUrl()

    • setReturnUrl

      public void setReturnUrl​(String returnUrl)

    • isReturnUrlSpecified

      public boolean isReturnUrlSpecified()

    • unsetReturnUrl

      public void unsetReturnUrl()

    • getType

      public String getType()

    • setType

      public void setType​(String type)

    • isTypeSpecified

      public boolean isTypeSpecified()

    • unsetType

      public void unsetType()

    • getTicketAttachmentReferenceCount

      public Long getTicketAttachmentReferenceCount()

    • setTicketAttachmentReferenceCount

      public void setTicketAttachmentReferenceCount​(Long ticketAttachmentReferenceCount)