Skip to content

feature(bill payments): plan mdm integration guide #278

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Dhirajkumar55
Copy link
Collaborator

No description provided.

Copy link

github-actions bot commented May 29, 2025

Checklist to merge a PR 🚀

To merge this pull request, please take time to complete the checklist.

What action did you perform?

Review the corresponding checklist items for the action you performed and mark them done.

Edit an existing content (MDX) page

Checklist

  • Review changes using the MDX preview option
  • If the length of content >15000 chars, use the Content preview portal to view changes
  • If a redirect is needed to the existing page, add a key, value pair in redirects.json

Edit an existing API reference page

Checklist


Add a new content (MDX) page

Checklist

  • Create a .mdx file with the path as its name in the content folder
  • Add frontmatter with all the metadata
  • Review the order of items in Sidebar using the Sidebar preview option
  • Review changes using the MDX preview option
  • If the length of content >15000 chars, use the Content preview portal to view changes
  • Created a folder with the same name, if any children were to be added to the page
  • Once all changes are done, update the menu items by using the Menu Items option
  • Add a key, and value pair in redirects.json if you wish to have a redirect to the new page

Add a new API reference page

Checklist

  • Create a .json file with the product path as its name
  • Create an api-reference.mdx file in the respective product folder inside content folder
  • Add frontmatter with all the metadata
  • Review the order of items in Sidebar using the Sidebar preview option
  • Add API reference in JSON format (OpenAPI or Swagger) into created .json file.
  • Used the Content preview portal to view changes
  • Once all changes are done, update the menu items by using the Menu Items option

### Key Use Cases
- **Mobile Prepaid Recharges** - Choose data/talk time plans
- **DTH Services** - Select channel packages and validity periods
- **Mutual Fund Houses** - Investment plan subscriptions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't have mutual funds as a category right now.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets just keep mobile prepaid recharges and DTH right now

Comment on lines +20 to +24
### Benefits
- **Seamless Integration** - Replicate existing user flows within BBPS
- **Flexible Plan Management** - Support both static and dynamic plan offerings
- **Real-time Updates** - Webhook notifications for plan changes
- **Standardized API** - Consistent integration patterns across biller types
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets compress these 4 points into smaller points that are more intuitive and relevant for API clients

| Step | Actor | Action | API Endpoint |
|------|--------|--------|--------------|
| 1 | Customer | Initiates service subscription | - |
| 2 | App/Platform | Retrieve available plans | `GET /api/v2/bbps/billers/plans` |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can change App/Platform to Your App

| 5 | App/Platform | Validate customer details with plan ID | `POST /api/v2/bbps/bills/fetch/request` |
| 6 | Setu API | Forward validation to biller | - |
| 7 | Biller | Validate account and plan compatibility | - |
| 8 | App/Platform | Check validation status | `POST /api/v2/bbps/bills/fetch/response` |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same change for Your App. Also, alternate way of getting status is via webhook

**Start Here:** What type of biller are you integrating?

```
Is planRequirement = "MANDATORY"?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

planRequirement is a field obtained from the list billers api

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants