WorldPay
WorldPay is a third party supplier which is integrated with ebs to process online payments. You must contact WorldPay to agree a contract.
Note: Integration is not part of the ebs: ontrack Learner Hub service profile and this is usually carried out by your IT Technical team. This service is available from your Professional Service Consultants if required.
WorldPay requires an institution to have an installation ID for each system in use. Unless you are transferring an installation ID to the ebs: ontrack Learner Hub online ePayment system you will need a new installation ID.
If you are a new customer to WorldPay you must create an account with them and obtain an installation ID. This will provide you with customer information to allow you to log in to the WorldPay website where your installation ID can be managed.
The institution settings for WorldPay are configured on the following screens (accessed from the Product Modules pane):
ePayments (Self-Service)
The institution settings on the ePayments Self-Service) screen for WorldPay are shown below.
The fields on the ePayments (Self-Service) screen that are relevant to WorldPay are described in the following table. It is recommended that unused fields are left blank.
| This field | Holds this information... |
|---|---|
| ePayment version | The electronic payment provider being used for ebs: ontrack Learner Hub. Select WorldPay from the drop-down list. |
| ePayment URL |
The URL provided by WorldPay. This should be in one of the following formats:
Note: This field must include the URL of your payment provider. |
| Payment Account ID | The WorldPay installation ID, displayed on the WorldPay Installation Administration screen. |
| Payment Account Key |
This field holds the payment secret key for transactions. Populating this key will block the transaction payment if the url is modified in any way. The value must match exactly the value set in the Worldpay admin console (MD5 Secret for transactions) If set, then the WorldPay Signature Fields should also be set to “cartId:amount:currency:instId” Note: This field is optional but recommended |
| Payment Security Key | The WorldPay administration account password. |
| Only use default account code for payments | It is recommended this field is set to N for WorldPay. |
| Payment Merchant Reference |
The payment merchant reference for WorldPay. Note: This will be displayed on all statements. The merchant reference is also displayed in the left-hand pane of the WorldPay Installation Administration screen. |
| Default Account Code |
The default account code. Note: You only need to select an option from the drop-down list when the ‘Only use default account code for payments’ setting is set to Y. |
| Default Payment Email Address |
The email address to which transaction emails are sent. Note: You only need to enter an email address if it is different to the email address specified in the Payment Response Failure Email Address field on the WorldPay Installation Administration screen. |
| Field to use as payment booking reference | It is recommended this field is set to COURSE_DESCRIPTION for WorldPay. |
| Generate single fee line, use default account code and VAT code only (SCP Only) | It is recommended this field is set to N for WorldPay. |
| Only use default VAT code for payments | It is recommended this field is set to N for WorldPay. |
| Default VAT code | The default VAT code to use for WorldPay. |
| ePayment failure message (Prospect) | The message displayed to learners in ebs: ontrack Learner Hub when payment fails in the institution's payment provider. |
ePayments (Staff)
The institution settings on the ePayments (ebs: central) screen for WorldPay are shown below.
The fields on the ePayments (Staff) screen that are relevant to WorldPay are described in the following table. It is recommended that unused fields are left blank.
| This field | Holds this information... |
|---|---|
| ePayment version | The electronic payment provider being used for ebs: central. Select WorldPay from the drop-down list. |
| ePayment URL |
The URL provided by WorldPay. This should be in one of the following formats:
Note: This field must include the URL of your payment provider. |
| Payment Account ID | The WorldPay installation ID, displayed on the WorldPay Installation Administration screen. |
| Payment Account Key |
This field holds the payment secret key for transactions. Populating this key will block the transaction payment if the url is modified in any way. The value must match exactly the value set in the Worldpay admin console (MD5 Secret for transactions) If set, then the WorldPay Signature Fields should also be set to “cartId:amount:currency:instId” Note: This field is optional but recommended |
| Payment Security Key | The WorldPay administration account password. |
| Only use default account code for payments | It is recommended this field is set to N for WorldPay. |
| Payment Merchant Reference |
The payment merchant reference for WorldPay. Note: This will be displayed on all statements. The merchant reference is also displayed in the left-hand pane of the WorldPay Installation Administration screen. |
| Default Account Code |
The default account code. Note: You only need to select an option from the drop-down list when the ‘Only use default account code for payments’ setting is set to Y. |
| Default Payment Email Address |
The email address to which transaction emails are sent. Note: You only need to enter an email address if it is different to the email address specified in the Payment Response Failure Email Address field on the WorldPay Installation Administration screen. |
| Field to use as payment booking reference | It is recommended this field is set to COURSE_DESCRIPTION for WorldPay. |
| Generate single fee line, use default account code and VAT code only (SCP Only) | It is recommended this field is set to N for WorldPay. |
| Only use default VAT code for payments | It is recommended this field is set to N for WorldPay. |
| Default VAT code | The default VAT code to use for WorldPay. |
| The Method of Transfer That ebs: central Uses For ePayments | The method of transfer that ebs uses for ePayments. |
The following configuration information for WorldPay is also applicable:
Website compliance
WorldPay requires you to ensure that your website displays the following:
- Refund policy
- Currencies
- Payment logos
- Company details
Installation ID
You need to manage your installation ID to use WorldPay. You must configure both test and live ebs: ontrack Learner Hub environments through the Systems Settings section.
This provides access to the Installations page where the settings for both the test and live system URLs are available.
It is also important to set up the installation ID content correctly on the Installation Administration page. For example: the Use 3D Secure Authentication? and Use Mastercard SPA ? fields are set to False on initial setup and need to be set to True.
Activate WorldPay
After local testing, you need to inform WorldPay when you want to use the live system. The institution should do this by submitting the activation request form.
To submit your activation request form:
- Log in to the Merchant Interface using your username and password on the WorldPay website.
-
Click the Installations option in the left-hand pane.
The Installations page is displayed.
- Select the check box in the Request Activation column for the installation you want to make live.
-
Click Save.
The Activation Request Form page is displayed.
- Enter the URL of your website.
- Select the check box to confirm the URL is correct.
- Provide brief instructions on how to complete a test purchase from your website (that is: login details to access and test your website).
-
Select the check box to confirm your website is compliant with the WorldPay website rules.
Note: Failure to comply with these rules will delay the activation of your account.
-
Click Save Changes.
An email is sent to confirm that WorldPay has been activated.
The data sent to WorldPay when making a payment is described in the following table.
| Value | Source | Notes |
|---|---|---|
| InstId | Payment Account Id | As defined in institution settings |
| CardId | The ePayment transaction ID | Generated from the EPAYMENT_TRANSACTION_ID_SEQ DB sequence when creating the payment |
| amount | The total amount being paid | - |
| currency | The CurrencyCode institution setting ('CurrencyCode') | - |
| MC_Callback | The URL used to report back the status of the payment | This is the server path appended with /epayments/PaymentResponse.aspx?pid={payment_token} |
| name | FullName from the payment details | - |
| Email Address from the payment details | - | |
| testMode | '100' |
Only sent when ProviderPaymentTestMode is set to True To enable test mode, you must set the IIS > TribalTech.EBS.Web.Services > web.config file parameter |
| accId1 | The Payment Merchant Reference institution setting | - |
| address1 | AddressLine1 from the payment details | - |
| address2 | AddressLine2 from the payment details | - |
| address3 | AddressLine3 from the payment details | - |
| town | Town from the payment details | - |
| region | Region from the payment details | - |
| postcode | Postcode from the payment details | - |
| country | Country from the payment details | - |
Note: Refer to PCI Compliance for further information about how ebs interacts with WorldPay.