Client Parameters for Payment Pages 2.0

The initial authorization amount.

Specify a numeric value greater than 0.

This value overrides the default authorization amount set for the specific payment gateway.

 This amount will be automatically voided unless used in conjunction with 3D Secure.

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.

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

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.

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

Only available for 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.

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."

Zuora Id of the customer account.

A payment method can be tied to a Zuora account using this parameter. An orphan payment method must be associated with an account within 10 days. Otherwise, it will be deleted.

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

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.

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

See Generate the Digital Signature for Payment Pages 2.0 about obtaining the public key through the REST API.

See Configure Payment Pages 2.0 about obtaining the public key in the Zuora UI.

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.

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.

See below for more information about these options.

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.

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.

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.

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. 

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.

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.

This parameter overrides the credit card "Accepted Types" set up for your payment gateway. Supported values are: 

• Visa
• MasterCard
• AmericanExpress
• Discover
• Dankort

Specify a comma-separated list of values with no space in between, e.g., "AmericanExpress, Visa, MasterCard". Payment Page will display the specified credit card type icons in the order given in the value.

If you do not specify this parameter, the credit card "Accepted Types" displays the following credit card types by default:

• Visa
• Mastercard
• Discover

Use this parameter to block end users in blacklisted cities from creating credit card payment methods. If end users specify blacklisted cities in the City field when entering their credit card information, an error message is displayed and the payment method cannot be created. 

Note that you can also localize the blacklist cities and error messages.

Use this parameter to always allow end users in whitelisted cities to create credit card payment methods. 

Note that you can also localize the whitelisted cities and error messages.

Use this parameter to allow end customers to view and edit their existing credit card payment method information, and re-authenticate the credit card upon submission.

Except for card number and cardholder name, all other credit card fields are available for editing.

This field maps to the refId field in the response.