Handling Enrolments

What is an enrolment?

An enrolment refers to the process and completion of the onboarding of an employee within Wagestream. The enrolment process follows a set of states and actions which determine what information is expected at each step of the integration. The states and actions are available over the Enrolments API.

Enrolment flow

Getting list of employees to be enrolled

On a periodic basis, check the endpoint /enrollments for a list of employees that are waiting to enroll.

The response will include an array of enrollment records. For the full list and definition of those records, read the Enrolments Data Model

Actions available

• NONE: everything as it should be
• PENDING: Wagestream expecting personal bank details to be on your system, expecting to hear them from the sync
• TO_COMPLETE: Wagestream expecting Wagestream bank details to be on your system, expecting to hear them from the sync
• TO_UNENROLL: Wagestream expecting personal bank details to be on your system, expecting to hear them from the sync

Why is there an action?

If current state (on Wagestream) is:

Pending

Enrolled / Active

Disabled

Example API Response

/* An example of enrollments data, where two employees have enrolled but need their bank account details
uploaded in your payroll system*/

{
    "enrollments": [
        {
            "action": "TO_COMPLETE",
            "bank_account_number": "12265228",
            "bank_name": "Wagestream",
            "bank_sort_code": "040053",
            "employee_id": "EMPL_0001",
            "enrolled_on": "",
            "requested_on": "2021-11-15",
            "state": "PENDING",
            "unenrolled_on": ""
        },
        {
            "action": "TO_COMPLETE",
            "bank_account_number": "14200456",
            "bank_name": "Wagestream",
            "bank_sort_code": "040053",
            "employee_id": "EMPL_0002",
            "enrolled_on": "",
            "requested_on": "2021-10-20",
            "state": "PENDING",
            "unenrolled_on": ""
        }
    ],
    "total_records": 2
}