Metadata-Version: 2.1
Name: bitmast_paystack
Version: 2023.1.1
Summary: Python wrapper for PayStack Gateway API
Author: frier17
Author-email: Bitmast Digital Services <bitmastdigital@gmail.com>
Maintainer: frier17
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "{}"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright 2019 frier17
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
        
Project-URL: repository, https://gitlab.com/frier17/pypaystack.git
Keywords: payment,bank,card,account,PayStack,fintech
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# Bitmast PayStack 
**A PayStack payment Solution implemented in python**

The PyPayStack API is a python implementation of the PayStack payment gateway, [www.paystack.co](https://www.paystack.co
). See developer's documentation [here](https://developers.paystack.co/docs/). The current edition is built to
 support transaction in Naira. 
 The driving goal of this project remains to have an easy to integrate payment solution for python based projects. 
  
  ## Motivation
  The existing implementation of PayStack API in python supports a subset of the payment gateway features. Support
   for features such as BVN (Bank Verification Number) verification and many other features are not readily available
   . Furthermore, the use of Python's language rich object model is not largely adopted. In a bid of meeting this
    need, PyPayStack has been designed and built to allow developers focus on business application logic while the
     payment of their application or online service remain the major concern of PyPayStack. Aside this, most online
      resource of the PayStack gateway were written for PHP with a lot of plugins for PHP based web frameworks like
       WordPress, Magento, PrestaShop etc. The PyPayStack was designed to be a simple framework that can be
        integrated with Python based frameworks such as Django, Flask etc.
        
## Description
PyPayStack is built to provide one primary service: process online payment in Nigeria e-commerce space using the
 PayStack payment gateway without need for detail understanding of PayStack payment system. Such knowledge is
  beneficial but not mandatory while using PyPayStack.
  
  Some of the key innovative feature of the design is support for the features of PayStack gateway in an intuitive
   manner. Others include:
1. Use of design patterns for meeting key programming needs that will simplify code base and make for easy
    application testing. Example, all PayStack API request can be executed as a callable objects which are implemented using the
     Command Design Pattern. Hence, to initiate a PayStack Transaction, simply follow the steps:
     
	~~~python
	   
		# Initiate a payment transaction
		from paystack.util import BusinessDataObject 
		from paystack.transaction import initialize_transaction, verify_transaction

		# Create business data object from HTTP Request with validated form fields    
		transaction_object_from_request = BusinessDataObject(**kwargs)
		initialize = initialize_transaction(transaction_instance=transaction_object_from_request)
		server_response = initialize()
		if server_response:
			# do work
			pass

		# Verify a payment transaction
		# Create business data object from HTTP Request with validated form fields
		transaction_object_from_server = BusinessDataObject(**kwargs)
		verify = verify_transaction(transaction_instance=transaction_object_from_server)
		verify_server_response = verify()

	~~~  

    All callable functions are implemented as Command object which wraps a function for executing given command. This
 function can be dynamically updated or replaced with any other function/lambda expression by the developer.
 
2. Data across layers are passed by a mapping object (BusinessDataObject) which is immutable ensuring that
    transaction data is not wrongly manipulated or altered unintentionally by application calls. This dictionary like
     object can be parsed into JSON or other format for rendering.
     
3. Application features are grouped into processes with related/subprocesses being under the same categories. Example all subaccount features can be accessed through the `paystack.subaccount` package.
 
4. Application specific requirement and account details can be managed from a centralized configuration system. This will enable developers extend the project for their peculiar needs.

3. Application features are grouped into processes with related/subprocesses being under the same categories. Example
 all subaccount features can be accessed through the `paystack.subaccount` package.

4. Application specific requirement and account details of the merchant can be managed from a centralized configuration
 system. This will enable developers extend the project for their peculiar needs.

5. Rich set of data validation is provided for every request object/data being passed to the PayStack api. Furthermore, the default REGEX patterns and data validation can be replaced by the developer to suit their target  need. It is believed, however, that default validators meets the requirements for most online cases.

