Visa Practical Money Skills Financial Education Platform

Getting Started with the Practical Money Skills (PMS) Financial Education Platform

About Visa PMS Financial Education Platform APIs

Visa’s Practical Money Skills APIs deliver a robust Learning Management System (LMS) that allows users to create accounts, enroll in financial education courses, track their progress via badges and streaks, and obtain certificates of completion. The APIs integrate into existing mobile apps, support single sign-on and offer immediate access to the platform for users. Clients are not required to integrate the full list of APIs and can select functionality based on their preferences.

How Does it Work

Visa PMS API’s can be found on the product page. Visa Direct Clients can create their own “Go-Live” process for the API connections found in the Visa Developer Center through their dashboard.

See “Quick Start Guide for Developers” for a guide to implement projects.

APIs Included

Apps

Get Profile Fields API

The Get Profile Fields API will return all the fields necessary to onboard a user to the Practical Money Skills platform.  The fields include Age, Gender, Country, Do you own a business, etc.  The API also returns the list of categories and a list of Learning Paths.

Categories API

The Categories API will return a list of categories (ID, name, thumbnail image link).

Learning Paths API

The Learning Paths API will return a list of Learning Paths (ID, name, thumbnail image link).

Browse Categories API

The Browse Categories API will return a list of courses associated with the category ID.

Browse Learning Paths API

The Browse Learning Paths API will return a list of courses associated with the Learning Path ID.

Get Learning Paths by Category API

The Get Learning Paths by Category API will retrieve the Learning Paths associated with the category ID.

Search API

The Search API will return the list of courses matching the search keywords.

Home for User API

The Home for User API will return the content for the user ID passed in.  If no user ID (optional) is passed, generic content will be returned.  The content is organized into the following sections: User’s achievements (if the user ID is passed), Jump Back In (if the user ID is passed, three courses), Quick Start (three courses), Popular (three courses), and New Releases (four courses).

Explore API

The Explore API will return the courses organized into the following three sections: Quick Start (three courses), Popular (three courses), and New Releases (four courses).

Users

User Exists API

The User Exists API will check if the email address or phone number has been registered in the Practical Money Skills platform.

Register API

The Register API will register a user to Practical Money Skills.  The API will accept either a unique email address or phone number.  The API will expect the user’s values for the profile fields from the Get Profile Fields API.

Get Profile API

The Get Profile API will retrieve the user’s profile.

Update Profile API

The Update Profile API will update the user’s profile.

Get Badges API

The Get Badges API will retrieve all the badges the user has achieved.

Get Preferences API

The Get Preferences API will save the user’s application preferences.

Update Preferences API

The Update Preferences API will update the user’s application preferences.

Get Library API

The Get Library API will retrieve the courses in the user’s library.

Update Library API

The Update Library API will add or update course(s) to the user’s library.

Delete Library API

The Delete Library API will delete one or more courses from the user’s library.

Get Favorites API

The Get Favorites API will retrieve the courses from the user’s favorites list.

Update Favorites API

The Update Favorites API will add or update course(s) to the user’s favorites list.

Delete Favorites API

The Delete Favorites API will delete one or more courses from the user’s favorites list.

Delete User API

The Delete User API will delete the user from Practical Money Skills.  It requires the user ID and the password.

Courses

Get Courses API

The Get Courses API will return all the courses in the Learning Management System.  If the language is passed, it will only return the courses in that language.

Get Course Details API

The Get Course Details API will return the course details for the course ID. If the user ID (optional) is passed, it will also return the user’s enrollment information for the course.

Get Course for User API

The Get Course for User API will retrieve all the courses the user has enrolled in, in progress, or completed.  The course details will also include the user’s enrollment information.

Get Courses In-Progress API

The Get Courses In-Progress API will retrieve all the courses the user has enrolled in and are currently in progress.

Get Courses Completed API

The Get Courses Completed API will retrieve all the courses the user has enrolled in and has completed.

Enroll API

The Enroll API will enroll the user into a course.

Unenroll API

The Unenroll API will unenroll the user from the course.

Start Course API

The Start Course API will return the Single Sign-On URL to the course material.  The URL will begin the course.  The returned URL should be rendered within an in-app browser or browser.

Learning Paths Details API

The Learning Paths Details API will return the details of the learning path based on the Learning Path ID passed to the API.