README.mkd

Community-maintained GSTN Documentation

This project aims to provide developers, tax consultants, and other professionals with information about the APIs provided by Goods and Services Tax Network (GSTN), the technology backbone for GST in India, and compliment GSTN's official documentation.

Contribute

You may contribute in the following ways

• Ask a question by creating an issue. As part of closing the issue, we will update the documentation.
• Report errors and gaps in the documentation by creating a new issue.
• Update the documentation and submit pull requests. To submit a pull request, you can directly edit the documentation from your web browser.

License

This project is released under the liberal MIT License. By contributing to this project you agree to release your code or documentation under this license.

Documentation

1. GST Ecosystem
   1. List of Approved GST Suvidha Providers (GSP)
2. Developer Portal
   1. Getting started and accessing the GSTN Sandbox
   2. Encryption - GST APIs use encryption between GSTN and ASP software to protect man-in-the-middle attacks, including by GSPs
      • To encrypt ASP Application Key with the GSTN Public Key, use RSA/ECB/PKCS1Padding Source
      • For every other request encryption and response decryption, use AES/ECB/PKCS5Padding Source
   3. Authentication APIs
      1. Authentication workflow
   4. Returns APIs
      1. Returns overview
      2. Returns workflow - Mailing list announcement
      3. Returns API sequence diagrams
      4. Checksum algorithm