Parent API: GST API Quickstart guide Authentication guide

GST Challan Consolidated Summary

Q: What parameters and payload format are required for Get Challan Summary?

Requests are submitted via HTTP GET to '/payment/chllnsum'. Required parameters: 'gstin' (query parameter), 'cpin' (query parameter), 'email' (query parameter), 'gst_username' (header parameter), 'state_cd' (header parameter), 'ip_address' (header parameter), 'txn' (header parameter), 'client_id' (header parameter), 'client_secret' (header parameter). No request body payload is required for this call.

Q: What response status codes and format does Get Challan Summary return?

For Get Challan Summary (GET '/payment/chllnsum'), responses are returned in JSON format ('application/json'). Documented response codes in the specification include: HTTP 404 (Not Found. If requested entity is not found or if requested API is not found.), HTTP 500 (Internal server error).

GEThttps://apisandbox.whitebooks.in/payment/chllnsum

As per SRS, Taxpayer can view the challan Summary details through GSP after logging in to account.TaxPayer need to provide the GSTIN and CPIN and GSP invoke this interface the to get the challan summary. GST Backend system returns the Challan Summary Details with CPIN, Expiry Date, Creation Date, Total amount along with Payment status etc.

Parameters

query parameters

gstinstringrequired

GSTIN of the taxpayer

cpinstringrequired

CPIN

emailstringrequired

header parameters

gst_usernamestringrequired

GST UserName

state_cdstringrequired

State Code

ip_addressstringrequired

IP Address

txnstringrequired

Transaction

client_idstringrequired

Client ID

client_secretstringrequired

Client Secret

Response

Not Found. If requested entity is not found or if requested API is not found.

Frequently Asked Questions

Requests are submitted via HTTP GET to /payment/chllnsum. Required parameters: gstin (query parameter), cpin (query parameter), email (query parameter), gst_username (header parameter), state_cd (header parameter), ip_address (header parameter), txn (header parameter), client_id (header parameter), client_secret (header parameter). No request body payload is required for this call.

For Get Challan Summary (GET /payment/chllnsum), responses are returned in JSON format (application/json). Documented response codes in the specification include: HTTP 404 (Not Found. If requested entity is not found or if requested API is not found.), HTTP 500 (Internal server error).

Get Challan History

Validate Challan Reason

GET/payment/chllnsum

1const response = await fetch('https://apisandbox.whitebooks.in/payment/chllnsum?gstin=value&cpin=value&email=value', {

2 method: 'GET',

3 headers: {

4 gst_username: "value",

5 state_cd: "value",

6 ip_address: "value",

7 txn: "value",

8 client_id: "value",

9 client_secret: "value"

10},

11});

13const data = await response.json();

14console.log(data);

No example available.