6. A `parser` package is provided with the alpha edition. This package is considered secondary as responses from the
 server can be converted into BusinessDataObject or passed along to calling function for further processing.

7. Integration with a communication and database layer can be achieved using the Mediator Design Pattern. This will
 enable system
 send information to third party application using a single channel or given interface. Default Mediator
  implementation is available in the `toolkit` package.

8. All HTTP requests are made through the Python `requests` API. See documentation [here](https://2.python-requests.org/en/master/) for more information.
      
## Dependencies
The PyPayStack requires `toolkit` which can be downloaded [here](https://gitlab.com/frier17/toolkit)
The target Python language for current implmentation is Python 3.6.8     
   
## Build Status
**Version: 0.1.0**

Current development of PyPayStack is version 0.1.0. This is considered the Alpha Edition. Future releases will
 support export of application data to communication interface to enable information exchange between payment systems.
 
## Features
Support PayStack features includes:
+ Initialize Transaction
+ Verify Transaction
+ List Transactions  
+ Fetch Transaction  
+ Change Authorization  
+ View Transaction Timeline  
+ Transaction Totals  
+ Export Transactions  
+ Request Reauthorization  
+ Check Authorization  
+ Create Customer
+ List Customers
+ Fetch Customer
+ Update Customer
+ Customer Access Control
+ Deactivate Authorization
+ Create Subaccount
+ List Subaccounts
+ Fetch Subaccount
+ Update Subaccount
+ Create Plan
+ List Plans
+ Fetch Plan
+ Update Plan
+ Create Subscription
+ List Subscriptions
+ Fetch Subscription
+ Disable Subscription
+ Enable Subscription
+ Create Product
+ List Products
+ Fetch Product
+ Update Product
+ Create Page
+ List Pages
+ Fetch Page
+ Update Page
+ Check Slug Availability
+ Add Products
+ Create Invoice
+ List Invoices
+ View Invoice
+ Verify Invoice
+ Send Notification
+ Invoice Metrics
+ Finalize Draft
+ Fetch Invoice
+ Update Invoice
+ Archive Invoice
+ Mark As Paid
+ Fetch Settlements
+ Create Transfer Recipient
+ List Transfer Recipients
+ Update Transfer Recipient
+ Delete Transfer Recipient
+ Initiate Transfer
+ List Transfers
+ Fetch Transfer
+ Finalize Transfer
+ Initiate Bulk Transfer
+ Check Balance
+ Resend Transfer Otp
+ Disable Otp Requirement
+ Finalize Disabling Otp
+ Enable Otp Requirement
+ Initiate Bulk Charge
+ List Bulk Charges
+ Fetch Bulk Charge Batch
+ Fetch Bulk Charges In Batch
+ Pause Bulk Charge Batch
+ Resume Bulk Charge Batch
+ Fetch Payment Session Timeout
+ Update Payment Session Timeout
+ Charge
+ Submit PIN
+ Submit OTP
+ Submit Phone
+ Submit Birthday
+ Check Pending Charge
+ Create Refund
+ List Refunds
+ Fetch Refund
+ Resolve BVN
+ Bvn Match
+ Resolve Account Number
+ Resolve Card BIN
+ Resolve Phone Number
+ List Banks

## Sample Usage
PyPayStack is designed to provide support for all PayStack gateway feature. It can also be adopted to provide full
 financial services like payment settlement etc. for various business model. This tool does ot provide accounting
  packages or financial asset management etc. It simply does one core thing: process and management payment as
   prescribed by PayStack.

Sample test run:
Initiating Transaction
![Transaction Run](paystack/initiating_transaction.png)    
 
## Contributing
Please visit application repo for further information on extending project. Ideas and comments will be reasonably
 appreciated. 
 
## Author
Current development is by Aniefiok Friday [@frier17](https://gitlab.com/frier17). 

## License
Apache License

Version 2.0, January 2004

http://www.apache.org/licenses/

For details read license contract [here](http://www.apache.org/licenses/LICENSE-2.0)

Copyright 2019 @frier17

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
