Structure of the SDK

    |- python-sdk
        |- dist/
        	|- PayZippySDK-0.1.0.tar.gz
        |- django/
        	|- static/
        	|- config.ini
            |- settings.py
            |- urls.py
            |- views.py
        |- examples/
        	|- charging-iframe/
            |- charging-master/
            |- charging-minimal/
            |- charging-redirect/
            |- common/
            |- query/
            |- refund/
            |- response/
            |- index.html
        |- payzippysdk/
            |- ChargingRequest.py
            |- ChargingResponse.py
            |- CommonUtil.py
            |- Config.py
            |- Constants.py
            |- HashUtil.py
            |- QueryRequest.py
            |- QueryResponse.py
            |- QueryTransactionResponse.py
            |- RefundRequest.py
            |- RefundResponse.py
            |- RefundTransactionResponse.py
            |- ValidityCheck.py
    

---

Setup

To install the SDK

1. Extract the file /dist/PayZippySDK-0.1.0.tar.gz by running the command gunzip < PayZippySDK-0.1.0.tar.gz | tar xvf - in your terminal
2. Go inside the folder PayZippySDK-0.1.0
3. Run the command python setup.py install in your terminal(Make sure you have python installed in your computer)

To run the examples

1. Use the examples folder as the template directory in your Django project.
2. Copy the file config.ini from the directory django/ to your Django project.
3. Copy the directory static from the directory django/ to your Django project.
4. Copy the views definition from the file django/views.py to views.py file in your Django project.
5. Copy the urls definition(including the imports) from the file django/urls.py to urls.py file in your Django project.
6. Copy the BASE_DIR, STATIC_URL, STATICFILES_DIRS, TEMPLATE_DIRS declarations from the file django/settings.py to settings.py file in your Django project.
7. To set up your config details, fill the details provided by PayZippy, in config.ini file.
• MERCHANT_ID Your Merchant ID
• SECRET_KEY Your Secret Key for the Payzippy API. Do not share this!
• CALLBACK_URL The URL that the Charging API would call on transaction completion. For the examples provided, this should point to : /chargingresponse as defined in the file urls.py

---

Examples

To check out the sample SDK integrations, go the SDK Integration Examples page.

---