TaxPro GST Lib
User guide (Under Construction)
×
Menu
Index
GST Pass Through API
 
These details are given here for Documentation.  Headers are added to all API calls using API methods if you are using TaxProGST.API library.
 
GSP Headers in Every API Calls
Header
Description
aspid
AspUserName or AspUserID provided by GSP.
asp-secret
AspPassword or AspSecreatKey provided by GSP for pass through API access, Encrypted using SessionEK (enc_key)
session-id
SessionID.  ASP may create multiple Sessions.
txn
Unique Transaction ID even if calling GSP Service API. (Requires only once, which you are already passing as requirement for GST API.)
appver
Application Name and Version calling API. (Optional but Recomanded)
 
GST Headers in Every API Calls (in addation to GSP Headers above)
Header
Description
username
GSTN Portal UserName (UserID) of TaxPayer.
gstin
GSTIN of TaxPayer.
state-cd
State code of TaxPayer. (First 2 digits of GSTIN).
auth-token
TaxPayer Authorization token obtained from GST Server.
ret_prd
Return Period (Required for Return API Calls)
ip-usr
IP of device from which API is being invoked.
txn
Unique Transaction ID.
Content-Type
application/json
 
It is recommanded to add Header 'appver' to every request which would help you debug API calls if required, with our help.
Override method AddApiHeaders in APISession to add required headers to every request.
public override void AddApiHeaders(RestRequest request)
        {
            request.AddHeader("appver", "MyApp" + Assembly.GetExecutingAssembly().GetName().Version.ToString());
            base.AddApiHeaders(request);
        }
 
        public override void AddGspApiHeaders(RestRequest request)
        {
            request.AddHeader("appver", "MyApp" + Assembly.GetExecutingAssembly().GetName().Version.ToString());
            base.AddGspApiHeaders(request);
        }