Support online payments using WPM Education

Steps to integrate with WPM

1 About WPM
2 What information is sent to WPM when a payment is made?
3 Integrating your WPM account into your accessplanit platform
4 FAQ’s

Related Help Guide Pages

Learn how to set up an integration with the payment gateway WPM, to take payments through your platform or Shopping Basket.

Taking payments online is now the standard, and with our WPM integration, you can streamline your payment processes directly through our platform. WPM is is a Payment Platform has been developed specifically for the higher and further education sectors.

Follow this page to learn about accessplanit’s integration with WPM, and how to set it up.

Please note

WPM payments are not supported in our new basket ‘Checkout’.

About WPM

WPM’s Payment Platform has been developed specifically for the higher and further education sectors

Our integration with WPM allows for payments to be taken through WPM by your customers and Administrators.

Within the Shopping Basket, WPM operates as a ‘redirect’ type, this means that the User is directed to a WPM window to enter their card details and process their booking!
Read more about payment gateway integration types.

What information is sent to WPM when a payment is made?

When a payment is sent to WPM from your accessplanit platform, information is sent alongside the payment to provide more information to WPM.

WPM Requirements

The integration requires the use of two WPM custom fields:

CustomField1 is used to store the Course Template field 'Cost Centre'
CustomField2 is used to store the Shopping Basket ID

We recommend that you speak to WPM before integrating to ensure that this will not cause any problems with your financial data when payments are sent from accessplanit to your WPM system.

Order information

WPM field	WPM description	Sent from accessplanit
clientid	Provided by WPM	This is set up by you in the ‘WPM Details’ section in the ‘Account Finance Options’ page
requesttype	Always 1	Always ‘1’
pathwayid	Provided by WPM	This is set up by you in the ‘WPM Details’ section in the ‘Account Finance Options’ page
departmentid	Provided by WPM. Identifies where the post has come from	This is set up by you in the ‘WPM Details’ section in the ‘Account Finance Options’ page
staffid	To allow for "customer not present" transactions. Populate with Staff ID. Blank if non-staff	Nothing is sent for this
customerid	e.g. Student ID.	User ID
title	e.g. Mr, Mrs, Dr etc	Booking User Title
firstname	First Name	Booking User First name
middlename	Middle Name(s)	Booking User Middle Name
lastname	Last Name	Booking User Last Name
emailfrom	The from address used for the email confirmation	This is set up by you in the ‘WPM Details’ section in the ‘Account Finance Options’ page
toemail	The email address sent. This will be used to pre-populate the cardholder email field. The email address entered by the payer is what will be returned in this field.	Billing target's email address
transactionreference	Client unique identifier for the transaction provided by the 3rd party system to allow identification of the transaction between the 2 systems.	InvoiceID
redirecturl	Where to direct the customer to after the payment process is complete	To be confirmed
callbackurl	URL to send the data to the client system for the realtime server to server update.	To be confirmed
billaddress1	Billing address line 1 for the customer if captured on your site	Billing target's address
billtown	Billing Town if captured on your site	Billing target's town
billcounty	Billing County if captured on your site	Billing target's county
billpostcode	Billing postcode if captured on your site	Billing target's postcode
billcountry	Billing Country if captured on your site in the 2 code character format. E.g. GB	Billing target's country

Payment information

WPM field	WPM description	Sent from accessplanit
customfield1	Custom field for client use. E.g. finance codes	Course Template Cost Centre or Product & Service Cost Centre
Description	Description of the payment. For instalments, this will describe the fee plan.	Invoice Item description
ID	This is an autonumber to identify the element from other payments elements.	Autogenerated number
Type	PN = Pay now i.e. immediate payments, RCP = Recurring card payments i.e. card payments in the future, DD = Direct Debit payments i.e. direct debit payments in the future.	Always ‘PN’
PayOption	This is set by the client and describes the type of payment	This is set up by you in the ‘WPM Details’ section in the ‘Account Finance Options’ page
amounttopay	The amount to 2 decimal places. This should be blank if a blank mandate for instalments is to be setup.	Gross value of the invoice item – the gross value of any applicable discount items
amounttopayvat	If no VAT then value is blank. This should be blank if a blank mandate for instalments is to be setup	VAT value of the invoice item – the VAT value of any applicable discount items
amounttopayexvat	If no VAT then this value is the same as amounttopay.	Net value of the invoice item – the net value of any applicable discount items
vatdesc	The VAT desc e.g. Standard, Exempt, Out of Scope etc.	This is set up by you in the ‘WPM Details’ section in the ‘Account Finance Options’ page
vatcode	The VAT Code for the client finance system e.g. S1	This is set up by you in the ‘WPM Details’ section in the ‘Account Finance Options’ page
vatrate	Shows the VAT rate percentage. E.g. 20 . If no VAT then this should be zero.	This is left blank
dateofpayment	Date of payment. This should be blank if a blank mandate for instalments is to be setup. . If Pay now, this should be the current date	Current date/time
mandatory	Make the payment mandatory. This should always be 1 (true) for instalments.	Always ‘1’
editable minamount maxamount	Allow the payment amount to be editable. This must always be 0 (false) for instalments. The minimum and maximum allowed amounts for a payment can be set using these attributes. If you are looking at allowing Editable amounts this MUST be specified within the Specification Document.	Always ‘0’

Payment logic

Each item on the Invoice will be listed within the feed sent to WPM, except for free Sessional Courses and Delegates, these are hidden to avoid over cluttering the feed

