authorizationAmount

Optional

The initial authorization amount.

Specify a numeric value greater than 0.

This value overrides the default authorization amount set for the specific payment gateway. For more detailed information, see Set up payment gateways

The amount will be passed to the payment gateway to authorize the payment method in a 3DS2 transaction. The end user will not be charged unless it is a one-time payment flows for creating a payment method and processing the one-time payment transaction ( doPayment is true ).

checkDuplicated

Optional

Indicates whether to perform a duplication check when you create a payment method of the following types:

• Credit Card

• ACH

• Bank Transfer

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.

countryBlackList

Optional

List of ISO alpha-3 country codes to not be displayed from the default list of countries. If countryBlackList is used, countryWhiteList must not be used. For a complete list of supported ISO alpha-3 country codes, see View countries or regions.

Example: countryBlackList, "USA,CAN,CHN" will result in United States, Canada, and China not appearing in the displayed list of countries.

countryWhiteList

Optional

List of ISO alpha-3 country codes to be displayed from the default list of countries. If countryWhiteList is used, countryBlackList must not be used. For a complete list of supported ISO alpha-3 country codes, see View countries or regions.

Example: countryWhiteList, "USA,CAN,CHN" will result in only United States, Canada, and China appearing in the displayed list of countries.

documents

Optional

Only available for one-time payment flows 0/J_Implement_Payment_Pages_2.0_to_support_one-time_payment_flows--> .

An array of invoices to be paid in this transaction, containing the following fields:

• type - The value must be invoice .

• ref - The value must be the invoice number, such as INV0000001.

field_currency

Optional

The currency in which the initial authorization should be done. Specify a 3-letter ISO currency code.

This value overrides the default currency in the tenant when creating a payment method without a Billing Account.

If field_accountId is set, then the currency on the Account is used, regardless of the value passed here.

If both "field_currency" and "param_gwOptions_purchaseTotals_currency" are given, the "param_gwOptions_purchaseTotals_currency" parameter takes precedence over "field_currency."

field_accountId

Optional

Zuora Id of the customer account.

A payment method can be tied to a Zuora account using this parameter. When creating a payment method, it is recommended to associate the payment method with an account.

field_deviceSessionId

Optional

This field is only applicable to the Verifi Global payment gateway.

The session ID of the user when the Payment Method was created or updated. The gateway can use this field for fraud prevention.

field_gatewayName

Optional

The name of the payment gateway. Zuora recommends that you use the paymentGateway field instead.

field_ maxConsecutivePaymentFailures

Optional

Specifies the number of allowable consecutive failures Zuora attempts with the payment method before stopping.

field_passthrough[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15]

For example, field_passthrough1, field_passthrough2, field_passthrough14

Optional

Fields values to be sent back to the callback function or callback URL.

Use the fields to return the information that is not captured in your Payment Pages 2.0 form to the callback function or callback URL, such as internal confirmation numbers, version test codes. etc.

Due to the URL character limit of browsers, ensure that the total length of the render URL does not exceed 5,900 characters after passing in the field_passthrough parameters.

Note: Though a maximum of 15 passthrough parameters can be supported when passing in your client parameters, only the first 5 parameters are used for signature generation and validation.

field_paymentRetryWindow

Optional

The retry interval setting, which prevents making a payment attempt if the last failed attempt was within the last specified number of hours

field_useDefaultRetryRule

Optional

Determines whether to use the default retry rules configured in the Payments settings .

id

Required

ID of the Payment Pages 2.0 form configured. Id can be obtained from the link on page list view. See Generate the Digital Signature for Payment Pages 2.0 about retrieving the form id.

key

Required

Public key for encryption. The key can be generated from the configuration UI or from the rsa-signatures REST request.

See Obtain the Public Key for Payment Pages 2.0 for more information.

locale

Optional

Locale ID of the Payment Pages 2.0 form, such as, "en", "fr_CA".

Defaults to "en" if no corresponding resource bundle is available. See Translate and Localize Payment Pages 2.0 about uploading a resource bundle and assigning a locale to the resource bundle.

param_gwOptions_[option]

Optional

Payment gateway-specific information.

When the Payment Page is submitted, this option is submitted to the associated payment gateway. [option] is a gateway option for the specific payment gateway.

paymentGateway

Optional

Name of the payment gateway as set up in Payment Settings. Overrides the default gateway you set up during the Payment Page configuration.

Zuora recommends that you use this field instead of the field_gatewayName field.

retainValues

Optional

This parameter is used only for the inline style Payment Pages 2.0 forms with the external submit button.

Set to "true" to restore previously entered information to the Payment Pages 2.0 form when the form has an error upon submission.

Sensitive information, such as credit card number and card security code (CVV), is not saved and is always cleared when the form is reloaded.

Default is "false" which clears all the form fields upon reloading.

See Error Handling for Payment Pages 2.0 for detail information about the parameter.

signature

Required

Digital signature generated by the rsa-signatures REST request. See Generate the Digital Signature for Payment Pages 2.0 about obtaining the signature.

signatureType

Optional

Type of the digital signature generated for the callback page. Zuora supports the basic and advanced signatures for Payment Pages 2.0.

Set this to "advanced" to request Zuora to generate the advanced signature in the callback response. By default the basic signature is used in the callback response.

This parameter is applicable only for the advanced implementation with the Submit button outside of Payment Pages.

style

Required

Rendering style of the Payment Pages 2.0 form. Allowed values are:

• inline: Your Payment Page form is embedded within your commerce page.

• overlay: Your Payment Page form appears as an overlay when the form is loaded.

submitEnabled

Required

Flag to indicate that page submission is handled by Zuora or by the client site. The allowed values are:

• true: Indicates that page submission will be handled by Zuora. This setting causes the submit button rendered on the Payment Page form.

• false: Indicates that page submission will be handled by client. This setting causes the submit button rendered outside of the Payment Page form.

This setting is applicable only to the inline style forms and ignored for the overlay style forms.

tenantId

Required

Unique ID of your Zuora tenant

token

Required

Token generated from the rsa-signatures REST request. See Generate the Digital Signature for Payment Pages 2.0 about obtaining the token.

url

Required

Value of the Hosted Page URL field on the Payment Pages 2.0 configuration page.

Even if you include the 1.0.0 version of the Zuora library, you should not encode the url value.

See Preview Payment Pages 2.0 for retrieving this value.