Package com.commercetools.api.models.cart

Interface RecurringPaymentConfiguration

public interface RecurringPaymentConfiguration

Determines how the Orders generated by a RecurringOrder are paid for. It is only evaluated on recurring Carts, that is Carts with the RecurringOrder CartOrigin.

Example to create an instance using the builder pattern 

     RecurringPaymentConfiguration recurringPaymentConfiguration = RecurringPaymentConfiguration.builder()
             .paymentStrategy(PaymentStrategy.CHECKOUT)
             .plusPaymentAllocations(paymentAllocationsBuilder -> paymentAllocationsBuilder)
             .build()

  • Method Details

    • getPaymentStrategy

      @NotNull @NotNull PaymentStrategy getPaymentStrategy()

      Determines how payment is collected for the Orders generated by the Recurring Order.

      Returns:
      paymentStrategy

    • getPaymentAllocations

      @NotNull @Valid @NotNull @Valid List<RecurringPaymentAllocation> getPaymentAllocations()

      Payment Methods charged for the Orders generated by the RecurringOrder, and the share of the Order total charged to each of them.

      Returns:
      paymentAllocations

    • setPaymentStrategy

      void setPaymentStrategy(PaymentStrategy paymentStrategy)

      Determines how payment is collected for the Orders generated by the Recurring Order.

      Parameters:
      paymentStrategy - value to be set

    • setPaymentAllocations

      void setPaymentAllocations(RecurringPaymentAllocation... paymentAllocations)

      Payment Methods charged for the Orders generated by the RecurringOrder, and the share of the Order total charged to each of them.

      Parameters:
      paymentAllocations - values to be set

    • setPaymentAllocations

      void setPaymentAllocations(List<RecurringPaymentAllocation> paymentAllocations)

      Payment Methods charged for the Orders generated by the RecurringOrder, and the share of the Order total charged to each of them.

      Parameters:
      paymentAllocations - values to be set

    • of

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

    • of

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

    • copyDeep

      RecurringPaymentConfiguration copyDeep()

    • deepCopy

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

    • builder

      static RecurringPaymentConfigurationBuilder builder()
      builder factory method for RecurringPaymentConfiguration
      Returns:
      builder

    • builder

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

    • withRecurringPaymentConfiguration

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

    • typeReference

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