-
Notifications
You must be signed in to change notification settings - Fork 4
New v3 apis #47
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
base: dev
Are you sure you want to change the base?
New v3 apis #47
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @soumyaa13, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request significantly expands the platform's API capabilities by introducing new functionalities for service activation, Aadhaar-based financial transactions, and financial settlements. These additions aim to enhance the services available to agents and merchants, streamlining processes for BBPS, fund transfers, and AEPS operations, and enabling new redirection features.
Highlights
- BBPS Service Activation: Added a new API to activate BBPS (Bharat BillPay System) service for users (agents/merchants/retailers).
- Fund Transfer Service Activation: Introduced a new API to activate Fund Transfer service for agents and updated existing documentation to reference this new activation method.
- AEPS (Aadhaar Enabled Payment System) - Fingpay APIs: Integrated a comprehensive suite of AEPS APIs, including functionalities for eKYC (OTP request, OTP verification, biometric authentication, daily KYC), transaction processing (cash withdrawal, balance enquiry, mini statement), and settlement management (adding accounts, listing accounts, initiating settlements).
- CreditLinks Redirection URL: Added a new API to generate CreditLinks redirection URLs for users.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces documentation for several new v3 APIs, including BBPS activation, Fund Transfer activation, and a comprehensive set of APIs for AEPS (Fingpay). The changes are extensive and well-detailed. My review focuses on improving the consistency, clarity, and correctness of the new documentation. I've identified several minor typos, formatting issues, and inconsistencies in parameter descriptions and sample responses. I've also noted a more significant issue with an inconsistent URL structure. Addressing these points will enhance the developer experience and reduce potential confusion when integrating with these new APIs.
| - **URL Endpoint:** /admin/network/agent/{user_code}/fund-transfer/activate | ||
| - **Request Structure:** | ||
| - Body Parameters: | ||
| - initiator_id (string / required) - Your registered mobile number (See Platform Credentials for UAT) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This line has trailing whitespace, which might be unintentional. In Markdown, two trailing spaces can create a line break (<br>), which could affect rendering. It's best to remove it for clean and predictable markup.
| - initiator_id (string / required) - Your registered mobile number (See Platform Credentials for UAT) | |
| - initiator_id (string / required) - Your registered mobile number (See Platform Credentials for UAT) |
markdown/README.md
Outdated
| - **URL Endpoint:** /user/collection/aeps-fingpay/kyc/otp | ||
| - **Request Structure:** | ||
| - **Body Parameters:** | ||
| - **initiator_id** (string / required) - Registered mobile number of the agent. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The description for initiator_id is inconsistent with other parts of the documentation. Here it is 'Registered mobile number of the agent.', but other sections use the more helpful 'Your registered mobile number (See Platform Credentials for UAT)'. Using the latter consistently would improve clarity for developers. This applies to other new AEPS APIs in this file as well.
| - **initiator_id** (string / required) - Registered mobile number of the agent. | |
| - **initiator_id** (string / required) - Your registered mobile number (See Platform Credentials for UAT). |
manustays
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LAST LINE REVIEWED: 4069
REST OF THE REVIEW PENDING (After Yahswant's review)
| @@ -266,18 +266,18 @@ Get the status of a transaction using Eko TID or client_ref_id | |||
| - **Method:** GET | |||
| - **URL Endpoint:** /tools/reference/transaction/{transaction-reference} | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove {transaction-reference} from PATH
| #### Description | ||
| **Examples:** | ||
| To check the status of a transaction using TID 12345, use following endpoint: `/tools/reference/transaction/12345 | ||
| To check the status of a transaction using TID 12345, use request format: `/tools/reference/transaction` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To check the status of a transaction using TID 12345, pass tid=12345 in the request body.
In case you have not received Eko's TID (say, due to network timeout), you can enquire about the status of a transaction using your own unique reference number (say, 567890) by passing it in the client_ref_id parameter in the request body.
| @@ -500,12 +500,28 @@ Get the current balance (E-value) of your or your user's wallet. | |||
| - **Method:** GET | |||
| - **URL Endpoint:** /user/account/balance | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Update URL PATH
| - **Method:** POST | ||
| - **URL Endpoint:** /customer/account | ||
| - **URL Endpoint:** /customer/account/{customer_id}/ppi-digikhata | ||
| - **Request Structure:** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add path parameter: customer_id
|
|
||
| ### 3.1 Send Transaction OTP API | ||
|
|
||
| The system will generate a One-Time Password (OTP) and deliver it to the sender's registered mobile number as part of a security or verification process. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Send a One-Time Password (OTP) to the sender's registered mobile number, which is required by the bank for verification."
| ### 3.2 Initiate Transaction API | ||
| ### 3.2 Initiate PPI-DigiKhata Transaction API | ||
|
|
||
| Initiate a PPI transaction to a bank account. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Initiate a PPI fund transfer transaction to a bank account.
|
|
||
| #### Details | ||
| - **Method:** PUT | ||
| - **URL Endpoint:** /admin/network/agent/{user_code}/qr/activate |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add PATH Parameter section below for user_code
| ### 1.7. Bank Account Verification (Sync) API | ||
| Verify a bank account number by transferring ₹1 to retrieve the name of the account holder. | ||
|
|
||
| > **Note:** Not applicable for all banks. Only applicable for banks for whom account verification feature is available. This can be checked by using the Get Bank Details API. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
> **Note:** The verification feature is not available for all banks. Use the _Get Bank Details API_ to check whether account verification is available for a particular bank.
|
|
||
| #### Details | ||
| - **Method:** POST | ||
| - **URL Endpoint:** /tools/kyc/bank-account/sync |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This URL has to change. Consult with Kumar Abhishek before proceeding.
Description
Motivation and Context
How Has This Been Tested?
Screenshots (if appropriate):
Types of changes
🚨 Checklist:
Further comments
🙏 Thank you!
Thank you for contributing to this project. We appreciate your time and effort. 🎉