Package de.hybris.platform.b2ctelcotmfwebservices.v2.dto

Class PaymentMethodType

java.lang.Object
de.hybris.platform.b2ctelcotmfwebservices.v2.dto.PaymentMethodType
public class PaymentMethodType extends Object
Defines a specific method of payment (e.g. direct debit with all details associated)

  • Constructor Details

    • PaymentMethodType

      public PaymentMethodType()

  • Method Details

    • id

      public PaymentMethodType id(String id)

    • getId

      public String getId()
      Unique id of the payment method in the server
      Returns:
      id

    • setId

      public void setId(String id)

    • href

      public PaymentMethodType href(String href)

    • getHref

      public String getHref()
      URI where to perform actions on the payment method
      Returns:
      href

    • setHref

      public void setHref(String href)

    • name

      public PaymentMethodType name(String name)

    • getName

      public String getName()
      Friendly name assigned to the payment method
      Returns:
      name

    • setName

      public void setName(String name)

    • description

      public PaymentMethodType description(String description)

    • getDescription

      public String getDescription()
      Text description of the contents of the payment method
      Returns:
      description

    • setDescription

      public void setDescription(String description)

    • preferred

      public PaymentMethodType preferred(Boolean preferred)

    • isPreferred

      public Boolean isPreferred()
      If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account
      Returns:
      preferred

    • setPreferred

      public void setPreferred(Boolean preferred)

    • authorizationCode

      public PaymentMethodType authorizationCode(String authorizationCode)

    • getAuthorizationCode

      public String getAuthorizationCode()
      Review: Authorization code provided by a financial institution. Typically this would be populated for recurring payments using the method, as payments have an authorization code of their own.
      Returns:
      authorizationCode

    • setAuthorizationCode

      public void setAuthorizationCode(String authorizationCode)

    • status

      public PaymentMethodType status(String status)

    • getStatus

      public String getStatus()
      Status of the payment method
      Returns:
      status

    • setStatus

      public void setStatus(String status)

    • statusDate

      public PaymentMethodType statusDate(Date statusDate)

    • getStatusDate

      @Valid public @Valid Date getStatusDate()
      The last time the payment method status changed.
      Returns:
      statusDate

    • setStatusDate

      public void setStatusDate(Date statusDate)

    • statusReason

      public PaymentMethodType statusReason(String statusReason)

    • getStatusReason

      public String getStatusReason()
      The reason for the last status change.
      Returns:
      statusReason

    • setStatusReason

      public void setStatusReason(String statusReason)

    • validFor

      public PaymentMethodType validFor(TimePeriodType validFor)

    • getValidFor

      @Valid public @Valid TimePeriodType getValidFor()
      Get validFor
      Returns:
      validFor

    • setValidFor

      public void setValidFor(TimePeriodType validFor)

    • atType

      public PaymentMethodType atType(PaymentMethodType.AtTypeEnum atType)

    • getAtType

      public PaymentMethodType.AtTypeEnum getAtType()
      Type of payment method (e.g.: bank card, cash, voucher…). The details field type depends on the value assigned to this one.
      Returns:
      atType

    • setAtType

      public void setAtType(PaymentMethodType.AtTypeEnum atType)

    • details

      public PaymentMethodType details(CreditCardType details)

    • getDetails

      @Valid public @Valid CreditCardType getDetails()
      Get details
      Returns:
      details

    • setDetails

      public void setDetails(CreditCardType details)

    • relatedParty

      public PaymentMethodType relatedParty(RelatedPartyRefType relatedParty)

    • getRelatedParty

      @Valid public @Valid RelatedPartyRefType getRelatedParty()
      Get relatedParty
      Returns:
      relatedParty

    • setRelatedParty

      public void setRelatedParty(RelatedPartyRefType relatedParty)

    • account

      public PaymentMethodType account(List<AccountRefType> account)

    • addAccountItem

      public PaymentMethodType addAccountItem(AccountRefType accountItem)

    • getAccount

      @Valid public @Valid List<AccountRefType> getAccount()
      Reference to the accounts that are linked to the payment method. May be a party account or a financial account.
      Returns:
      account

    • setAccount

      public void setAccount(List<AccountRefType> account)

    • voucher

      public PaymentMethodType voucher(VoucherType voucher)

    • getVoucher

      @Valid public @Valid VoucherType getVoucher()
      Get voucher
      Returns:
      voucher

    • setVoucher

      public void setVoucher(VoucherType voucher)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object