Interface PaymentSetMethodInfoAction
- All Superinterfaces:
PaymentUpdateAction
,ResourceUpdateAction<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 Summary
FieldsModifier and TypeFieldDescriptionstatic final String
discriminator value for PaymentSetMethodInfoAction -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
builder factory method for PaymentSetMethodInfoActionbuilder
(PaymentSetMethodInfoAction template) create builder for PaymentSetMethodInfoAction instancecopyDeep()
static PaymentSetMethodInfoAction
deepCopy
(PaymentSetMethodInfoAction template) factory method to create a deep copy of PaymentSetMethodInfoAction@Valid CustomFieldsDraft
Custom Fields for the PaymentMethodInfo.Account or instance of the payment interface when multiple accounts are used (per interface).Payment method to use—for example, a credit card or direct debit.@Valid LocalizedString
getName()
Name of the Payment Method.Payment service that processes the Payment—for example, a PSP.@Valid PaymentMethodToken
getToken()
Tokenized payment method information of the Payment Method.static PaymentSetMethodInfoAction
of()
factory methodstatic PaymentSetMethodInfoAction
of
(PaymentSetMethodInfoAction template) factory method to create a shallow copy PaymentSetMethodInfoActionvoid
setCustom
(CustomFieldsDraft custom) Custom Fields for the PaymentMethodInfo.void
setInterfaceAccount
(String interfaceAccount) Account or instance of the payment interface when multiple accounts are used (per interface).void
Payment method to use—for example, a credit card or direct debit.void
setName
(LocalizedString name) Name of the Payment Method.void
setPaymentInterface
(String paymentInterface) Payment service that processes the Payment—for example, a PSP.void
setToken
(PaymentMethodToken token) Tokenized payment method information of the Payment Method.static com.fasterxml.jackson.core.type.TypeReference<PaymentSetMethodInfoAction>
gives a TypeReference for usage with Jackson DataBinddefault <T> T
accessor map functionMethods inherited from interface com.commercetools.api.models.payment.PaymentUpdateAction
getAction, withPaymentUpdateAction
Methods inherited from interface com.commercetools.api.models.ResourceUpdateAction
get
-
Field Details
-
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 theinterfaceId
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
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
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
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
andsetMethodInfoCustomField
actions, and will generate the following Messages:- Adding or updating a Custom Type on a Payment Method Info generates the PaymentMethodInfoCustomTypeSet Message, removing one generates the PaymentMethodInfoCustomTypeRemoved Message.
- Adding a Custom Field to a Payment generates the PaymentMethodInfoCustomFieldAdded Message, removing one generates the PaymentMethodInfoCustomFieldRemoved Message, and updating an existing one generates the PaymentMethodInfoCustomFieldChanged Message.
- Returns:
- custom
-
setPaymentInterface
Payment service that processes the Payment—for example, a PSP. The combination of
paymentInterface
and theinterfaceId
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
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
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
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
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
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
andsetMethodInfoCustomField
actions, and will generate the following Messages:- Adding or updating a Custom Type on a Payment Method Info generates the PaymentMethodInfoCustomTypeSet Message, removing one generates the PaymentMethodInfoCustomTypeRemoved Message.
- Adding a Custom Field to a Payment generates the PaymentMethodInfoCustomFieldAdded Message, removing one generates the PaymentMethodInfoCustomFieldRemoved Message, and updating an existing one generates the PaymentMethodInfoCustomFieldChanged Message.
- 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
PaymentSetMethodInfoAction copyDeep()- Specified by:
copyDeep
in interfacePaymentUpdateAction
-
deepCopy
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
accessor map function- Type Parameters:
T
- mapped type- Parameters:
helper
- function to map the object- Returns:
- mapped value
-
typeReference
gives a TypeReference for usage with Jackson DataBind- Returns:
- TypeReference
-