POST /open-payment-method-types

Default value: "application/json"

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

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.

A string to identify the custom payment method type in the API name of the payment method type.

This field must be alphanumeric, starting with a capital letter, excluding JSON preserved characters such as * \ ’ ”. Additionally, '_' or '-' is not allowed.

This field must be unique in a tenant.

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.

This field cannot be updated after the creation of the custom payment method type.

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 * \ ’ ”

If this custom payment method type is specific to one entity only, provide the entity ID in this field in UUID format, such as 123e4567-e89b-12d3-a456-426614174000. If no entity UUID is provided, the custom payment method type is available to the global entity and all the sub entities in the tenant.

You can get the entity ID through the Multi-entity: List entities API operation or the Manage Entity Profile administration setting in the UI. To convert the format of the entity ID to UUID, separate the entity ID string in five groups with hyphens, in the form <8-characters>-<4-characters>-<4-characters>-<4-characters>-<12-characters> for a total of 36 characters.

Note: After the custom payment method type is created, you can only update this field to be empty.

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.

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.

An array containing field metadata of the custom payment method type.

Notes:

• All the following nested metadata 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 payment method type.

The checksum value of a payment method is used to identify if this payment method is the same as another one, or if this payment method is altered to another new payment method.

Set this flag to true for the following scenarios:

• The field should be part of checksum calculation.
• The field is a critical differentiator for this type.

For example, if you select the credit card number and expiration date as the checksum fields for the CreditCard payment method type, when you modified the expiration date, Zuora considers this payment method as a different payment method compared to the original one.

This field cannot be null or empty.

This field cannot be updated after the creation of the custom payment method type.

An explanation of this field. It can be an empty string.

Specify whether this field is required.

This field cannot be null or empty.

This field cannot be updated after the creation of the custom payment method type.

A maximum length limitation of the field value. The specified value must be in the range of [1,8000]. maxLength must be greater than or equal to minLength.

After the custom payment method type is created, you can only increase the value of maxLength. Decreasing the value is not supported.

A minimal length limitation of the field value.

0 <= minLength <= maxLength

The value of this metadata does not determine whether the field is a required field. It only defines the minimal length of the field value.

After the custom payment method type is created, you can only decrease the value of minLength. Increasing the value is not supported.

The default value of the field. null is supported.

If a required field is added after the custom payment method type is published, defaultValue is required.

This field cannot be updated after the creation of the custom payment method type.

The API name of this field. It must be uinique.

An alphanumeric string starting with a capital letter, excluding JSON preserved characters e.g. * \ ’ ”

Though this field must be defined with a string starting with a capital letter, use this string with the first letter in lowercase when you specify it in other API operations. For example, AmazonPayToken is the defined value for name. In the request of the "Create a payment method" API operation, use amazonPayToken.

This field cannot be null or empty or any reserved field name.

This field cannot be updated after the creation of the custom payment method type.

The label that is used to refer to this field in the Zuora UI.

An alphanumeric string, excluding JSON preserved characters e.g. * \ ’ ”

This field cannot be null or empty or any reserved field name.

Specify true if this field can be retrieved through GET API or UI for displaying payment method details.

This field cannot be null or empty.

Notes:

• If visible is set to false, you can still specify the value of this field in the UI and POST API when creating the payment method.
• If visible is set to false and editable is set to true, this field is not accessible through GET API or UI for displaying details, but you can still see it and edit the value in the UI and PUT API when updating this payment method.

This flag determines whether this field will be used for identifying this payment method in the Zuora UI. The field will be shown in the Payment Method field in the UI.

This field cannot be null or empty.

Notes:

• In one custom payment method type, set representer to true for at least one field .
• In one custom payment method type, you can set representer to true for multiple fields.

The type of this field.

For the date type, ISO_LOCAL_DATE format is supported, such as 2011-12-03. The timezone is not expected for the date type. For example, 2011-12-03+01:00 will be rejected.

For the datetime type, only ISO_OFFSET_DATE_TIME format is supported, such as 2011-12-03T10:15:30+01:00. Timezone must be included. A string like 2011-12-03T10:15:30 or 2011-12-03T10:15:30+01:00[Europe/Paris] will be rejected.

If you need to define a date type with timezone or a datetime type without timezone, use the string type for now.

This field cannot be null or empty.

This field cannot be updated after the creation of the custom payment method type.

Possible values:

• "string"
• "date"
• "boolean"
• "datetime"
• "number"

Specify true if this field can be updated through PUT API or UI.

This field cannot be null or empty.

Note: If editable is set to false, you can specify the value of this field in the UI and POST API when creating a payment method. However, after you created the payment method, you cannot edit this field through PUT API or UI.

The order of the field in this type, starting from 1. It must be unique.

This field cannot be null or empty.

This field cannot be updated after the creation of the custom payment method type.

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.

This field cannot be updated after the creation of the custom payment method type.