Payment Methods Becs
This reference document lists the data dictionary fields for the Becs payment method.
|
Field name |
Value |
Required to update |
Description |
|---|---|---|---|
|
Account Number* |
string |
required |
The customer's bank account number. |
|
Account Key |
string |
optional |
Use either the customer account ID (for example, 2x92c0f859b0480f0159d3a4a6ee5bb6) or the customer account number (for example, A02855638). If you want to create a payment method that is not initially linked to any customer account (an orphan payment method), you can omit this field. Once the account details become available, you can associate the payment method with the appropriate account using the Update Payment Method operation. |
|
Account Mask Number |
string |
optional | The masked account number (for example, ****1234). |
|
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 specified, Zuora will use the default payment gateway associated with the customer account that owns the payment method when the accountKey field is provided; otherwise, it will use the default payment gateway configured for your Zuora tenant. |
|
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 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 both the city and country during payment method creation is recommended, as this information is used for payment processing; if omitted, these details will not be available 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. |
|
Branch Code* |
string |
required |
The bank branch code used for direct debit. |
|
Currency Code |
string |
optional |
The currency used to authorize payments for the payment method. |
|
IP Address |
string |
optional |
The IPv4 or IPv6 address of the user at the time the payment method is created or updated. Some payment gateways use this information for fraud prevention. When provided, Zuora passes the value directly to the gateway. The maximum supported length is 45 characters; exceeding this limit results in a validation error. This field is required when validating SEPA payment methods on Stripe v2. |
|
makeDefault |
boolean |
optional | Indicates whether this payment method should be set as the default for the customer account that owns it. The default value is false, and this field applies only when the accountKey field is provided. When set to true, ensure that the payment method is supported by the account's 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 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 value is false. When set to true, Zuora checks both active and closed payment methods associated with the same billing account to prevent duplicate payment methods from being created. For more information, see Duplication check on payment methods. |
|
Skip Validation |
boolean |
optional | Indicates whether to skip validation of the payment method information with the payment gateway. The default value is false. This field can be set to true to bypass validation, for example, when migrating existing payment methods. |
|
Type* |
string |
required |
The type of payment method. |