Integrating your portal with Tipalti allows educators inside of your portal to issue payments to learners as they complete projects and have those payments facilitate by Tipalti.
General
Prerequisites
In order to setup a Tipalti integration, you must:
Have a Tipalti payer account
Have administrative access to your Tipalti account
Have access to the Tipalti developer portal
Developer application
In order to integrate your portal with your Tipalti instance, you will need to set up a Tipalti developer application. To do so:
Navigate to https://developer.tipalti.com/applications/new
Give your application a name like "Riipen"
Select the follow required scopes:
tipalti.api.payee.read
tipalti.api.payee.write
tipalti.api.payment.read
tipalti.api.payment-batch.write
tipalti.api.payment-batch.read
Enter a return URL that looks like "https://{subdomain}.riipen.com/auth/tipalti/integration/callback"
Click "Create"
Usage
The Tipalti portal integration allows for submitting payments to Tipalti. To actually create payments, be sure to check out our experience payments article.
Payment status synching
After issuing payments to Tipalti, you can enable synching of payment staatus back to Riipen by enabling certain webhooks from within Tipalti itself. This will allow you and your learners to track the outcomes of payments as they move from submitted to completed or when an error occurs.
How to
Enable the Tipalti integration
The following steps can be completed by an administrator of a portal.
Click "Settings" below the "Portal" group in the main navigation.
Select the "Integrations" tab.
Select the "Tipalti" option under the payments section.
Fill in the fields using your Tipalti account data.
Click "Submit" to save your integration configuration.
Now that your Tipalti integration is configured, it needs to be authorized. To do this:
Click "Settings" below the "Portal" group in the main navigation.
Select the "Integrations" tab.
Select the "Tipalti" option under the payments section.
Click "Connect with Tipalti"
Log in to your Tipalti account and follow the prompts on screen.
After completing the above steps, you will be redirected back to Riipen and your integration will be authorized.
If you do not use your Tipalti integration for 180 days, your integration will become unauthorized and you will need to repeat the steps above to reauthorize it.
View all payments
To view all payments associated with your Tipalti integration:
Click "Settings" below the "Portal" group in the main navigation.
Select the "Integrations" tab.
Select the "Tipalti" option under the payments section.
Click "View all payments"
For a detailed explanation of all payment actions, check out our experience payments article.
View a payment
To view a payment associated with your Tipalti integration:
Click "Settings" below the "Portal" group in the main navigation
Select the "Integrations" tab
Select the "Tipalti" option under the payments section
Click "View all payments"
Click the "Actions" button next to the payment you wish to view and then click "View"
For a detailed explanation of all payment actions, check out our experience payments article.
Create a payment batch
Once you have several payments in the Ready state, you can submit a payment batch to Tipalti to actually process the payments.
Click "Settings" below the "Portal" group in the main navigation.
Select the "Integrations" tab.
Select the "Tipalti" option under the payments section.
Click "Create Payment Batch"
The first 100 payments in a state of Ready will be added to the newly created payment batch and you will be redirected to the payment batch page.
Take this time to review any of the payments which are part of the payment batch and make any necessary modifications.
To actually process this payment batch and submit it to your payment provider requires further action.
View a payment batch
To view a payment batches associated with your Tipalti integration:
Click "Settings" below the "Portal" group in the main navigation.
Select the "Integrations" tab.
Select the "Tipalti" option under the payments section.
Click "View all payment batches"
Click on the payment batch you wish to view
From this page you will be able to view the payment batch details, along with all payments associated with the payment batch.
Submit a payment batch
Click "Settings" below the "Portal" group in the main navigation
Select the "Integrations" tab
Select the "Tipalti" option under the payments section
Click "View all payment batches"
Click on the payment batch you wish to submit
Click the "Process" button
Pressing the Process button will actually submit payments to be made in Tipalti. Depending on how you have Tipalti configured you may be required to take additional steps to approve that payment batch or the payment batch may be automatically processed by Tipalti.
Processing a payment batch happens behind the scenes. You will be able to refresh the payment batch page to check the status of the processing, but once complete, you will also receive a email notification indicating whether or not the payment batch was successfully submitted to Tipalti.
Once processing is complete, you will be able to see your payment inside of Tipalti's dashboard.
View all payment batches
To view all previously created payment batches associated with your Tipalti integration:
Click "Settings" below the "Portal" group in the main navigation.
Select the "Integrations" tab.
Select the "Tipalti" option under the payments section.
Click "View all payment batches"
You can now view all payment batches and manage them however you wish.
Enable webhooks
To enable webhooks within Tipalti:
Log in to your Tipalti instance
Click "Administration" -> "API Integration"
From the "IPN setup" tab, create the following records:
Type | URL |
Ipn for payment submitted | |
Ipn payment completed template | |
Ipn for declined payment group | |
Ipn for cancelled payment | |
Ipn for deferred payment | |
Ipn error template |
Remove the Tipalti integration
Click "Settings" below the "Portal" group in the main navigation.
Select the "Integrations" tab.
Select the "Tipalti" option under the payments section.
Click on the "Delete" button to remove the integration.
Removing the portal level Tipalti integration will prevent any further payments from being made and will remove all learner payment accounts.