Discounts are not associated with cost centres and will therefore be absorbed into the line item listed above it, and the description of that line item will include the suffixed text ‘with discount’

When a Voucher has been assigned to the booking, therefore discounting the outstanding balance, the value of the voucher will be distributed proportionally across each of the Invoice Items to ensure that future payments are calculated correctly

When the amount to be paid is only a partial payment, the value of the partial payment should be distributed proportionally across each of the Invoice Items to ensure that future payments are calculated correctly

Transaction confirmation

WPM field	WPM description	Sent from accessplanit
amountpaid	The net amount paid to 2 decimal places. This should be blank if it’s a future instalment amount of a blank mandate	Not stored
amountpaidvat	The VAT amount actually paid to 2 decimal places. This should be blank if it’s a future instalment amount of a blank mandate	Not stored
amountpaidexvat	The gross amount actually paid to 2 decimal places. This should be blank if it’s a future instalment amount or a blank mandate	Not stored
vatdesc	The VAT desc e.g. Standard, Exempt, Out of Scope etc.	Not stored
vatcode	The VAT Code for the client finance system e.g. S1	Not stored
vatrate	Shows the VAT rate percentage. E.g. 20	Not stored
transid	For your use	External Transaction ID
authcode	The authorisation code for the transaction as provided by the PSP	Not stored
preauth	1 for True 0 for False – defines whether the transaction was a preauth or not	Not stored
dateofpayment	Date of payment.	Transaction date
totalpaid	Total amount taken in this transaction. This will include any pay now elements of an instalment.	Transaction Amount
success	Indicates the transaction was successful	Not stored
failurereason	Future functionality. Leave blank	Not stored
cardholdername	The cardholder’s name	Not stored
cardtype	The type of card used, eg Visa, Mastercard	Not stored
cardlast4	Last 4 digits of the card number.	Not stored
cardexpdate	The card expiry date. Format is MMYY	Not stored
cardstartdate	The card start date if applicable. Format is MMYY	Not stored
cardissuenumber	The issue number of the card, if applicable.	Not stored
oItemCharge Payid sFinanceCode	Present for each item if configured for per item surcharging	Not stored
oOrderCharge sFinanceCode	Present once per transaction if configured for per order surcharging	Not stored
accountname	The account holder’s name	Not stored
sortcode	The sort code of the payer’s bank	Not stored
accountnumber	The payer’s account number	Not stored
bankname	The payer’s bank	Not stored
ddreference	The mandate reference created by the system	Not stored

Integrating your WPM account into your accessplanit platform

Integrating your WPM Account with your accessplanit platform doesn’t take very long! You will need to gather several details from WPM to set this up. Follow these steps to create and gather your WPM account details.

To integrate your accessplanit platform with WPM , you will follow these steps:

Collect your WPM information needed for the integration
Add your WPM information to your accessplanit platform

You will need to gather the following information about your WPM account

Shared Secret
Client ID
Pathway ID
Department ID
Email From
Payment URL
Pay Option
Standard VAT Code
Standard VAT Desc
Exempt VAT Code
Exempt VAT Dess

Once you have collected your WPM information, you are ready to add these to your accessplanit platform

Open the ‘Administration’ menu from the Profile options at the top-right of your platform
Open the ‘Account Finance Options’ menu option to access the page where you can manage your Invoicing and Payment Method settings

Please note

This page is only available to Super Admins, if you cannot access this page, please get in touch with a Super Admin in your team to set up your WPM integration.

Scroll down to the ‘Payment Methods’ section, here you should see a list of available payment methods for your system including Invoice, Cash, BACS and Card
You should additionally see ‘WPM Education’ as an option, if it is is not listed here please contact the accessplanit support team and they will enable this for you
Check to enable 'WPM Education' as an available payment method
Once you have enabled WPM, scroll down to the dedicated WPM Details section of this page
Enter your details
Click the ‘Update’ button at the bottom of the page to save your changes

Important

To ensure successful integration between WPM and accessplanit, it is crucial to configure the settings on the WPM side appropriately. One key aspect is configuring WPM to automatically redirect back to the platform after a payment has been successfully processed. This step is crucial for a seamless user experience and to ensure that the payment data is accurately captured and processed within the platform. By enabling the auto-redirect feature, users will be smoothly guided back to the platform, completing the integration loop and allowing for efficient management of payment transactions.

Without this option configured correctly there is a danger of payments being made, but bookings not being completed. This is because the user is getting to the WPM payment completed page and then closing the browser without being redirected back to accessplanit to completed their booking.

FAQ’s

Do I need a WPM account to use the integration?

Yes, a WPM Education account is required for this integration.

Can I process refunds through WPM?

Not in your platform, any WPM refunds should be processed within your WPM system. If you would also like to record the refund in accessplanit, please log the payment transaction as refunded so that other members of your admin team can view the refund.

Refund a payment on an Invoice

How do I track payments made via WPM?

Each WPM payment (and refund) is recorded in your platform as a ‘Transaction’.

There are several ways that you can view Transactions in your platform:

For each Invoice, you can open it’s ‘Transactions’ page to see all of the transactions made on this Invoice only
You can view all Transactions in a certain date range by adding a DataGrid gadget to your Dashboard and use the ‘Transactions’ module
You can build a report to show you a summary of Transaction data using the ‘Transactions’ module within the Report Engine

What permissions do I need to set up the integration?

To set up the WPM integration, you’ll need Super Admin access within accessplanit, this ensures that only people who have the necessary permissions are able to configure and manage the connection.