Customizing Z-Payments Page

Overview

After setting up the Z-Payments Page for your site, you can use additional features to customize how you use Z-Payments Page. 

Preloading Data into iFrame

The hosted page can be loaded with values prefilled in the input fields (or hidden fields) that are passed in as parameters. To preload a field, append the following parameter to the URL (these do not need to be signed) in the format field_[Field Name].

For example, to select Visa by default: &field_creditCardType=Visa

You use this method to prefill any field with values. A full list of the of the input fields can be found in the Z-Payments Page fields section.

Passing Information to the Callback Page

The hosted page can accept five passthrough parameters that will be appended in the callback. This is useful for merchants who would like to have specific pieces of information returned to the callback path (e.g. internal confirmation numbers, version test codes, etc.) The parameters are:

• field_passthrough1
• field_passthrough2
• field_passthrough3
• field_passthrough4
• field_passthrough5

The values of these fields can only be set by preloading (see "Adding Support to Preload Data," above). For every field that is passed in, they will be sent back to the callback URL using the same name.

For example, for a request like the following:

http://hosted.zuora.com/hostedpage.jsp?id=4028e697325f8e970132603326446b33&tenantId=1054&timestamp=1316846058928&token=7av18bEz97Jrq9K6z0QPyvJpIqIxSmZc&signature=ob9JgZMaq5cidMmKXnw9dg%3D%3D&field_passthrough1=Capture&field_passthrough2=Step2

The callback would look like the following:

http://hosted.zuora.com/callback.jsp?id=4028e697325f8e970132603326446b33&tenantId=10514
timestamp=1316846058955&token=7av18bEz97Jrq9K6z0QPyvJpIqIxSmZc&responseSignature=ODU2ODMyZmY5YmFjNDQzZDQ4NmU2MDg3ODNkNzhlNTc=&success=true&refId=4028e4862ba3fcae012bad2c19e115b4&field_passthrough1=Capture&field_passthrough2=Step2

Overriding the Configuration

The credit cards logos shown Z-Payments Page are configured when you set up your payment gateway in the Zuora application. However, the merchant has the ability to dynamically overwrite the credit card "Accepted Types" configuration by passing in a comma-separated value into the hosted page. If a value has been passed in, the configuration will be ignored. If a value has not been passed in, the configured values will be shown on the iFrame.

For example, if your gateway is configured to accept Visa, MasterCard, and Amex but you want to only show Visa and Mastercard on your iFrame - you would pass in the following to the iFrame URL:

&param_supportedTypes=Visa,MasterCard

Sending Gateway Options

Gateway Options is a feature that allows merchants to pass additional parameters to the payment gateway that currently are not supported by the Z-Payments Page.  This is particularly useful for merchants who want to do customized reporting with payment gateways, such as Cybersource and Verifi.  

The merchant has the option to submit information to the payment gateway associated with the hosted page. The hosted page can take key/value pairs to be sent as part of the gateway options when the payment method is created. Use the format param_gwOptions_[Key]=[Value] to append the key/value pairs.

For example, if you wanted to pass in the following parameters: 

globalIPaddress = someaddress123

Then you owuld append the following to the iFrame URL:

&param_gwOptions_globalIPaddress=someaddress123

This will construct an option of x_company key and ABC Company value, which will be sent to the payment gateway.

For example, for a request, this would look like the following:

http://hosted.zuora.com/hostedpage.jsp?id=4028e697325f8e970132603326446b33&tenantId=1051&timestamp=1316846058928&token=7av18bEz97Jrq9K6z0QPyvJpIqIxSmZc&signature=ob9JgZMaq5cidMmKXnw9dg%3D%3D&param_gwOptions_globalIPaddress=someaddress123

Related