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.

Address Line1

string

optional

The primary address line for the account holder.

Address Line2

string

optional

The secondary address line for the account holder.

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.

Bank ABA Code*

string

Required to create when the payment method type is ACH.

The nine-digit routing number (ABA number) used by banks. This field is required only when the type field is set to ACH.

Bank Account Name*

string <= 70 characters

required

The name of the account holder (individual or company).

For more information, see BlueSnap payment gateway integration.

Bank Account Number*

string <= 30 characters

Optional for tokenized ACH payment methods; otherwise, this field is required.

The bank account number associated with the ACH payment.

This field is optional when creating tokenized ACH payment methods. ACH tokenization is currently supported only for selected payment gateway integrations.

See this article for more information.

Bank Account Type*

string

required

The type of bank account associated with the ACH payment.

This field is required by Zuora when creating an ACH payment method with Adyen, although it is not required by Adyen. Provide a valid value if available. If not, specify any supported value as a placeholder, preferably Checking.

Enum: BusinessChecking, Checking Saving

Bank Account Mask Number

string

optional

Bank Name

string <= 70 characters

optional

The name of the bank where the ACH account is held.

This field is required by Zuora when creating an ACH payment method with Adyen, although it is not required by Adyen. Provide a valid value if available. If not, specify a placeholder value.

City

string <= 40 characters

optional

It is recommended to provide both city and country when creating a payment method. This information is used for payment processing. If not provided, the city and country data will be unavailable during processing

Country

string

optional

Country. Must be a valid country name or abbreviation. See View Countries or Regions for supported values.

It is recommended to provide both city and country when creating a payment method. This information is used for payment processing. If not provided, the city and country data will be unavailable during processing.

Currency Code

string

optional

The currency used for payment method authorization.

IP Address

string

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.

Phone

string < 40 characters

optional

Phone number.

Processing Options Check Duplicated

boolean

optional

Indicates whether to perform a duplication check when creating a payment method.

Default: false

If set to true, Zuora checks active and closed payment methods associated with the same billing account to prevent duplicates.

PostalCode

string <= 20 characters

optional

Zip code or Postal code.

Skip Validation

boolean

optional

Default: false

Specifies whether to skip validation of the payment method through the payment gateway. Set this field to true to bypass validation, for example, during payment method migration.

State

string

optional

Must be a valid subregion name or code (state or province). See View Subregions of a Specific Country or Region for supported values.

Type*

string

Required when creating an ACH payment method.

The type of payment method.

Tokenize

boolean

optional

Default: false

Specifies whether to tokenize the payment method with account information. Set to true to enable tokenization.

This field is supported only for selected integrations. See the relevant integration documentation for details.

Tokens Token Id*

string

optional

Provide the first token of the payment method.

Tokens gateway Type*

string

optional

The type of payment gateway used to generate the tokens. This field is case-sensitive.

Tokens Second Token Id

string

optional

Provide the second token of the payment method.

Tokens Third Token Id

string

optional

Provide the third token of the payment method.