Account Number*

string

required

Customer's bank account number.

Account Key

string

optional

The customer account ID (for example, 2x92c0f859b0480f0159d3a4a6ee5bb6) or customer account number (for example, A02855638).

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

Account Mask Number

string

optional

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

Account Holder Info Account Holder Name*

required

Account Holder Info Address Line1

string

optional

The primary address line for the account holder.

Account Holder Info Address Line2

string

optional

The secondary address line for the account holder.

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.

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.

Branch Code*

string

Required to Create

The bank branch code used for direct debit transactions.

Currency Code

string

optional

The currency used to authorize payments for the payment method.

Identity Number*

string

required

The identity number required for bank transfer transactions.

IP Address

optional

makeDefault

boolean

optional

Default: false.

Mandate Info Mandate Id

string <= 36 characters

optional

The mandate ID.

Mandate Info Mandate Reason

string <= 64 characters

Optional

The reason of the mandate as provided by the payment gateway.

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 creating a payment method. The default is false. When set to true, Zuora checks both active and closed payment methods associated with the same billing account to prevent duplicates.

For more information, see Duplication check on payment methods.

Skip Validation

boolean

Optional

Default: false.

Specifies whether to skip validation through the payment gateway. For example, set this field to true when migrating payment methods to bypass validation.

Type*

string

Required to Create

Type of the payment method.