Update BBPS API documentation and remove deprecated content#333
Merged
tanmay-dixit merged 3 commits intomainfrom Sep 16, 2025
Merged
Update BBPS API documentation and remove deprecated content#333tanmay-dixit merged 3 commits intomainfrom
tanmay-dixit merged 3 commits intomainfrom
Conversation
- Add example value for token expiry in API schema - Remove deprecated documentation files and redundant transaction examples - Update webhook documentation with improved examples and event types - Fix relative links in API references across multiple documentation pages - Add `<WasPageHelpful>` component to relevant documentation sections
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) pageChecklist
Edit an existing API reference pageChecklist
Add a new content (MDX) pageChecklist
Add a new API reference pageChecklist
|
There was a problem hiding this comment.
Pull Request Overview
Updates BBPS API documentation by improving webhook examples, fixing broken links, removing deprecated content, and adding enhanced API schema details.
- Enhanced webhook documentation with separate success/failure examples and updated event types
- Fixed relative links across API reference documentation to use proper internal linking format
- Removed deprecated documentation files and redundant transaction examples to clean up obsolete content
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| webhooks.mdx | Enhanced webhook examples with separate success/failure cases and updated event types |
| v2-migration.mdx | Fixed relative API reference links and removed deprecated fields |
| upms.mdx | Updated API reference links to use proper internal format |
| remittance_flows_guide.mdx | Removed deprecated IMPS/NEFT payment modes and added help component |
| plan-mdm-integration.mdx | Added WasPageHelpful component |
| harmonization_of_tat.mdx | Improved dispute examples formatting and added help component |
| deprecated.mdx | Removed entire deprecated documentation file |
| bbps-v1_1-features.mdx | Removed redundant transaction examples and added help component |
| api-integration.json | Added example value for token expiry field in API schema |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| "traceId" : "C3SFG0O6N88R6UI7EQ", | ||
| "timeStamp" : "2021-11-12T00:12:29+05:30", | ||
| "event" : "BILLER_UPDATES", | ||
| "event" : "BILL_FETCH / BILL_PAY / BILL_DISPUTE / BILLER_UPDATES / PLAN_UPDATES / CREATE_UPMS_REGISTRATION / UPDATE_UPMS_REGISTRATION / CANCEL_UPMS_REGISTRATION / SKIP_PAYMENT", |
There was a problem hiding this comment.
The event field shows multiple values separated by slashes, which could be confusing. Consider clarifying that this represents possible event types rather than a single concatenated value, or use an array format to show the possible values more clearly.
Suggested change
| "event" : "BILL_FETCH / BILL_PAY / BILL_DISPUTE / BILLER_UPDATES / PLAN_UPDATES / CREATE_UPMS_REGISTRATION / UPDATE_UPMS_REGISTRATION / CANCEL_UPMS_REGISTRATION / SKIP_PAYMENT", | |
| "event" : "<one of: BILL_FETCH, BILL_PAY, BILL_DISPUTE, BILLER_UPDATES, PLAN_UPDATES, CREATE_UPMS_REGISTRATION, UPDATE_UPMS_REGISTRATION, CANCEL_UPMS_REGISTRATION, SKIP_PAYMENT>", |
| "billerRefId": "ABC1235", | ||
| "transactionId": "AX01122999900001", | ||
| "paymentDetails": { | ||
| "mode": "Internet Banking/Debit Card/Credit Card/Cash/UPI/Wallet/Prepaid Card/AEPS/Account Transfer/Bharat QR/USSD", |
There was a problem hiding this comment.
The payment mode field shows multiple values separated by slashes, which appears to represent possible values rather than a single concatenated string. Consider using clearer documentation format to indicate these are possible enum values, such as using array notation or explicit enum documentation.
- Update hrefs for API categories (Fetch, Pay, Dispute, UPMS) - Remove deprecated mock-environment and polling guides - Fix documentation links and add HTTPS requirement for callbacks - Rename UPMS section and update registration API references
GnaneshKunal
approved these changes
Sep 14, 2025
GnaneshKunal
approved these changes
Sep 16, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
<WasPageHelpful>component to relevant documentation sections