Payment Integration Configuration

In order to establish a connection between Promote and the payment solution, an initial configuration must be performed on both platforms. This article will guide you through that configuration step by step.

Content in this article

• Stripe Integration Configuration
  • Creating an API key in Stripe
  • Enabling the Stripe connector in Promote
  • Program Configuration
    • Self-paced programs
    • Cohort programs
  • Participant registration information
  • Email program invitations
• PayPal Integration Configuration

Stripe Integration Configuration

1. Creating an API key in Stripe

In order to connect Stripe to Promote you need to create an API key that allows Promote to communicate with Stripe.

1. Go to https://dashboard.stripe.com/apikeys
2. Click Create secret key 
3. Name the key Promote under Key Name 
4. Copy the key for later

 

2. Enabling the Stripe connector in Promote

To enable automatic enrollments via payments, this integration requires setup in both your payment provider and Promote. If you’d like to enable payment integration for your Promote site, please contact Promote Support at [e-mail]. We will guide you through the setup process.

3. Program Configuration

Once a connection has been established between the two platforms, a Promote program can be linked to a Stripe product to allow automatic enrollment for any users who purchased a product via Stripe.

Self-paced programs

1. In Stripe create a product to represent a seat in your program
2. From the product, copy the code displayed as Product ID

3. Log on to Promote
4. Find the program you want to link the Stripe product to
5. For self-paced e-learning content it is also recommended to set
   1.  Learner interaction and communication - Individual program
   2. Timeline type - Individual start/end date
6. Under Integrations
   1. Paste the Product ID you copied from Stripe, into the Identifier field
   2. Select Stripe in the Integration field

7. Click Save changes

Your Stripe product is now connected to your Promote program. When a user purchases the product they will automatically be added to the program and they will be able to access the program immediately since it is configured to allow access without invitation emails and have individual start dates.

The user will have access to the program for 12 months from the day they register.

Cohort programs

1. In Stripe create a product to represent a seat in your program
2. From the product, copy the code displayed as Product ID

3. Log on to Promote
4. Find the program you want to link the Stripe product to
5. For cohort programs it is also recommended to set
   1.  Learner interaction and communication - Cohort program
   2. Timeline type - Program start/end date
6. Under Integrations
   1. Paste the Product ID you copied from Stripe, into the Identifier field
   2. Select Stripe in the Integration field

7. Click Save changes

Your Stripe product is now connected to your Promote program. When a user purchases the product they will automatically be added to the program.

Please note that when a program has a start date set in Promote, the user will not be able to visit the program until it opens. With the information provided in the confirmation email, they can however sign in to Promote and see the upcoming program listed.

 

4. Participant registration information

By default, when a user purchases a course via Stripe a learner will be added to the program in Promote using the email address and cardholder name provided in the transaction.

If you want to separate the information used for the program registration from the information used for the payment, you can add custom fields for this in Stripe. This will for example allow purchasing a course for someone else or use a different email address for the Promote registration and invoice.

To add the custom fields please follow these steps:

1. Go to https://dashboard.stripe.com/payment-links 
2. Edit the existing payment link for your product or if you have not yet created one, click the +New button to create it
3. Click on Advanced Options to display all options
4. Check the Add Custom Fields option
5. Enter Participant's first name as Label name
6. Click Add another field
7. Enter Participant's last name as Label name
8. Click Add another field
9. Enter Participant's email as Label name
10. Click Update link (or Create link) to save your changes

 

Important information about custom fields

Field label names: The custom fields have exactly the labels listed in steps 5, 7, and 9 above. When done, please verify that your Advanced options look like this: 

 

Ensure custom fields are mandatory

When using the custom fields they should never be Marked as optional.  If the fields are set to optional and left empty by the user, the registration in Promote will fail even if the purchase is completed. 

If this would happen you can either refund the purchase in Stripe or manually add the user in Promote.

 

5. Email program invitations

When a user is added to the program after completing a purchase in Stripe, an invitation email will be sent from Promote by default, to the email provided for the payment.

If you don't want invitation emails to be sent, you can configure this for each product in Stripe:

1. Go to the product page for that specific product in Stripe;
2. On the right side of the page there's a Metadata option

3. Click the edit icon to add new metadata
4. Insert a key called invite - it needs to be lowercase;
5. Insert the value false - it needs to be lowercase

6. Click Save

A purchase of this product will now no longer trigger an email invitation from Promote. 

Since the default setting when completing a purchase in Promote is to send an invitation, and this setting is per product, it's necessary to set this to false for all the products where you don't want invitations to be sent.