The client, a renowned online payment solution provider, was looking to develop a Python Software Development Kit (SDK) using its existing API contracts (Connect & V3).
The intent was to provide an easy-to-integrate, secure, and highly reliable payment solution for the client's retailers’ and partners' backend systems.
Codvo.ai team was engaged to create an SDK that abstracted low-level API details and provided a simplified interface, ensuring secure communication between Python applications and the client's APIs. In addition, the plan was to expand this SDK to support PHP, NodeJS, .NET-based applications, making the platform more versatile and widely used.
The main challenge was to build an SDK that provided high-level function-based communication, integrated easily with various Python applications, and was secure. Other challenges included implementing retry mechanisms for handling transient errors, optimizing to reduce the number of requests sent to the API server, and supporting customer verification, pre-approval, origination, and post-origination scenarios. Additional complexities were ensuring regulatory and standards compliance (e.g., PII, GDPR) and providing versioning support to avoid breaking changes.
Codvo.ai team began with a thorough analysis of the client's API contract to finalize the supported APIs for the SDK. The next steps involved designing and developing the SDK while focusing on error handling, implementing retry and backoff mechanisms, and optimizing techniques to reduce the number of requests to the API server.
The team implemented robust authentication mechanisms to guarantee secure communication and ensured the SDK's compliance with relevant regulations. They also have built-in support for customer verification and lookup, pre-approval, origination, and post-origination scenarios.
The SDK has developed following the Python development best practices, such as adherence to PEP 8 style guidelines, use of meaningful variable and function names, and implementation of automated testing.
The team provided clear documentation, code samples, and examples to aid in integration. The SDK supported versioning to avoid breaking changes and ensure long-term compatibility.
The tech stack used was: Python v3 APIs, PyPI (Python Package Index), Git (Version Control), pytest (Automated Testing), PEP 8 Guidelines (Coding Standards).
The delivery of the Python SDK source code, unit and integration tests, comprehensive documentation, code samples, examples, and deployment package had a profound business impact.