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.

Currency Code

string

optional

The currency used for payment method authorization.

Google Payment Token*

string

required

This field is used when setting up Google Pay on Chase gateway integrations to provide the stringified Google Pay token. For more information, see Set up Google Pay on Chase.

IP Address

string

optional

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.

makeDefault

string

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

Skip Validation

string

optional

Default: false

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.

Type*

string

required

Type of the payment method