Client Parameters for Payment Pages 2.0
This document outlines the parameters for customizing and rendering Payment Pages 2.0, including gateway options and payment flow implementations.
This article describes the parameters used for customizing and rendering Payment Pages 2.0.
To use the following parameters in Payment Pages 2.0, specify the parameters in a JavaScript object with key-value pairs and pass them to the Z.render function in your client.
If you include the 1.0.0 version of the Zuora JavaScript library, the values for all parameters must be URL encoded except for the url parameter. For example, "ABC DEF" must be specified as "ABC%20DEF". Even if you include the 1.0.0 version, you should not encode the url parameter.
If you include the 1.1.0 or above version of the Zuora JavaScript library, the values are automatically encoded, and you should not encode the parameter values.
Gateway Options
Using the Gateway Options fields, you can submit additional information to the payment gateway associated with the Payment Page. The Payment Pages 2.0 forms can take key-value pairs to be sent as part of the gateway options when the payment method is created. Use the following format to append the key-value pairs:
param_gwOptions_[Key]:[Value]
For example, if you want to change the currency of the credit card authorization call from the default currency for the CyberSource gateway, you can set the following parameter to change the authorization request from the default currency, AUD, to JPY. CyberSource uses the purchaseTotals_currency key to set the currency:
param_gwOptions_purchaseTotals_currency:"JPY"
The Gateway Options feature is not supported by all gateways that are integrated with Zuora. For information about parameters that can be supported by each gateway and the appropriate key to use in the key-value pairs, see the specific gateway integration article . Zuora sends all the information that you specify to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.
Parameters for implementing payment flows
In the Z.render function, you can pass in additional parameters to support processing one-time payments or recurring payments in payment flows. For details about these parameters, see Implement Payment Pages 2.0 to support one-time payment flows .