Windcave payment gateway
The Windcave payment gateway allows you to create a Windcave payment gateway, providing users to process credit card transactions to pay for their items. To use the Windcave payment gateway, you will need a Windcave account at the Windcave website.
The Windcave online payment gateway and ecommerce solutions cater to several banks worldwide; however, they may not be available in all regions. Please check the Windcave website for more information on the availability of this payment gateway.
The Windcave payment gateway accepts all major credit card types, including Visa, Mastercard, Amex, Diners, BankCard, and JCB. Some co-branded cards are also accepted, such as Farmers, AirNZcard, and Elders. For more information, visit the Windcave website.
Once you have added a Windcave payment gateway, you can configure its associated asset screens' settings. The majority of these screens are the same as a standard page and are described in the Asset screens manual. This chapter describes the details and display formatting screens, which are different for a Windcave payment gateway.
Details screen
The Details screen allows you to configure the settings of the Windcave payment gateway.
Read the Asset details screen documentation for more information about the status, future status, thumbnail, and details sections.
Payment express account details
This section allows you to enter your account details, allowing you to accept payments from the payment gateway.
In the client and password fields, enter your account details, supplied to you by Windcave. To accept payments from the Windcave gateway, you will need an internet merchant account from your bank and apply for a Windcave account at the Windcave website.
Configuration
This section allows you to configure the currency and transaction type settings of the Windcave payment gateway. The fields that are available in this section are as follows:
- Currency
-
Select the currency used in all ecommerce transactions processed by the Windcave payment gateway. The options available are as follows:
-
Canadian dollar (CAD)
-
Swiss Franc (CHF)
-
Euro (EUR)
-
French Franc (FRF)
-
British Pound (GBP)
-
Hong Kong Dollar (HKD)
-
Japanese Yen (JPY)
-
New Zealand Dollar (NZD)
-
Singapore Dollar (SGD)
-
United States Dollar (USD)
-
South African Rand (ZAR)
-
Australian Dollar (AUD)
-
Samoan Tala (WST)
-
Vanuatu Vatu (VUV)
-
Tongan Pa’anga (TOP)
-
Samoan Islands Dollar (SBD)
-
Papua New Guinean Dollar (PGK)
-
Malaysian Ringgit (MYR)
-
Kuwaiti Dinar (KWD)
-
Fijian Dollar (FJD)
-
- Transaction type
-
Select the transaction type to use. The options available are as follows:
-
Purchase
-
Auth (this type can be used to set up recurring billing)
-
Complete
-
Refund
-
Validate (this type can be used to set up recurring billing)
-
- Extra parameters
-
Specify additional key and value pairs that will be passed to the payment processing server. To enable recurring billing, you will need to set
EnableAddBillCard
to1
. Pass-through variables can also be used here using a particular keyword,%pass_through_variablename%
.
The full transaction response XML is displayed on the order’s Details screen.
It’s stored in the attribute of order called transaction_response
.
If you are using a listing page to list the orders, you can use the ^xpath
keyword modifier in the display format to print values from the XML data.
For example, to print the DPS generated billing ID for the order, use the following keyword: %asset_attribute_transaction_response^xpath:://DPSBILLINGID%
.
Address verification system property (AVS)
This section allows you to use the address verification service (AVS) system as added security for credit and debit card transactions made on the Windcave payment gateway. Please note that this system is not available in all countries.
Select Check requirements of the AVS system for a transaction to succeed
in the Standard policy field.
The following options are available:
- No
-
No AVS check will be made.
- Attempt AVS check
-
An AVS check will be performed if the address information is supplied; however, this check is not mandatory for a transaction to succeed.
- The transaction needs to be checked by AVS
-
The AVS system must check all transactions made on the Windcave payment gateway. If an AVS check cannot be completed, the transaction will fail.
If AVS is enabled, address fields must be included on the payment gateway using keyword replacements. For more information, refer to the Display formatting screen section in this chapter. Alternatively, Pass-through variables can be configured to source the address from the user’s ecommerce form responses.
Card verification 2 code property (CV2)
This section allows you to use the card verification value (CV2) system as added security for credit and debit card transactions made on the Windcave payment gateway.
Select the Check requirements of the CV2 system for a transaction to succeed
in the Standard policy field.
The following options are available:
- No
-
No CV2 check will be made.
- Attempt CV2 check
-
A CV2 check will be performed if the card verification value is supplied; however, this check is not mandatory for a transaction to succeed.
If CV2 is enabled, the CV2 field should be included on the payment gateway using keyword replacements, as described in the Display formatting screen section.
Pass-through variables
This section allows you to source address information for the address verification service (AVS) from the user’s ecommerce form responses. For example, a user’s response to a Postcode field on an ecommerce form could be passed through to the Windcave payment gateway to provide the AVS postcode. The Pass-through variables section of the Details screen is shown:
In the available fields, enter the pass-through variable keys for the corresponding form fields. These keys must be configured on the Ecommerce rules screen of the Ecommerce form page. For more information, refer to the Ecommerce rules screen section of the E-commerce form page chapter in this manual. The fields that are available in this section are as follows:
- Address 1 variable name
-
Enter the Pass-through variable key for the first line of the address.
- Address 2 variable name
-
Enter the Pass-through variable key for the second line of the address.
- Address 3 variable name
-
Enter the Pass-through variable key for the third line of the address.
- Address 4 variable name
-
Enter the Pass-through variable key for the fourth line of the address.
- Postcode variable name
-
Enter the Pass-through variable key for the address postcode.
Interface options
This section allows you to change the button and error text for the payment gateway.
The fields that are available in this section are as follows:
- Submit button text
-
Enter the text to display as the Submit button. By default, this button will read:
Pay
. This button is displayed when the keyword replacement Submit button is used on the display format bodycopy. - Reset button text
-
Enter the text to display as the Reset button. By default, this button will read:
Reset
. This button is displayed when the keyword replacement Reset button is used on the display format bodycopy. - Cancel button text
-
Enter the text to display as the Cancel button. By default, this button will read:
Cancel
. This button is displayed when the keyword replacement Cancel button is used on the display format bodycopy. - Amount not specified error
-
Enter the text to display when no transaction amount is specified the payment gateway. By default, this error will read:
No amount is specified for payment
. - Card number not specified error
-
Enter the text to display when the user provides no card number. By default, this error will read:
No card number is specified for the payment
. - Expiry date invalid error
-
Enter the text to display when the user-provided expiry date is invalid. By default, this error will read:
The expiry date (mm/yy) is not valid
. - Start date invalid error
-
Enter the text to display when the user-provided start date is invalid. By default, this error will read:
The start date (mm/yy) is not valid
. - Issue number invalid error
-
Enter the text to display when the user-provided issue number is invalid. By default, this error will read:
The issue number is invalid (must be one or two digits long)
. - Card CV2 not specified error
-
Enter the text to display when no verification value is specified for the card. By default, This error will read:
No CV2 is specified for the card
. - Card CV2 invalid error
-
Enter the text to display when the user-provided card verification value is invalid. By default, this error will read:
The card CV2 is invalid (must be three or four (only American Express card) digits long)
. - Street address not specified error
-
Enter the text to display when the user specifies no street address. By default, this error will read:
The address is not specified
. - Postcode not specified error
-
Enter the text to display when the user specifies no postcode. By default, this error will read:
No postcode is specified
.
Testing mode
This section allows you to modify the payment gateway to function in test mode.
In the Test mode field, select whether to use the payment gateway for testing purposes only.
If this field is set to On
, the payment gateway will not process any payments.
Additionally, the Number field on the Windcave payment gateway form will be replaced with the test drop-down menu.
Display formatting screen
The Display formatting screen allows you to edit the display format bodycopy. To edit this bodycopy:
-
Right-click on the display format bodycopy in the asset tree.
-
Select Edit contents.
Display format bodycopy
The display format bodycopy is used to define the layout of the Windcave payment gateway page.
To change the information that is being shown:
-
Click on the icon – the WYSIWYG editor will appear.
-
Use the keyword replacements and formatting to set the information’s layout to show on the payment gateway page.
By default, the information shown in the figure will appear in the WYSIWYG editor.
By default, the Windcave payment gateway’s transaction amount will be listed in British pounds. This setting may need to be changed depending on the currency you have selected on the Details screen. |
Keyword replacements on the display format bodycopy
A list of keyword replacements is provided in the WYSIWYG editor tool baron the Edit contents screen of the display format bodycopy. You can use these keyword replacements in conjunction with text, images, and links to configure the payment gateway page’s layout. The standard keyword replacements that are available include the following:
- Card number
-
This will show the credit card number field.
- Name on card
-
This will show the cardholder name field.
- Card start month
-
This will show the credit card start month field.
- Card start year
-
This will show the credit card start year field.
- Card expiry month
-
This will show the credit card expiry month field.
- Card expiry year
-
This will show the credit card expiry year field.
- Card issue number
-
This will show the card issue number field.
- Card CV2
-
This will show the card verification value (CV2) field. This value is required for CV2 verification checks.
- Address line 1
-
This will show the first line of the street address field.
- Address line 2
-
This will show the second line of the street address field.
- Address line 3
-
This will show the third line of the street address field.
- Address line 4
-
This will show the fourth line of the street address field.
- Postcode
-
This will show the postcode field.
- Transaction amount
-
This will show the amount of money that is to be paid in the transaction.
- Transaction currency
-
This will show the transaction currency. For example, AUD.
- Processing error(empty if no error)
-
This will show any processing errors. For example, if the user forgets to fill out a field.
- Submit button
-
This will show the Submit button.
- Cancel button
-
This will show the Cancel button.
- Reset button
-
This will show the Reset button.
A number of these fields are compulsory when creating an active payment gateway. If the required fields are not available to the user, the transaction can not complete successfully.