At the root of the skin zip is a plain text file called skin.properties. This is a file in the format of key=value, comments can be included by prefixing the line with #.
All properties are optional, but it is highly recommended to set the ‘version’ property with a value of ‘2’, as all skinning documentation relates to version 2.
|
Property (case sensitive)
|
Required
|
Example
|
Default
|
Description
|
Available in skin versions
|
|---|---|---|---|---|---|
| version | Yes | 2 | 1 | The version of the hosted skinning system to use. This should be ‘2’, all of the documentation here covers skinning version 2. | 1 & 2 |
| charset | No | UTF-8 | The character encoding to present to the browser when serving css and javascript from the skin. If omitted the character set will be determined by best guess from looking at the file contents. | 1 & 2 | |
| favicon | No | images/favicon.ico | Path to a file within the skin zip to use as the favicon. For favicon support in older versions of IE we recommend using a .ico file. | 1 & 2 | |
| cardNicknameField | No | none | all | Controls whether the card nickname field is displayed on the form for the user to enter a value
Possible values are
|
2 |
| validFromField | No | newCard | all | Controls whether the valid from or start date fields are shown on the form.
Possible values are |
2 |
| issueNumberField | No | newCard | all | Controls whether the card issue number field is shown on the form.
Possible values are |
2 |
| addressLine1Field | No | all | all | Controls whether the billing address line 1 field is shown on the form. If provided by the card holder it will be used for AVS checks.
Possible values are |
2 |
| addressLine2Field | No | all | all | Controls whether the billing address line 2 field is shown on the form.
Possible values are |
2 |
| addressLine3Field | No | none | all | Controls whether the billing address line 3 field is shown on the form.
Possible values are |
2 |
| addressLine4Field | No | none | all | Controls whether the billing address line 4 field is shown on the form.
Possible values are |
2 |
| cityField | No | none | all | Controls whether the billing address city field is shown on the form.
Possible values are |
2 |
| regionField | No | none | all | Controls whether the billing address region field is shown on the form.
Possible values are |
2 |
| postcodeField | No | newCard | all | Controls whether the billing address postcode field is shown on the form. If provided by the card holder it will be used for AVS checks.
Possible values are |
2 |
| countryField | No | none | all | Controls whether the billing address country field is shown on the form.
Possible values are |
2 |
| telephoneField | No | all | none |
Controls whether the telephone number field is shown on the form. Possible values are If the value in the Hosted session initialisation request, or already saved to the customer, is a valid telephone number with international dialling code (e.g. “+441234567890”) then this will be pre-populated. Otherwise, the field will be left empty. If the cardholder does not provide a value, an existing telephone number may be used instead. |
2 |
| emailAddressField | No | all | none |
Controls whether the email address field is shown on the form. Possible values are |
2 |
| includeJquery | No | true | true | Specifies whether or not to include the jQuery javascript library. The version included is controlled by the jqueryVersion property.
Possible values are Most of the provided javascript libraries and utilities depend on jQuery, so disabling jQuery will disable them as well. See https://jquery.com/ for more information. |
2 |
| jqueryVersion | No | 1.12 | 1.12 | Specifies the major and minor jQuery library version to be included. The actual version will be the latest available in the minor version line.
Possible values are | 2 |
| includeRespond | No | true | true | Specifies whether or not to include Respond javascript library, which is a utility to make older versions of Internet Explorer support responsive css media queries.
Possible values are See https://github.com/scottjehl/Respond for more information. |
2 |
| includeHtml5Shiv | No | true | true | Specifies whether or not to include the HTML5Shiv javascript library, which is a utility to make older versions Internet Explorer support HTML5 sectioning elements.
Possible values are See https://github.com/aFarkas/html5shiv for more information. |
2 |
| includeBootstrap | No | true | true | Specifies whether or not to include the Bootstrap CSS and javascript libraries, which provide cross browser support layout and styling. This requires jQuery to be included.
Possible values are See http://getbootstrap.com/ for more information |
2 |
| bootstrapVersion | No | 3.3 | 3.3 | Specifies the major and minor Bootstrap javascript and CSS versions to be included. The actual version will be the latest available in the minor version line.
Possible values are Note that due to library compatibility, if version |
2 |
| includePaymentMethodLogic | No | false | true | Specifies whether or not to include a Pay360 javascript library for enhancing the payment method form. The main feature is to only show details of the currently selected payment method when there are multiple available.
Possible values are |
2 |
| includeClientValidation | No | false | true | Specifies whether or not to include client side validation javascript.
Possible values are |
2 |
| formEntry | No | false | true | Specifies whether or not to include the enhanced form entry behaviour javascript. This includes such features as blocking non-numeric characters from being typed into numeric only fields. See Skin JavaScript for more details.
Possible values are |
2 |
| cardBrandLookup | No | false | true | Specifies whether or not to include a card brand lookup as the card number is being typed. This is a basic lookup based on the first two digits of the card only. When the card has been detected a brand logo will be put onto the page next to the card number field.
Possible values are |
2 |
| cardInfo | No | false | By Account Configuration | Specifies whether or not to use the enhanced card brand lookup, using a full card BIN library. This gives far more accurate card type detection. To have this feature enabled speak to your account manager.
Possible values are |
|
| showBrandLogos | No | true | true | Specifies whether or not brand logos are shown on the new card payment page. This consists of a selection of card brand logos at the top of the payment page, and if PayPal is enabled then a PayPal logo is also shown next to the payment method selector.
Note that a card logo will still be shown next to saved cards. That cannot be disabled with a skin property. Possible values are |
2 |
| cardLogos | No | mastercard,visa,amex | visa,mastercard | If brand logos are being shown, then this specifies which card logos are listed at the top of the payment page, and in what order. Brands should be listed in lowercase and separated by a comma with no white space. The available brands are:
|
2 |