Account Key

string

optional

Provide either the customer account ID (for example, 2x92c0f859b0480f0159d3a4a6ee5bb6) or the customer account number (for example, A02855638).

To create an orphan payment method not associated with a customer account, omit this field. When account information becomes available, associate the payment method using the Update Payment Method operation.

Auth Gateway

string

optional

The internal ID of the payment gateway that Zuora uses to authorize payments made with this payment method.

If this field is not set, Zuora uses the default payment gateway of the customer account associated with the payment method when the accountKey is specified; otherwise, it uses the default payment gateway configured for the Zuora tenant.

Credit Card Mask Number

string <= 19 characters

optional

The masked credit card number, for example, *********1112. This field is specific to the CC Reference Transaction payment method and is optional. It can be used to distinguish between different CC Reference Transaction payment methods. Although there are no strict restrictions on the input format, it is recommended to provide a masked card number.

Currency Code

string

optional

The currency used for payment method authorization.

IP Address

string

optional

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

The maximum length is 45 characters. Values exceeding this limit result in a validation error.

This field is required when validating SEPA payment methods on Stripe v2.

makeDefault

boolean

optional

Default: false

Specifies whether this payment method is set as the default for the associated customer account. This field applies only when the accountKey field is provided.

If set to true, ensure the payment method is supported by the default payment gateway.

Mandate Info Mandate Id

string <= 36 characters

optional

The mandate ID.

Mandate Info Mandate Reason

string <= 64 characters

optional

The reason for the mandate from the gateway.

Mandate Info Mandate Status

string <= 64 characters

optional

The status of the mandate from the gateway

Second Token Id

string

optional

A gateway specific identifier that replaces sensitive payment method data. The secondTokenId field is conditionally required only when tokenId is used to represent a gateway customer profile, and it is used with the CC Reference Transaction payment method.

Skip Validation

boolean

optional

Default: false

Indicates whether to skip validation of the payment method information with the payment gateway. This field can be set to true to bypass validation, for example, when migrating payment methods.

Token Id*

string

required

A gateway specific identifier that replaces sensitive payment method data or represents a unique customer profile in the gateway. When tokenId represents a customer profile, secondTokenId is conditionally required to represent the underlying tokenized payment method.

The values for tokenId and secondTokenId vary by gateway.

Type*

boolean

required

Type of the payment method.