Package com.commercetools.api.models.payment

Interface PaymentStatus

public interface PaymentStatus
PaymentStatus
Example to create an instance using the builder pattern 

     PaymentStatus paymentStatus = PaymentStatus.builder()
             .build()

  • Method Details

    • getInterfaceCode

      String getInterfaceCode()

      External reference that identifies the current status of the Payment.

      Returns:
      interfaceCode

    • getInterfaceText

      String getInterfaceText()

      Text describing the current status of the Payment.

      Returns:
      interfaceText

    • getState

      @Valid @Valid StateReference getState()

      Reference to a State.

      Returns:
      state

    • setInterfaceCode

      void setInterfaceCode(String interfaceCode)

      External reference that identifies the current status of the Payment.

      Parameters:
      interfaceCode - value to be set

    • setInterfaceText

      void setInterfaceText(String interfaceText)

      Text describing the current status of the Payment.

      Parameters:
      interfaceText - value to be set

    • setState

      void setState(StateReference state)

      Reference to a State.

      Parameters:
      state - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static PaymentStatusBuilder builder()
      builder factory method for PaymentStatus
      Returns:
      builder

    • builder

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

    • withPaymentStatus

      default <T> T withPaymentStatus(Function<PaymentStatus,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<PaymentStatus> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference