AllDotPy / AllDotPy/EasySwitch

📝 Add user-friendly documentation for Bizao adapter

Open
#43 6 comments 0 reactions 1 assignee View on GitHub

@Nel4Nelson is already working on this.

Since Oct 3, 2025.

Adapters documentation good first issue Hactoberfest
Dominant language
Python
Stars
21
Forks
17
PR merge metrics
No merged PRs in 30d

Description

✨ Context

EasySwitch includes an integration for Bizao (easyswitch.integrators.bizao).
However, the documentation is currently too technical and may not be easily understandable for developers who are new to EasySwitch or payment aggregators.

We want to provide a clear, pedagogical, and comprehensive guide for using the Bizao adapter.


📌 What needs to be done

  • Create a dedicated documentation page for BizaoAdapter.
  • Explain step by step how to configure and use it:
    • How to set up credentials (api_key, api_secret, base_url, etc.)
    • Sandbox vs Production environments
    • Required fields for transactions
    • Common pitfalls & error handling
  • Add examples (Python code snippets) for:
    • Sending a payment
    • Checking transaction status
    • Handling webhooks (validation & parsing)
    • Refunding a transaction
  • Provide practical examples (e.g., integrating Bizao for mobile money payments).
  • Ensure the documentation is simple, user-friendly, and easy to follow.

✅ Expected outcome

  • A dedicated, user-friendly documentation page in the EasySwitch docs (docs/integrators/bizao.md).
  • Clear examples and explanations that reduce onboarding friction.
  • Helpful for both beginners and experienced developers.

💡 Notes

  • Look at the BaseAdapter documentation as a model.
  • Bonus: include a visual diagram showing the Bizao payment workflow in EasySwitch.

🎉 Why this matters

Bizao is a popular aggregator for mobile money and digital payments in Africa.
Improving its documentation will make EasySwitch more accessible to local developers, and foster wider adoption.

This issue is Hacktoberfest-friendly 🚀

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.