Interface PaymentSetMethodInfoAction

All Superinterfaces:
PaymentUpdateAction, ResourceUpdateAction<PaymentUpdateAction>

public interface PaymentSetMethodInfoAction extends PaymentUpdateAction

This action lets you update multiple fields of a PaymentMethodInfo in one operation. Only fields with explicitly provided values will be updated.


Example to create an instance using the builder pattern

     PaymentSetMethodInfoAction paymentSetMethodInfoAction = PaymentSetMethodInfoAction.builder()
             .build()
 
  • Field Details

    • SET_METHOD_INFO

      static final String SET_METHOD_INFO
      discriminator value for PaymentSetMethodInfoAction
      See Also:
  • Method Details

    • getPaymentInterface

      String getPaymentInterface()

      Payment service that processes the Payment—for example, a PSP. The combination of paymentInterface and the interfaceId of a Payment must be unique. The value cannot be modified after it is set.

      Setting this field is equivalent to the setMethodInfoInterface action and will generate the PaymentMethodInfoInterfaceSet Message.

      Returns:
      paymentInterface
    • getMethod

      String getMethod()

      Payment method to use—for example, a credit card or direct debit. If empty, any existing value will be removed.

      Setting this field is equivalent to the setMethodInfoMethod action and will generate the PaymentMethodInfoMethodSet Message.

      Returns:
      method
    • getName

      @Valid @Valid LocalizedString getName()

      Name of the Payment Method. If empty, any existing value will be removed.

      Setting this field is equivalent to the setMethodInfoName action and will generate the PaymentMethodInfoNameSet Message.

      Returns:
      name
    • getToken

      @Valid @Valid PaymentMethodToken getToken()

      Tokenized payment method information of the Payment Method. If empty, any existing value will be removed.

      Setting this field is equivalent to the setMethodInfoToken action and will generate the PaymentMethodInfoTokenSet Message.

      Returns:
      token
    • getInterfaceAccount

      String getInterfaceAccount()

      Account or instance of the payment interface when multiple accounts are used (per interface). If empty, any existing value will be removed.

      Setting this field is equivalent to the setMethodInfoInterfaceAccount action and will generate the PaymentMethodInfoInterfaceAccountSet Message.

      Returns:
      interfaceAccount
    • getCustom

      @Valid @Valid CustomFieldsDraft getCustom()

      Custom Fields for the PaymentMethodInfo. If not provided, any existing Custom Fields will be removed, including the Custom Type.

      Setting this field is equivalent to the setMethodInfoCustomType and setMethodInfoCustomField actions, and will generate the following Messages:

      Returns:
      custom
    • setPaymentInterface

      void setPaymentInterface(String paymentInterface)

      Payment service that processes the Payment—for example, a PSP. The combination of paymentInterface and the interfaceId of a Payment must be unique. The value cannot be modified after it is set.

      Setting this field is equivalent to the setMethodInfoInterface action and will generate the PaymentMethodInfoInterfaceSet Message.

      Parameters:
      paymentInterface - value to be set
    • setMethod

      void setMethod(String method)

      Payment method to use—for example, a credit card or direct debit. If empty, any existing value will be removed.

      Setting this field is equivalent to the setMethodInfoMethod action and will generate the PaymentMethodInfoMethodSet Message.

      Parameters:
      method - value to be set
    • setName

      void setName(LocalizedString name)

      Name of the Payment Method. If empty, any existing value will be removed.

      Setting this field is equivalent to the setMethodInfoName action and will generate the PaymentMethodInfoNameSet Message.

      Parameters:
      name - value to be set
    • setToken

      void setToken(PaymentMethodToken token)

      Tokenized payment method information of the Payment Method. If empty, any existing value will be removed.

      Setting this field is equivalent to the setMethodInfoToken action and will generate the PaymentMethodInfoTokenSet Message.

      Parameters:
      token - value to be set
    • setInterfaceAccount

      void setInterfaceAccount(String interfaceAccount)

      Account or instance of the payment interface when multiple accounts are used (per interface). If empty, any existing value will be removed.

      Setting this field is equivalent to the setMethodInfoInterfaceAccount action and will generate the PaymentMethodInfoInterfaceAccountSet Message.

      Parameters:
      interfaceAccount - value to be set
    • setCustom

      void setCustom(CustomFieldsDraft custom)

      Custom Fields for the PaymentMethodInfo. If not provided, any existing Custom Fields will be removed, including the Custom Type.

      Setting this field is equivalent to the setMethodInfoCustomType and setMethodInfoCustomField actions, and will generate the following Messages:

      Parameters:
      custom - value to be set
    • of

      factory method
      Returns:
      instance of PaymentSetMethodInfoAction
    • of

      factory method to create a shallow copy PaymentSetMethodInfoAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance
    • copyDeep

      Specified by:
      copyDeep in interface PaymentUpdateAction
    • deepCopy

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

      builder factory method for PaymentSetMethodInfoAction
      Returns:
      builder
    • builder

      create builder for PaymentSetMethodInfoAction instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder
    • withPaymentSetMethodInfoAction

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