docs: add comprehensive Bizao integration guide#44
docs: add comprehensive Bizao integration guide#44Nel4Nelson wants to merge 1 commit intoAllDotPy:masterfrom
Conversation
Complete documentation for Bizao mobile money adapter including setup, code examples, error handling, testing, and troubleshooting guide. Closes #[43]
|
Great work @Nel4Nelson ! |
|
You @Wgoeh @Einswilli can preview the rendered documentation here: https://github.com/Nel4Nelson/EasySwitch/blob/master/docs/integrations/bizao.md GitHub will automatically render the markdown when you view the file. |
| # Under development No newline at end of file | ||
| # Bizao Integration with EasySwitch | ||
|
|
||
| ## Table of Contents |
There was a problem hiding this comment.
No need Table of contents section since it's auto generated by mkdocs.
| client = EasySwitch.from_dict(config) | ||
| ``` | ||
|
|
||
| ### Alternative Configuration Methods |
There was a problem hiding this comment.
Just reference the configuration part here.
| EASYSWITCH_BIZAO_TIMEOUT=60 | ||
|
|
||
| # Development credentials | ||
| EASYSWITCH_BIZAO_DEV_CLIENT_ID=your_dev_client_id |
There was a problem hiding this comment.
All Extra attributes must have _X_ in their names.
Example
EASYSWITCH_BIZAO_DEV_CLIENT_SECRET must be EASYSWITCH_BIZAO_X_DEV_CLIENT_SECRET
that indicates to the env config loader what attribute goes to a provider extra configs (as in the json config)
|
|
||
| > **Note**: `cancel_transaction()`, `refund()`, and `get_transaction_detail()` are not supported by Bizao. See [Bizao Limitations](#bizao-limitations) for alternatives. | ||
|
|
||
| ### Configuration Methods |
There was a problem hiding this comment.
Just reference the configuration section.
|
|
||
| > **Important**: `parse_webhook()` automatically calls `validate_webhook()` internally, so you don't need to validate separately when using `parse_webhook()`. | ||
|
|
||
| #### Webhook Configuration with EasySwitch |
There was a problem hiding this comment.
I think you can split this example, so each part can have its comment and explanations.
| 2. **Support Contact**: Contact Bizao support team | ||
| 3. **Business Logic**: Track refunds in your system separately | ||
|
|
||
| ## Payment Flow Diagram |
There was a problem hiding this comment.
Better to have this ad svg or png image.
| 8. Bizao sends webhook notification to your callback URL | ||
| 9. Your app processes webhook and confirms payment to customer | ||
|
|
||
| ## Practical Integration Examples |
There was a problem hiding this comment.
i'd like if you can move this examples to a separate file under docs/examples/bizao.md then reference it here.
Good job!
3 participants
Complete documentation for Bizao mobile money adapter including setup, code examples, error handling, testing, and troubleshooting guide.
Closes #[43]