How to Use Visa PMS APIs

\ Start a Project](https://developer.visa.com/portal/#users/new) \ API Overview](https://developer.visa.com/capabilities/practical-money-skills) \ API Reference](https://developer.visa.com/capabilities/practical-money-skills/reference)

• Getting Started
• How to Use Visa PMS APIs
  • Register API
  • Get Profile API
  • Home for User API
  • Start Course API
  • Additional APIs
• Authentication Method
• API Reference
• Product Terms

Navigate to...

keyboard_arrow_down

How to Use Visa PMS FinEd APIs

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.

1. Client’s users register with the Client’s website/mobile app
2. The client registers with Visa PMS FinEd Platform
3. Visa PMS FinEd Platform returns a unique User ID
4. User Login to the Client’s website/mobile app
5. The client validates the user’s credentials and calls Visa PMS FinEd Platform to get the user’s profile and list of courses
6. Visa PMS FinEd Platform returns the user’s profile and the list of courses with the user’s enrollment information
7. The client renders the courses on the Client’s website/mobile app

Register API

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.

Get Profile API

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

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

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.

Additional APIs

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.

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

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.

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 platform.  It requires the user ID and the password.

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.

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.

arrow_upward Back to top