home

Zuora Platform

Zuora BillingZuora PaymentsZuora PlatformZuora CPQZephrZuora RevenueAccounts ReceivableRelease NotesBasicsEntitlementsSupport and policies
Zuora BillingZuora PaymentsZuora PlatformZuora CPQZephrZuora RevenueAccounts ReceivableRelease NotesBasicsEntitlementsSupport and policies

Welcome to Zuora Product Documentation

Explore our rich library of product information

Show Contents

thumbnailZuora Platform

Payment Methods

Payment Methods Bacs

This reference document lists all the data dictionary fields associated with the Bacs payment methods.

Note: Fields with an asterisk mark indicate mandatory fields.

Field name

Value

Required to update

Description

Account Number*

string

required

Customer's bank account number.

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.

Account Mask Number

string

optional

The masked account number (for example, ****1234).

When creating BACS payment methods on Stripe, this field is required if the tokens field is provided.

Account Holder Info Account Holder Name*

string <= 60 characters

required

The full name of the bank account holder.

Account Holder Info Address Line1stringoptionalThe first line of the address for the account holder.
Account Holder Info Address Line2stringoptionalAdditional address information.
Account Holder Info CitystringoptionalThe city where the account holder stays. It is recommended to provide the city and country information when creating a payment method. If not provided, the data will be missing during payment processing.
Account Holder Info CountrystringoptionalThe country where the account holder stays.
Account Holder Info EmailstringoptionalThe email address of the account holder.
Account Holder Info First NamestringoptionalThe first name of the account holder.
Account Holder Info Last NamestringoptionalThe last name of the account holder.
Account Holder Info PhonestringoptionalThe phone number of the account holder.
Account Holder Info StatestringoptionalThe state where the account holder stays.
Account Holder Info Zip CodestringoptionalThe zip code for the address of the account holder.

Auth Gateway

string

optional

 The internal ID of the payment gateway used by Zuora to authorize payments for this payment method. If not specified, Zuora uses the default payment gateway of the associated customer account when the accountKey field is provided; otherwise, the default payment gateway of the Zuora tenant is used.

Bank Code*

string

required

The bank identifier, also known as the sort code.

Currency Code

string

optional

The currency used to authorize the payment method.

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, and if provided, Zuora passes it 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.

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 of the mandate from the gateway side.

Mandate Info Mandate Status

string <= 64 characters

optional

The status of the mandate from the gateway side.

Processing Options Check Duplicated

boolean

optional

Specifies whether a duplication check is performed when creating a payment method.

By default, this value is set to false. When set to true, Zuora checks both active and closed payment methods associated with the same billing account to prevent duplicate entries.

For more information, see Duplication check on payment methods.

Skip Validation

boolean

optional

Default: false

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

Type*

string

required

Type of payment method

Tokenize

boolean

optional

Default: false

When creating a BACS payment method on Adyen v2.0, set this field to true to enable recurring payment processing. For additional requirements, see Overview of Adyen Integration v2.0.

Tokens Token Id*stringrequiredPass in the first token of the payment method. For more information, see Overview of Stripe payment gateway integration.
Tokens Gateway Type*stringrequiredThe type of the payment gateway to generate the tokens. This field is case-sensitive. Value: Stripe.
Tokens Second Token IdstringoptionalPass in the second token of the payment method. For more information, see Overview of Stripe payment gateway integration.
Tokens Third Token IdstringoptionalPass in the third token of the payment method.

Last updated: May 7, 2026