Payments

Managing payments within an experience

Chris Becher avatar
Written by Chris Becher
Updated over a week ago

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.

Pre-requisites

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.

Enabling payments

The following steps can be completed by an administrator of an experience.

  1. Navigate to your experience

  2. Click on the "Settings" tab on the experience page

  3. Click on the "Payments" tab in the "Advanced" group

  4. Check "Enable payments to be issued to learners for completing projects"

  5. Click "Submit".

A payments tab will now be visible on each experience's team page.

If you wish to issue payments automatically via a supported integration with Riipen:

  1. Navigate to your experience

  2. Click on the "Settings" tab on the experience page

  3. Click on the "Payments" tab in the "Advanced" group

  4. Select your portal payment integration from "Payments integration"

  5. 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.

Creating a payment

To create a payment for a learner within a team in your experience:

  1. Navigate to the team page

  2. Click on the "Payments" tab

  3. Click the "+ Create Payment" button

  4. 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.

Viewing a payment

To view a payment for a learner within a team in your experience:

  1. Navigate to the team page

  2. Click on the "Payments" tab

  3. Click on the "Actions" button next to the payment you wish to view

  4. Click on "View"

Payment status

At any point, a payment will have a status associated with it indicating it's current state, and likely what actions will be taken next.

Status

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.

Editing 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:

  1. Navigate to the team page

  2. Click on the "Payments" tab

  3. Click on the "Actions" button next to the payment you wish to view

  4. Click on "Edit"

  5. Fill in the payment fields and click "Submit" to save it

Deleting a payment

Once created, a payment cannot be deleted. However, it can be cancelled.

Cancelling 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:

  1. Navigate to the team page

  2. Click on the "Payments" tab

  3. Click on the "Actions" button next to the payment you wish to view

  4. 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.

Overriding the state of a payment

There may come a time when you wish to manually override / update the state of a payment within Riipen:

  • You are issuing payments outside of a Riipen 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.

  1. Navigate to the team page

  2. Click on the "Payments" tab

  3. 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.

Did this answer your question?