Type of the payment method. The following types of the payment methods are supported:

• CreditCard

• CreditCardReferenceTransaction

• ACH

• SEPA

• Betalingsservice

• Autogiro

• Bacs

• Becs

• Becsnz

• PAD

• PayPalCP

• PayPalEC

• PayPalNativeEC

• PayPalAdaptive

• AdyenApplePay

• AdyenGooglePay

• GooglePay

To view the schema and example applicable to a specific payment method type, select the corresponding option from the following list.

Container for cardholder information. The nested cardHolderName field is required.

The masked card number.

Currently, this field is only supported on certain integrations. See this article for more information.

Credit card number.

The type of the credit card. Possible values include Visa, MasterCard, AmericanExpress, Discover, JCB, and Diners. For more information about credit card types supported by different payment gateways, see Supported Payment Gateways.

Indicates whether the duplication check is performed when you create a new credit card payment method. The default value is false.

With this field set to true, Zuora will check all active payment methods associated with the same billing account to ensure that no duplicate credit card payment methods are created. An error is returned if a duplicate payment method is found.

The following fields are used for the duplication check:

• cardHolderName
• expirationMonth
• expirationYear
• creditCardMaskNumber. It is the masked credit card number generated by Zuora. For example, ************1234.

This field is being deprecated. To achieve the same purpose, use the processingOptions > checkDuplicated field of the payment method object.

One or two digit expiration month (1-12) of the credit card.

Four-digit expiration year of the credit card.

The identity number of the cardholder. This field is required for Credit Card payment methods in certain countries such as Brazil.

Specifies your reference for the stored credential consent agreement that you have established with the customer. Only applicable if you set the mitProfileAction field.

Required if you set the mitProfileAction field. Specifies how the consent agreement has been established with the customer. The allowed value is External. If you do not specify the mitProfileAction field, Zuora will automatically create a stored credential profile for the payment method, with the default value External set to this field.

Specifies the ID of a network transaction. Only applicable if you set the mitProfileAction field to Persist.

Specifies how Zuora creates and activates the stored credential profile.

• Activate - Use this value if you are creating the stored credential profile after receiving the customer's consent.

  Zuora will create the stored credential profile then send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile. If the CIT succeeds, the status of the stored credential profile will be Active. If the CIT does not succeed, Zuora will not create a stored credential profile.

  If the payment gateway does not support the stored credential transaction framework, the status of the stored credential profile will be Agreed.

• Persist - Use this value if the stored credential profile represents a stored credential profile in an external system. The status of the payment method's stored credential profile will be Active.

If you do not specify this field, Zuora will automatically create a stored credential profile for the payment method, with the default value Activate set to this field.

The date on which the profile is agreed. The date format is yyyy-mm-dd.

Required if you set the mitProfileAction field. Indicates the type of the stored credential profile to process recurring or unsecheduled transactions. If you do not specify the mitProfileAction field, Zuora will automatically create a stored credential profile for the payment method, with the default value Recurring set to this field.

For Chase Paymentech Orbital Gateway integrations, if the Safetech Fraud service is enabled, use this field to pass in the amount used for fraud screening for Credit Card validation transactions.

Two-decimal amount is supported.

If the screeningAmount field is not specified, the authorization amount is used for fraud screening.

CVV or CVV2 security code of the credit card.

To ensure PCI compliance, this value is not stored and cannot be queried.

To create tokenized payment methods, pass in the existing token information through the fields in this container.

Currently, this field is only supported on certain integrations. See this article for more information.

Specify true to tokenize the payment method with the card information.

Currently, this field is only supported on certain integrations. See this article for more information.

The container of the mandate information for the payment method.

The container for payment method processing options.

The customer account ID such as 2x92c0f859b0480f0159d3a4a6ee5bb6 or the customer account number such as A02855638.

To create an orphan payment method that is not associated with any customer account, you can skip this field. As soon as the account information is available, associate the payment method with an account through the Update a payment method operation.

Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method.

If you do not set this field, Zuora will use one of the following payment gateways instead:

• The default payment gateway of the customer account that owns the payment method, if the accountKey field is set.
• The default payment gateway of your Zuora tenant, if the accountKey field is not set.

The currency used for payment method authorization.

The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in Zuora Knowledge Center.

Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.

The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways.

If the IP address length is beyond 45 characters, a validation error occurs.

For validating SEPA payment methods on Stripe v2, this field is required.

Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the accountKey field is set.

When you set this field to true, make sure the payment method is supported by the default payment gateway.

Specify whether to skip the validation of the information through the payment gateway. For example, when migrating your payment methods, you can set this field to true to skip the validation.