GST Return status

Get GST Return status after saving return. Returns any errors and info in the return saved.

GET /gst/compliance/tax-payer/gstrs/{year}/{month}/status

GST Return status

cURL

curl --request GET \
  --url https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/{year}/{month}/status \
  --header 'authorization: <authorization>' \
  --header 'x-api-key: <x-api-key>'

import requests

url = "https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/{year}/{month}/status"

headers = {
    "authorization": "<authorization>",
    "x-api-key": "<x-api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {authorization: '<authorization>', 'x-api-key': '<x-api-key>'}
};

fetch('https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/{year}/{month}/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/{year}/{month}/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "authorization: <authorization>",
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/{year}/{month}/status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("authorization", "<authorization>")
	req.Header.Add("x-api-key", "<x-api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/{year}/{month}/status")
  .header("authorization", "<authorization>")
  .header("x-api-key", "<x-api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/{year}/{month}/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = '<authorization>'
request["x-api-key"] = '<x-api-key>'

response = http.request(request)
puts response.read_body

200

200 GSTR-1 reset processed

{
  "code": 200,
  "data": {
    "status_cd": "1",
    "data": {
      "action": "RESET",
      "form_typ": "R1",
      "status_cd": "P"
    }
  },
  "timestamp": 1763446641000,
  "transaction_id": "c34bd5f1-d986-46fd-be85-457587ffda0e"
}

Response schema

For successful responses, these resources describe the GSTN payload at data.data.

View JSON schema

View Excel field reference

Headers

authorization · string · required

GST taxpayer access token. For token-generation steps, refer to the Generate Taxpayer Session recipe, then pass the token in the authorization header.

x-api-version · string · default: 1.0.0

API version

x-api-key · string · required

API key for identification

Path Parameters

year · string · required

month · string · required

Query Parameters

reference_id · string · required

required Reference ID

Example:

"{{reference_id}}"

Response

200 - application/json

200 GSTR-1 save processed / 200 GSTR-1 save processed with error / 200 GSTR-1 reset processed / 200 GSTR-3B save processed / 200 GSTR-9 save processed / 200 GSTR-9 save processed with error / RET191350 HSN code is not valid as per AATO / RET191353 The UQC entered is not valid / RET191355 The Quantity entered is not valid / RET191175 Enter GST rate as per the rate list / RET191106 Error in JSON structure / RET191251 RESET is under process / 200 Reset Request Received

Option 1

Option 2

A GSTN success or GSTN business-failure response. Both variants use HTTP 200.

code · enum<integer> · required

The HTTP status code reported in the response body.

Available options: 200

Example:

200

timestamp · integer<int64> · required

The response timestamp in Unix epoch milliseconds.

Example:

1763446641000

transaction_id · string · required

The transaction identifier used to trace the request.

Example:

"41bb8041-fb83-4654-8d75-85a19f329158"

data · object · required

The GSTN success wrapper.

Show child attributes