Create a draft custom payment method type

Creates a draft version of a custom payment method type. Revision number 1 is assigned to this version. You can update your draft version through the Update a custom payment method type operation. You must publish your draft version through the Publish a custom payment method type operation before your custom payment method type goes live.

Request
header Parameters
Idempotency-Key
string <= 255 characters

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.

Accept-Encoding
string

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.

Content-Encoding
string

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.

Authorization
required
string

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

Zuora-Track-Id
string <= 64 characters

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 (').

Zuora-Entity-Ids
string

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.

Zuora-Org-Ids
string

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.

Request Body schema: application/json
required
entityId
string

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.

required
Array of objects (fields)

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.
internalName
required
string <= 19 characters

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.

label
required
string <= 40 characters

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

methodReferenceIdField
required
string

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.

subTypeField
string

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.

tenantId
required
string

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.

userReferenceIdField
string

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.

Responses
200
post/open-payment-method-types
Request samples
application/json
{
  • "entityId": "",
  • "fields": [
    ],
  • "internalName": "AmazonPay",
  • "label": "ZuoraQA Amazon Pay",
  • "methodReferenceIdField": "AmazonToken",
  • "subTypeField": "AmazonTokenType",
  • "tenantId": "9",
  • "userReferenceIdField": ""
}
Response samples
application/json
{
  • "paymentMethodType": "AmazonPay__C_12368",
  • "publishDate": "",
  • "revision": 1,
  • "status": "Draft"
}