Migrating from Karvy EWB GSP

Karvy EWB GSP is acquired by ClearTax. The current Karvy APIs will be deprecated by 30th June 2020. Migrate now.

SAP CPI Customers

If you are currently using Karvy iflow in your SAP CPI, you can migrate to ClearTax quickly by following the below steps.

Prerequisites

1. SAP EWB GSP Integration Guide (.pdf file).

2. SAP Cloud Integration Platform - Integration Flow Content package (.zip file).

3. SAP Cloud Integration Platform - Router Content package (.zip file).

4. NIC server public key (Sandbox and Production) (.zip file).

5. Register ClearTax as GSP on NIC.

6. ClearTax GSP SSL certificate (Sandbox and Production) (.cer file).

7. Externalized Parameters (Sandbox and Production)

There is no change in points 1 to 4 above.

Register ClearTax as GSP on NIC

For the list of sandbox GSTIN username and password, click here.

To register ClearTax as GSP in NIC portal for production, follow this guide:

How to register EWB GSP on NIC?

Download ClearTax GSP SSL certificate

You can download the SSL certificates below:

1KB

EWB_GSP_SSL_Sandbox.cer

ClearTax EWB GSP Sandbox SSL

1KB

wildcard.cleartax.in.cer

ClearTax EWB GSP Production SSL

In case you need root certificate, you can download it from here.

Obtain Externalized Parameters

You need to change only 3 parameters: karvyclient_secret, karvy_auth_url and karvy_ewaybill_url.

Sandbox

Update the following parameters with the new values:

Parameter	Value
karvyclientid	<same karvyclientid as before>
karvyclient_secret	<please check your email or write to [e-mail]>
karvy_auth_url	https://api-sandbox.clear.in/ewb-gsp/v1.03/auth https://ewb-gsp-staging.internal.cleartax.co/ewb-sandbox/v1.03/authenticate
karvy_ewaybill_url	https://api-sandbox.clear.in/ewb-gsp/v1.03/ewayapi https://ewb-gsp-staging.internal.cleartax.co/ewb-sandbox/v1.03/ewayapi

Production

Update the following parameters with the new values:

Parameter	Value
karvyclientid	<same karvyclientid as before>
karvyclient_secret	<please write to [e-mail]>
karvy_auth_url	https://api.clear.in/ewb-gsp/v1.03/auth https://ewb-gsp.cleartax.in/ewb/v1.03/authenticate
karvy_ewaybill_url	https://api.clear.in/ewb-gsp/v1.03/ewayapi https://ewb-gsp.cleartax.in/ewb/v1.03/ewayapi

The following parameters will remain the same in both sandbox and production.

Parameter	Value
nicpkalias	niccert
nic_token_expiry	300

Note: NIC public key alias value is alias you have entered as same as the alias of the NIC public key certificate you deployed (niccert).

Step by step guide

In your Subaccount > Applications > Subscriptions corresponding to your sandbox (pre-production), select the Web UI URL something like: https://xxx-xxx.xxx.xxx.hana.ondemand.com/itspaces

Step 1 – Add and deploy keystore

To deploy keystore, in SCPI Web UI URL, go to Monitor > Manage Security > Keystore > Add keystore (add an alias and select the ClearTax SSL certificate) > Deploy > Confirm.

Note: To perform above operation, you need to be a tenant administrator with role AuthGroup.Administrator.

Step 2 – Test connection

To check the connectivity with GSP, in SCPI Web UI URL, go to Monitor > Manage Security > Connectivity Tests > TLS > Enter the ClearTax EWB GSP base URL without https (ewb-gsp-staging.internal.cleartax.co for sandbox and ewb-gsp.cleartax.in for production) and port > Send. The reponse should be successful.

Step 3 – Update and deploy GSP iflow

In SCPI Web UI URL, To update the GSP iflow, go to Design > select E-Waybill package > Artifacts > against the gsp iflow, click on actions icon > configure > Define the externalized parameters as provided by ClearTax. Once parameters are updated, click save and then deploy.

After successful deployment, check the integration flows are in Started state by choosing Monitor > Manage Integration Content.

Step 4 – Add user credentials per GSTIN from NIC provided by your GSP .

In SCPI Web UI URL, To add user credentials, go to Monitor > Manage Security > Security Material > Add > User Credentials > Deploy.

You can follow the same steps to configure production environment also.

We highly recommend you to test the entire flow with all scenarios in the sandbox environment before moving to production.

In case there is any change in the API in the future, you will have to update the iFlow which will be provided by ClearTax.

Error Codes

In case you have received an error code from NIC, you can check the description of the code here: https://docs.ewaybillgst.gov.in/apidocs/api-error-codes-list.html

Other ERP or Mode

If you are using SAP but not CPI, OR if you are not using SAP, please follow this guide:

Getting Started with EWB GSP API