Visa's PMS has easy-to-use APIs that facilitate integrating financial education resources into existing platforms. This section explains the APIs available for the use cases supported by VPMS.
The Register API will register a user to the Visa PMS financial education platform. 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.
The Get Profile API will retrieve the user’s profile.
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).
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.
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.
The Categories API will return a list of categories (ID, name, thumbnail image link).
The Learning Paths API will return a list of Learning Paths (ID, name, thumbnail image link)
The Browse Categories API will return a list of courses associated with the category ID.
The Browse Learning Paths API will return a list of courses associated with the Learning Path ID.
The Get Learning Paths by Category API will retrieve the Learning Paths associated with the category ID.
The Search API will return the list of courses matching the search keywords.
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).
The User Exists API will check if the email address or phone number has been registered in the Practical Money Skills platform.
The Update Profile API will update the user’s profile.
The Get Badges API will retrieve all the badges the user has achieved.
The Get Preferences API will save the user’s application preferences.
The Update Preferences API will update the user’s application preferences.
The Get Library API will retrieve the courses in the user’s library.
The Update Library API will add or update course(s) to the user’s library.
The Delete Library API will delete one or more courses from the user’s library.
The Get Favorites API will retrieve the courses from the user’s favorites list.
The Update Favorites API will add or update course(s) to the user’s favorites list.
The Delete Favorites API will delete one or more courses from the user’s favorites list.
The Delete User API will delete the user from Practical Money platform. It requires the user ID and the password.
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.
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.
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.
The Get Courses In-Progress API will retrieve all the courses the user has enrolled in and are currently in progress.
The Get Courses Completed API will retrieve all the courses the user has enrolled in and has completed.
The Enroll API will enroll the user into a course.
The Unenroll API will unenroll the user from the course.
The Learning Paths Details API will return the details of the learning path based on the Learning Path ID passed to the API.
Start a Project
API Overview
API Reference