As an administrator of an experience, you or your portal administrators may chose to pay learners for completing projects using a payment provider of your portal's choosing. These payments can be issued automatically via a supported integration with the Riipen platform, or manually by external payment providers.
General
Permissions
Any administrator of an experience can enable payments for the experience, but only portal administrators with the "Payments" permission will be able to issue payments associated with an integrated payment platform.
States
At any point, a payment will have a state associated with it indicating it's current state and likely what actions will be taken next.
State | Meaning |
Pending | The payment has been created, but it is pending completion of work done by the learner or pending verification of that work from the experience administrators. |
Ready | The payment is ready to be processed and can be submitted for actual payout to the learner. Only portal administrators can perform this action. |
Processing | The payment is currently being processed and is being prepared for submission to the payment provider. |
Submitted | The payment has been submitted to a payment provider and either requires further action by payment administrators or is being processed by the payment provider. |
Released | The payment has been released by the payment provider and is in transit to the learner's payment account. |
Accepted | The payment has been deposited into the learner's payment account. |
Declined | The payment was declined by the learner's payment account. |
Cancelled | The payment has been cancelled by the experience or payment administrators. |
Errored | The payment encountered an error. View the payment page for further details. |
How to
Enable payments
The following steps can be completed to enable payments on an experience.
Navigate to your experience
Click on the "Settings" tab
Click on the "Payments" tab in the "Advanced" group
Check "Enable payments to be issued to learners for completing projects"
Click "Submit".
A payments tab will now be visible for each team within the experience.
If you wish to issue payments automatically via a supported integration with Riipen:
Navigate to your experience
Click on the "Settings" tab
Click on the "Payments" tab in the "Advanced" group
Select your portal payment integration from "Payments integration"
Click "Submit".
After completing the above steps, any payments created within this experience will automatically be associated with the selected payments integration and will be made available for submission to that payment provider.
Create a payment
To create a payment for a learner within a team in your experience:
Navigate to the team page
Click on the "Payments" tab
Click the "+ Create Payment" button
Fill in the payment fields and click "Submit" to save it
This will simply create a record of a pending payment within Riipen. This will not issue a payment to a learner.
View a payment
To view a payment for a learner within a team in your experience:
Navigate to the team page
Click on the "Payments" tab
Click on the "Actions" button next to the payment you wish to view
Click on "View"
Edit a payment
You can only edit a payment if it is in a state of Pending.
To edit a payment for a learner within a team in your experience:
Navigate to the team page
Click on the "Payments" tab
Click on the "Actions" button next to the payment you wish to view
Click on "Edit"
Fill in the payment fields and click "Submit" to save it
Delete a payment
Once created, a payment cannot be deleted. However, it can be cancelled.
Cancel a payment
You can only cancel a payment if it is in a state of Pending, Submitted, or Released.
To cancel a payment for a learner within a team in your experience:
Navigate to the team page
Click on the "Payments" tab
Click on the "Actions" button next to the payment you wish to view
Click on "Cancel"
If the payment has already been submitted to an associated payment provider, you may need to take further action within that payment provider's available tools to actually Cancel any payments.
Manually set the state of a payment
There may come a time when you wish to manually set / override the state of a payment such as:
You are issuing payments outside of a supported integrated payment provider
A payment has come out of sync between Riipen and your integrated payment provider
In any case, you may choose to override the state of a payment by following these steps.
Navigate to the team page
Click on the "Payments" tab
Click on the action you wish to take to override the payment state. Depending on the payment's current state, some options may be unavailable to be selected as an override.