Collecting customer data

Usually Payment Page requires a bare minimum of data to complete a request for payment through a payment system selected by the customer. However, in order to gather more extensive data and statistics about customers you can send and/or request additional data about your customers, such as customer phone number or email.

How it works

Payment Page supports gathering data for specific parameters. It is specified for each parameter whether it is hidden or not and whether it is required or not. The required parameters are displayed to the customer, even if they are hidden by default and the values are not passed in the object or request. The specifics of how parameters are displayed in the widget are given in the Displaying fields on the payment widget according to the settings and the sent parameters table.

The general flow of collecting additional parameters is the following:

1. For a project the parameters which need to be collected are enabled in Payment Page. For each parameter it is specified whether it is hidden and whether it is required.
2. In the object or request to Payment Page your system sends parameters, whose values are known or need to be reconfirmed.
3. For a customer Payment Page displays fields for gathering data in accordance with the settings and the passed parameters.
4. The customer fills in the required and optional fields and initiates the payment.
5. Payment Page aggregates data collected from the request and the data specified by the customer and sends it to Gate.

The capability is supported when card data encryption script is used.

Table 1. Displaying fields on the payment widget according to the settings and the sent parameters

Required?	Field is hidden?	Value passed in parameter?	Result
			The field is hidden, the parameter is sent to the payment platform without changes
			The field is hidden, the parameter is sent to the payment platform without changes
			The field is displayed as a required filed. The gathered data is sent to the payment platform
			The field is hidden, the parameter is not sent to the payment platform
			The field is displayed as a required field with the received value filled in. The value specified by the customer is sent to the payment platform
			The field is displayed as an optional field with the received value filled in. The value specified by the customer is sent to the payment platform
			The blank field is displayed as a required field. The value specified by the customer is sent to the payment platform
			The blank field is displayed as an optional field. If the value is specified by the customer it is sent to the payment platform

Features of displaying some of the parameters

For the customer_country and billing_country parameters the widget displays the list of countries. The country to be displayed by default can be specified according to received parameter.

Widget layout specifics

• The field titles can be changed from the default settings.
• If the data collection has been enabled for only one parameter, the filed is displayed on the step of entering payment data.
• If the gathering of the data has been enabled for two or more parameters, the fields are displayed on the next step.

Enabling the feature

To enable and configure functionality, you must specify the parameters for which you want to collect the data. You can specify only the parameters you need: one, several or all of them. For each parameter, you must specify whether it must be mandatory and whether it must be hidden, as well as the name of the field on the payment widget.

For the full list of the supported parameters see Parameters for data collection.

Table 2. An example of the list of parameters required to set up gathering of customer data

Parameter	Required	Hidden	Field name in widget
customer_email			Default

Parameters for data collection

The parameters for which the data collection is supported are listed in the table below. The Payment Page settings determine if these parameters are required or not.

For the full list of parameters supported by Payment Page see Payment Page invocation parameters.

Table 3. Parameters to pass for collecting additional customer data

Parameter	Required	Format	Description	Example
customer_first_name		string	Customer first name	Jane
customer_middle_name		string	Customer middle name	Mary
customer_last_name		string	Customer last name	Smith
customer_phone		string	Customer phone number. Must include the country code and contain from 4 to 24 digits without punctuation or special characters	44991234567
customer_email		string	Customer e-mail	johndoe@example.com
customer_country		string	Country of the customer address, in ISO 3166-1 alpha-2 format	UK
customer_state		string	State or region of the customer address	Greater London
customer_city		string	City of the customer address	London
customer_address		string	Street of the customer address	01 Main Street
customer_zip		string	Postcode of the customer address	RdWC2N 5DU
customer_day_of_birth		string	Customer date of birth, DD-MM-YYYY	12-12-1990
customer_birthplace		string	Customer place of birth	London
customer_ssn		integer	The last 4 digits of US social security number	1234
billing_postal		string	Postcode of the customer billing address	101000
billing_country		string	Country of the customer billing address, in ISO 3166-1 alpha-2 format	UK
billing_region		string	Region or state of the customer billing address	Greater London
billing_city		string	City of the customer billing address	London
billing_address		string	Street of the customer billing address	33 Store Street