Account Number*

string

required

Customer's bank account number.

Account Key

string

optional

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.

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.

Account Mask Number

string

optional

The masked account number such as ****1234.

Auth Gateway

string

optional

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

Account Holder Info Account Holder Name*

string <= 60 characters

required

The full name of the bank account holder.

Account Holder Info Address Line1

string

Optional

The account holder's first name.

Account Holder Info Address Line2

string

Optional

The account holder's last name.

Account Holder Info City

string

Optional

The city where the account holder resides. Providing the city and country during payment method creation is recommended, as this information is used for payment processing. If not provided, the city and country details will be unavailable during processing.

Account Holder Info Country

string

Optional

The country where the account holder resides.

Account Holder Info Email

string

Optional

The account holder's email address.

Account Holder Info First Name

string

Optional

The account holder's first name.

Account Holder Info Last Name

string

Optional

The account holder's last name.

Account Holder Info Phone

string

Optional

The account holder's phone number.

Account Holder Info State

string

Optional

The state where the account holder resides.

Account Holder Info Zip Code

string

Optional

The ZIP/postal code for the account holder's address.

Bank Code*

string

Required to Create

The sort code or number that identifies the bank. This is also known as the sort code.

Branch Code*

string

Required to Create

The branch code of the bank used for direct debit.

Currency Code

string

Optional

The currency used for payment method authorization

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

boolean

Optional

Default: false 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.

Mandate Info Mandate Id

string <= 36 characters

Optional

The mandate ID.

Mandate Info Mandate Reason

string <= 64 characters

Optional

The reason of the mandate from the gateway side

Mandate Info Mandate Status

string <= 64 characters

Optional

The status of the mandate as provided by the payment gateway

Processing Options Check Duplicated

boolean

Optional

Indicates whether to perform a duplication check when you create a payment method. The default value is false. With this field set to true, Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created. For more information, see Duplication check on payment methods.

Skip Validation

boolean

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 to Create

Type of the payment method.