docs: add Device Activity and POS Gateway integration documentation #311
Conversation
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
- Add deviceActivity.md with complete Device Activity API reference - Add posGateway.md with comprehensive POS Gateway integration guide - Update README.md to include new documentation sections - Update Python version badge to show 3.5+ compatibility Features documented: - Device Activity APIs (initiate/close checkout, status checking) - Order APIs with device_mode support - Complete integration workflows - Error handling and status management - Request/response examples for all endpoints
documents/deviceActivity.md
Outdated
| import razorpay | ||
|
|
||
| # Initialize client | ||
| client = razorpay.Client(auth=('key_id', 'key_secret'), base_url='http://localhost:8080') |
Contributor
Author
There was a problem hiding this comment.
No, for More client they can use any port, will change this to PORT instead of 8080
documents/posGateway.md
Outdated
| ) | ||
|
|
||
| if result['success']: | ||
| print("✅ Checkout completed successfully!") |
documents/posGateway.md
Outdated
|
|
||
| ```py | ||
| response = client.device_activity.create({ | ||
| "device_id": "2841158834", # Required for device_mode="wired", optional for device_mode="wireless" |
- Updated posGateway.md to use PORT instead of 8080 - Updated deviceActivity.md to use PORT instead of 8080 - Allows users to configure any port for local development
srikervs94
reviewed
Sep 3, 2025
documents/deviceActivity.md
Outdated
|
|
||
| ```py | ||
| client.device_activity.create({ | ||
| "device_id": "2841158834", # Required for device_mode="wired", optional for device_mode="wireless" |
There was a problem hiding this comment.
same, required for wireless optional for wired
- Update comments to show device_id is required for wireless mode - Update comments to show device_id is optional for wired mode - Applied changes to deviceActivity.md and posGateway.md
- Move method field inside prefill object and mark as optional - Make type field optional in initiate_checkout - Add comprehensive API error codes section for client reference - Update device mode requirements (wireless requires device_id, wired is optional) - Remove internal RPGS error codes from client documentation - Update parameter tables and examples to reflect new structure
srikervs94
approved these changes
Sep 15, 2025
documents/deviceActivity.md
Outdated
|
|
||
| ### Wireless Mode | ||
| - **device_mode**: `"wireless"` | ||
| - **device_id**: Optional |
documents/deviceActivity.md
Outdated
| "name": "Gaurav Kumar", | ||
| "email": "gaurav.kumar@example.com", | ||
| "contact": "9000090000", | ||
| "method": "upi" # Optional: "upi"|"card"|"netbanking"|"wallet" |
There was a problem hiding this comment.
nb and wallet are not supported for omni yet I think its better to just have upi and card in the comment
- Update device mode requirements: wireless requires device_id, wired is optional - Remove authentication section from posGateway.md as requested - Update error handling documentation to reflect correct device_id requirements - Align documentation with actual API behavior
- Update device mode requirements consistently across both files - Ensure wireless mode requires device_id, wired mode is optional - Remove sections that were marked for deletion - Clean up documentation structure and formatting - Align all examples with updated requirements
- Complete final adjustments to device activity documentation - Ensure consistency across all documentation files
sunnyagg
approved these changes
Sep 15, 2025
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.
Features documented:
Note :- Please follow the below points while attaching test cases document link below:
- If label
Testedis added then test cases document URL is mandatory.- Link added should be a valid URL and accessible throughout the org.
- If the branch name contains hotfix / revert by default the BVT workflow check will pass.