Skip to content

Eway Bill Get Call

In case of a GET call you need to do the following

Build the get string#

Refer to API Ecosystem and NIC API document to form the correct URL.

The below example is provided for version: v1.03

The get string will require adding the required parameters as follows

  • Sandbox: <base_url>/gus/eway/{ewb_provider}/ewaybillapi/v1.03/ewayapi/GetEwayBill?ewbNo=171000681262
  • Production: <base_url>/gus/eway/{ewb_provider}/v1.03/ewayapi/GetEwayBill?ewbNo=171000681262

Build the request payload#

The request payload will look somewhat like follows. You will need to use the authtoken that you received as a return value from the authentication call earlier. The X-ASP-* header values will need to be constructed similarly to how you constructed them in the earlier call. For clarity, a sample is provided below.

Note: When you construct the auth token, for get calls the API ACTION field (last field) will be a blank value so your X-ASP-Auth-Token will end with a colon.

Name Value
gstin <your-GSTIN>
authtoken <your-authorization-token>
X-Asp-Auth-Token <your-X-Asp-Auth-Token>
X-Asp-Auth-Signature <your-X-Asp-Auth-Signature>

Response content#

The returned response content if successful will look like follows (you will receive it all in the single line. it has been indented for clarity)

{
    "status":"1",
    "data":"ljoyygt/ljQPAa0miD08qdb+m79vyIc49Webj5xWahO6LMx3gDsIo9pyaSfMP+UJ8+Bp4sJ462CKVF1ijcATH6jWbD+aQCxrR1YYUeIP/ac2mRYYvAPsDzCPaH5Viy5ordrLp/DCUEWf5iPQSCNwA+M2ZHyTkdxsI8Uk4ju4tD9i3ZPmb9uuhWma5pCBqcsGWU0uhm4nBr5+7j4vLNb2Ty72GGFPkUMTuuJnWLLHrDODHws69FRvGsxKg3W2WkLPpXSL7/anYLO9IvRDM47XeGe3h3wXwxylJea8flvkZHvG5IFvy6Qy9RC1Q8uLTcZrhM4lLbbrJRKrQ3tZc1jf9KKZj4hrUvKVy3iFEgVGPGh2GbUb78OmqR268oBkYIgYBmteRufCZ2s/ixWNTevPdW5eUjS8YLiWI9aZGn/2IuKC1u54GrPDG2CjpdvXXU32ERmv/zncZ3VrAoLxNLcKtoO+lls89eUopThiRw0bgmwSOmN5ZeB8A/Y4KgtG0edlGLyGCQ3hjbexKy0RKMtIea+92wa/fctiZTmOPlUihJMbc72wy2/dH861xwNZ5dsDurA74vJxh6wAWa6cXKz3Gc2zHTdAAME2TxdRFnb5872k91qMqrToM8HN6MYtnW0xqxwDV2+i6FIuNRuRd4ndXs6i+wv5QlRM42+oqKr/xLryDfB+KUzfq2euRBAsEuq3xN7Ub5sT3D/3Qob83NlteGhzIo7tEewcpGbBtGhs2DcCExvZ5MiEju+XvJVp7Rjss0/qKNHsSAJyZQehKiOF/45Phy0M/2aTWHL447PAvMSBbACW2EIDtMGlMfFVQfH8K94aHYzcRJy/ey4kHEiOTg9SyttANvNEZupZU5dUFqAKdQJEnTojPhhORpGlAdErXZ39XyYnXJ1tGiKdZWif0UEQ68U61rCtAaDzRhVoSy7hGCXfzmDE/CPBbn1tqSl1TlG2+CWcI6U8sQArNH+rqXgvUYk1coyDyhTLM1qQC2eY91pqB3pM3KUFjWbqCER+5ghx2KK+kvI1jIzo/pnv2cUZWJ/IXmrKuTv9kN+ya/EQsWfCeIoKhS+/LzE7pjBTpGlL9ZRdqkPRpoNXmml3l4oHKn87MFCfskPsNOIExSMjFzM8ZUnHgTnUuV4CzDScKx1u+nRmHHKcztC/peCCE8a4ZXkAnTR1YEm0mvH3XZbb0oADDTaiTTyr9zmLV466yS1sODlJEcg93n6ZXXLTAIaJ6LFbrOZBdGb60sOZfANa7Bb855drvL0l04k2htTgl062cB9MVJl0YMSqdmsgOm0qIUEAhZTOzqVMcgVuRgB5xGZVLI9oMfxvPInO/9lR6oopselTq4D1pcU5AtoOjybDZI7F3fWtk1Y8Njy9zNAVGAzq3t5v6Jjkc7sA3l+hITfVudcFKD+GESrCRqwNQIIT835Jwvac7IOqQy23TxqHIW9TxOz20O7ViIZvYVHdxkV8IvUFHEHJtQyxIieH1tGj4LzCZgj6GuexxGyLRa3hEv0oTYZGU4yikbq2pOp6nMo/NKvxUS5GP0lAKGYs879eiSN7hS2vf94h5iv0xhAbLrZNJI6tVB6PoyxA9KY/dQpVzp/0tbJtKxV3lBY+4eUxtWChJLxED493FwwHeTL1AiVLAonAxtR94+8DfVhrsKH/KT4s3ytyTnW6IOr9nNYq8AeMTH249cwi3c9ILW3YK6vmUBqPGfZUCdT46WVtZiYILezxFsZRy4PP5HwpnoVeMe5xv5ogjRbgOUvIimQjYXnbDUzhu3ECuZQOYpkmxJPcZvuPisrJVgB4DoxIIQ==",
    "rek":"D6W+kBBI+o8pjGPMXGWOtEoaGWq6ADlv7Y0F1tIHXxI2XYX4GIf1xQZLTO/TUlbq",
    "hmac":"P11hLD1UscGrpWL8ehx705OHIWoYVZbDTs8NqBU1EEQ="
}

