UpdateOpenPaymentMethodTypeRequest.md

UpdateOpenPaymentMethodTypeRequest

Properties

Name	Type	Description	Notes
entity_id	str	If this custom payment method type is specific to one entity only, specify the entity ID in UUID format when creating the draft payment method type, such as `123e4567-e89b-12d3-a456-426614174000`. You can only update this field to be empty, indicating that this custom payment method type is available to the global entity and all the sub entities in the tenant.	[optional]
fields	List[OpenPaymentMethodTypeRequestFields]	An array containing field metadata of the custom payment method type. Notes: - All the following nested metadata fields must be provided in the request to define a field. - At least one field must be defined in the fields array for a custom payment method type. - Up to 20 fields can be defined in the fields array for a custom method type.
internal_name	str	A string to identify the custom payment method type in the API name of the payment method type. The value of this field must be the same as the value specified when creating the draft revision of this custom payment method type. This field cannot be updated after the creation of the custom payment method type. This field is used along with the `tenantId` field by the system to construct and generate the API name of the custom payment method type in the following way: `<internalName>_c<tenantId>` For example, if `internalName` is `AmazonPay`, and `tenantId` is `12368`, the API name of the custom payment method type will be `AmazonPay__c_12368`.
label	str	The label that is used to refer to this type in the Zuora UI. This value must be alphanumeric, excluding JSON preserved characters such as * \ ’ ”
method_reference_id_field	str	The identification reference of the custom payment method. This field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Payment Method Data Source Exports and Data Query. The value of this field must be the same as the value specified when creating the draft revision of this custom payment method type. This field cannot be updated after the creation of the custom payment method type.
sub_type_field	str	The identification reference indicating the subtype of the custom payment method. This field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query. This field cannot be updated after the creation of the custom payment method type.	[optional]
tenant_id	str	Zuora tenant ID. If multi-entity is enabled in your tenant, this is the ID of the parent tenant of all the sub entities. This field cannot be updated after the creation of the custom payment method type.
user_reference_id_field	str	The identification reference of the user or customer account. This field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query. This field cannot be updated after the creation of the custom payment method type.	[optional]

Example

from zuora_sdk.models.update_open_payment_method_type_request import UpdateOpenPaymentMethodTypeRequest

# TODO update the JSON string below
json = "{}"
# create an instance of UpdateOpenPaymentMethodTypeRequest from a JSON string
update_open_payment_method_type_request_instance = UpdateOpenPaymentMethodTypeRequest.from_json(json)
# print the JSON string representation of the object
print(UpdateOpenPaymentMethodTypeRequest.to_json())

# convert the object into a dict
update_open_payment_method_type_request_dict = update_open_payment_method_type_request_instance.to_dict()
# create an instance of UpdateOpenPaymentMethodTypeRequest from a dict
update_open_payment_method_type_request_from_dict = UpdateOpenPaymentMethodTypeRequest.from_dict(update_open_payment_method_type_request_dict)

[Back to Model list] [Back to API list] [Back to README]