Package com.commercetools.api.models.payment

Interface PaymentSetTransactionInterfaceIdAction

All Superinterfaces:
PaymentUpdateAction, ResourceUpdateAction<PaymentUpdateAction>
public interface PaymentSetTransactionInterfaceIdAction extends PaymentUpdateAction

Setting the transaction interface ID produces the PaymentTransactionInterfaceIdSet Message.

Example to create an instance using the builder pattern 

     PaymentSetTransactionInterfaceIdAction paymentSetTransactionInterfaceIdAction = PaymentSetTransactionInterfaceIdAction.builder()
             .transactionId("{transactionId}")
             .build()

  • Field Details

    • SET_TRANSACTION_INTERFACE_ID

      static final String SET_TRANSACTION_INTERFACE_ID
      discriminator value for PaymentSetTransactionInterfaceIdAction
      See Also:

  • Method Details

    • getTransactionId

      @NotNull @NotNull String getTransactionId()

      Unique identifier of the Transaction.

      Returns:
      transactionId

    • getInterfaceId

      String getInterfaceId()

      Identifier used by the payment service that processes the Payment (for example, a PSP) in the current transaction. It must be unique across all transactions. If interfaceId is absent, this field will be removed from the specified Transaction, if it exists.

      Returns:
      interfaceId

    • setTransactionId

      void setTransactionId(String transactionId)

      Unique identifier of the Transaction.

      Parameters:
      transactionId - value to be set

    • setInterfaceId

      void setInterfaceId(String interfaceId)

      Identifier used by the payment service that processes the Payment (for example, a PSP) in the current transaction. It must be unique across all transactions. If interfaceId is absent, this field will be removed from the specified Transaction, if it exists.

      Parameters:
      interfaceId - value to be set

    • of

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

    • of

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

    • copyDeep

      PaymentSetTransactionInterfaceIdAction copyDeep()
      Specified by:
      copyDeep in interface PaymentUpdateAction

    • deepCopy

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

    • builder

      static PaymentSetTransactionInterfaceIdActionBuilder builder()
      builder factory method for PaymentSetTransactionInterfaceIdAction
      Returns:
      builder

    • builder

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

    • withPaymentSetTransactionInterfaceIdAction

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