You now need to decrypt the rek using the earlier provided sek that you received during the authentication handshake. A decrypted rek looks somewhat like

JXLd9AXsmM24E/Tp+5CcBOX7X8m6TA3yR8OojwMtruw=

You will now use the decrypted rek to decrypt the contents of the field “data”. The decrypted content of the data field will on successful decryption provide you a JSON string like follows. Again, you get it in a single line, but it is indented below for clarity.

Sample Response Payload#

{
  "ewbNo": 131001298692,
  "ewayBillDate": "26/09/2018 02:40:00 PM",
  "genMode": "API",
  "userGstin": "29AKLPM8755F1Z2",
  "supplyType": "O",
  "subSupplyType": "1 ",
  "docType": "INV",
  "docNo": "7007-8",
  "docDate": "10/09/2018",
  "fromGstin": "29AKLPM8755F1Z2",
  "fromTrdName": "welton",
  "fromAddr1": "4556",
  "fromAddr2": "hulimavu",
  "fromPlace": "bannargatta",
  "fromPincode": 560090,
  "fromStateCode": 29,
  "toGstin": "02EHFPS5910D2Z0",
  "toTrdName": "test2",
  "toAddr1": "Shree Nilaya",
  "toAddr2": "Dasarahosahalli",
  "toPlace": "Beml Nagar",
  "toPincode": 560090,
  "toStateCode": 29,
  "totalValue": 56099,
  "totInvValue": 68358,
  "cgstValue": 1,
  "sgstValue": 1,
  "igstValue": 0,
  "cessValue": 400.56,
  "transporterId": "",
  "transporterName": "",
  "status": "ACT",
  "actualDist": 2500,
  "noValidDays": 25,
  "validUpto": "27/09/2018 11:59:00 PM",
  "extendedTimes": 0,
  "rejectStatus": "N",
  "actFromStateCode": 29,
  "actToStateCode": 29,
  "vehicleType": "R",
  "transactionType": 4,
  "otherValue": -10,
  "cessNonAdvolValue": 400,
  "itemList": [
    {
      "itemNo": 1,
      "productId": 0,
      "productName": "CEMENT",
      "productDesc": " ",
      "hsnCode": 25210010,
      "quantity": 2,
      "qtyUnit": "BOX",
      "cgstRate": 0.05,
      "sgstRate": 0.05,
      "igstRate": 0,
      "cessRate": 3,
      "cessNonAdvol": 0,
      "taxableAmount": 56
    },
    {
      "itemNo": 2,
      "productId": 0,
      "productName": "steel",
      "productDesc": "steel rods",
      "hsnCode": 2402,
      "quantity": 4,
      "qtyUnit": "NOS",
      "cgstRate": 10,
      "sgstRate": 10,
      "igstRate": 0,
      "cessRate": 3,
      "cessNonAdvol": 0,
      "taxableAmount": 0
    }
  ],
  "VehiclListDetails": [
    {
      "updMode": "API",
      "vehicleNo": "PQR1234",
      "fromPlace": "Bengaluru",
      "fromState": 29,
      "tripshtNo": 1810002031,
      "userGSTINTransin": "29AKLPM8755F1Z2",
      "enteredDate": "26/09/2018 02:40:00 PM",
      "transMode": "1 ",
      "transDocNo": "1234",
      "transDocDate": "03/05/2018",
      "groupNo": "1"
    },
    {
      "updMode": "API",
      "vehicleNo": "PQR1234",
      "fromPlace": "Bengaluru",
      "fromState": 29,
      "tripshtNo": 1110002030,
      "userGSTINTransin": "29AKLPM8755F1Z2",
      "enteredDate": "26/09/2018 02:40:00 PM",
      "transMode": "1 ",
      "transDocNo": "1234",
      "transDocDate": "03/05/2018",
      "vehicleType": "",
      "groupNo": "0"
    },
    {
      "updMode": "API",
      "vehicleNo": "KA25AB3456",
      "fromPlace": "BANGALORE SOUTH",
      "fromState": 29,
      "tripshtNo": 1510002029,
      "userGSTINTransin": "29AKLPM8755F1Z2",
      "enteredDate": "26/09/2018 02:40:00 PM",
      "transMode": "1 ",
      "transDocNo": "1234",
      "transDocDate": "12/10/2017",
      "vehicleType": "",
      "groupNo": "0"
    },
    {
      "updMode": "API",
      "vehicleNo": "KA25AB3456",
      "fromPlace": "BANGALORE SOUTH",
      "fromState": 29,
      "tripshtNo": 1810002028,
      "userGSTINTransin": "29AKLPM8755F1Z2",
      "enteredDate": "26/09/2018 02:40:00 PM",
      "transMode": "1 ",
      "transDocNo": "1234",
      "transDocDate": "12/10/2017",
      "vehicleType": "",
      "groupNo": "0"
    },
    {
      "updMode": "API",
      "vehicleNo": "RJ191G5024",
      "fromPlace": "bannargatta",
      "fromState": 29,
      "tripshtNo": 0,
      "userGSTINTransin": "29AKLPM8755F1Z2",
      "enteredDate": "26/09/2018 02:40:00 PM",
      "transMode": "1 ",
      "transDocNo": "12345",
      "transDocDate": null,
      "vehicleType": "R",
      "groupNo": "0"
    }
  ]
}

You will now need to check the hmac value to see if it is correct. On the raw JSON string you received (that’s the byte array you get post decryption) compute the hmac using the rek you got.

That computed hmac will need to be the same as the hmac that was in the returned response payload, ie in this case P11hLD1UscGrpWL8ehx705OHIWoYVZbDTs8NqBU1EEQ