Package com.commercetools.api.models.payment_method

Interface PaymentMethodDraft

All Superinterfaces:
Draft<PaymentMethodDraft>
public interface PaymentMethodDraft extends Draft<PaymentMethodDraft>
PaymentMethodDraft
Example to create an instance using the builder pattern 

     PaymentMethodDraft paymentMethodDraft = PaymentMethodDraft.builder()
             .build()

  • Method Details

    • getKey

      String getKey()

      User-defined unique identifier for the PaymentMethod.

      Returns:
      key

    • getName

      @Valid @Valid LocalizedString getName()

      Name of the PaymentMethod.

      Returns:
      name

    • getCustomer

      @Valid @Valid CustomerResourceIdentifier getCustomer()

      Reference to a Customer the PaymentMethod should belong to.

      If businessUnit is set, the Customer must be an Associate of the Business Unit.

      Returns:
      customer

    • getBusinessUnit

      @Valid @Valid BusinessUnitResourceIdentifier getBusinessUnit()

      Reference to a BusinessUnit the PaymentMethod should belong to.

      Only available for B2B-enabled Projects.

      Returns:
      businessUnit

    • getMethod

      String getMethod()

      Payment method to use for the Payment—for example, a credit card or direct debit.

      Returns:
      method

    • getPaymentInterface

      String getPaymentInterface()

      Payment service that processes the Payment—for example, a PSP.

      Returns:
      paymentInterface

    • getInterfaceAccount

      String getInterfaceAccount()

      Account or instance of the payment interface when multiple accounts are used (per interface).

      Returns:
      interfaceAccount

    • getToken

      @Valid @Valid PaymentMethodToken getToken()

      Tokenized representation of the PaymentMethod used by the payment interface.

      Returns:
      token

    • getPaymentMethodStatus

      PaymentMethodStatus getPaymentMethodStatus()

      Status of the PaymentMethod.

      Returns:
      paymentMethodStatus

    • getDefault

      Boolean getDefault()

      Set to true if the PaymentMethod should be the default.

      The default applies per Customer, Business Unit, or the combination of both (Associate).

      Returns:
      default

    • getCustom

      @Valid @Valid CustomFieldsDraft getCustom()

      Custom Fields for the PaymentMethod.

      Returns:
      custom

    • setKey

      void setKey(String key)

      User-defined unique identifier for the PaymentMethod.

      Parameters:
      key - value to be set

    • setName

      void setName(LocalizedString name)

      Name of the PaymentMethod.

      Parameters:
      name - value to be set

    • setCustomer

      void setCustomer(CustomerResourceIdentifier customer)

      Reference to a Customer the PaymentMethod should belong to.

      If businessUnit is set, the Customer must be an Associate of the Business Unit.

      Parameters:
      customer - value to be set

    • setBusinessUnit

      void setBusinessUnit(BusinessUnitResourceIdentifier businessUnit)

      Reference to a BusinessUnit the PaymentMethod should belong to.

      Only available for B2B-enabled Projects.

      Parameters:
      businessUnit - value to be set

    • setMethod

      void setMethod(String method)

      Payment method to use for the Payment—for example, a credit card or direct debit.

      Parameters:
      method - value to be set

    • setPaymentInterface

      void setPaymentInterface(String paymentInterface)

      Payment service that processes the Payment—for example, a PSP.

      Parameters:
      paymentInterface - value to be set

    • setInterfaceAccount

      void setInterfaceAccount(String interfaceAccount)

      Account or instance of the payment interface when multiple accounts are used (per interface).

      Parameters:
      interfaceAccount - value to be set

    • setToken

      void setToken(PaymentMethodToken token)

      Tokenized representation of the PaymentMethod used by the payment interface.

      Parameters:
      token - value to be set

    • setPaymentMethodStatus

      void setPaymentMethodStatus(PaymentMethodStatus paymentMethodStatus)

      Status of the PaymentMethod.

      Parameters:
      paymentMethodStatus - value to be set

    • setDefault

      void setDefault(Boolean _default)

      Set to true if the PaymentMethod should be the default.

      The default applies per Customer, Business Unit, or the combination of both (Associate).

      Parameters:
      _default - value to be set

    • setCustom

      void setCustom(CustomFieldsDraft custom)

      Custom Fields for the PaymentMethod.

      Parameters:
      custom - value to be set

    • of

      static PaymentMethodDraft of()
      factory method
      Returns:
      instance of PaymentMethodDraft

    • of

      static PaymentMethodDraft of(PaymentMethodDraft template)
      factory method to create a shallow copy PaymentMethodDraft
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      PaymentMethodDraft copyDeep()

    • deepCopy

      @Nullable static PaymentMethodDraft deepCopy(@Nullable PaymentMethodDraft template)
      factory method to create a deep copy of PaymentMethodDraft
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static PaymentMethodDraftBuilder builder()
      builder factory method for PaymentMethodDraft
      Returns:
      builder

    • builder

      static PaymentMethodDraftBuilder builder(PaymentMethodDraft template)
      create builder for PaymentMethodDraft instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withPaymentMethodDraft

      default <T> T withPaymentMethodDraft(Function<PaymentMethodDraft,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<PaymentMethodDraft> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference