Online payment - WPM Education

Modified on Thu, 19 Sep at 8:53 AM

TABLE OF CONTENTS

What can I do with this integration?
Additional shared fields
What will the flow look like for your customers?
How to setup WPM?
Recognising the customer in WPM
Forwarding an edition custom field to WPM
More information

What can I do with this integration?

After the integration is set up, a customer will be able to select WPM as a payment method. Then, after finishing the sign up (or when sending payment requests), the customer will be redirected to a page hosted by WPM where the customer can fill in the payment details (credit card or bank account information) securely. If the information is successfully filled in, the customer gets redirected back to Eduframe who will finalize the payment. Eduframe shows a success page if the payment was successful and an error page otherwise.

Additional shared fields

Our WPM integration currently shares customer data with WPM and some additional fields in addition to price and currency, with the goal of pre-filling the WPM form:

Customer email: pre-fill email field
Customer address: pre-fill address field
Order reference: fill transaction reference field
Customer reference: Calculated string. Example: EDU-P-123456. More on this in the section recognising the customer in WPM below.
Invoice line description: invoice_id and invoice_reference no. Both can be used to find the invoice back in Eduframe.
Custom field: More on this at the bottom of this article

Privacy and GDPR: When setting up the WPM integration we advise you to sign a data processing agreement with WPM.

What will the flow look like for your customers?

We integrated WPM into Eduframe using a flow that consists out of three parts:

Your customer starts the signup for one of your products. At the last step of the signup process the customer needs to choose how to pay. If the customer selects WPM and finishes the signup the customer will be redirected to WPM for the payment.
Once redirected to WPM, a page hosted by WPM will appear where the customer is asked to:

Fill in contact details. Eduframe will pre-fill the email address on this form.
Fill in payment details (credit card or bank account information).

When the customer clicks on continue, WPM will finalize the payment.
WPM will show a payment confirmation screen. When the customer clicks on continue, the customer will be redirected back to Eduframe. Eduframe will now finalize the payment and show one of the two screens below:

‘Payment received’ if the payment was completed successfully.
‘Payment failed’ if the payment could not be completed successfully.

How to setup WPM?

To add WPM as a new payment provider in Eduframe you need to go to ‘Settings’ -> ‘Payment options’ -> ‘Payment methods’. Here you can add a new payment method: Select WPM Education as the gateway and fill in an appropriate name.

The API key requires multiple steps. From WPM you should have received integration parameters:

Shared Secret
Client ID
Pathway ID
Department ID
Pathway URL
Pay Option

The API field needs to contain these parameters in JSON format. You can copy the JSON below and fill in the specific parameters you received from WPM.

{
"shared_secret":"shared_secret",
"client_id":1234,
"pathway_id":1234,
"department_id":1,
"pathway_url":"https://payments.your-site.uk/drieam/",
"pay_option":"DSC"
}

Now that you have the correct JSON you should copy it completely, paste it in the API key field in Eduframe and save the payment method afterwards.

You’re now ready to use WPM as a payment method.

Recognising the customer in WPM

For every payment in WPM we forward a calculated customer reference string to WPM. The string is calculated as follows:

{EDU}-{O/P}-{account_id}

Explanation:

EDU = Eduframe
O = Organisation order
P = Personal order
account_id = The ID of the account the invoice paid is linked to. See our API documentation.

Forwarding an edition custom field to WPM

It is possible to configure the payment method such that one edition custom field will be sent to WPM as customfield1 on the payment object. To do this, you will need to add a new payment method, even if you have already configured one for WPM Education. In addition to the integration parameters you have received from WPM, you will need to know the slug of the custom field you want to send. Then, you will need to add the optional parameter "custom" to the API key, and set the custom field slug as its value. An example of the API key JSON with a custom field looks the following:

{
    "shared_secret":"shared_secret",
    "client_id":1234,
    "pathway_id":1234,
    "department_id":1,
    "pathway_url":"<https://payments.your-site.uk/drieam/>",
    "pay_option":"DSC",
    "custom": "my-custom-field"
}

Now, if you copy the correct JSON, paste it in the API key field in Eduframe and save the payment method afterwards, you are ready to use the new payment method. Make sure to disable any old payment method that uses WPM Education without a custom field configured.

Note: The slug of your custom fields can be found by using the following link, for which you need to be logged in: "https://{educator}.eduframe.nl/api/v1/signup_questions?for_type=catalog_variant".
Make sure to replace the {educator} the URL for your own Educator slug.

More information

Click here if you have any questions for support.