Skip to main content
POST

Request body schema

View request body schema

Prerequisites: You must have API credentials to hit E-Way Bill APIs. If not, create API credentials.
The returned access_token works with both e-Invoice and E-Way Bill APIs until it expires.
See NIC1 and NIC2 routing for x-source and x-proxy.

Authorizations

authorization
string
header
required

Sandbox access token returned by /authenticate.

x-api-key
string
header
required

Sandbox API key from your Sandbox account.

Headers

x-source
enum<string>
default:primary

NIC server for authentication. primary selects NIC1. secondary selects NIC2. Defaults to primary. See NIC1 and NIC2 routing.

Available options:
primary,
secondary
Example:

"primary"

x-api-version
string
default:1.0.0

API version

x-proxy
enum<string>

NIC server that receives the request. If omitted, the request goes to the server selected by x-source. When specified, selects the other server. See NIC1 and NIC2 routing.

Available options:
primary,
secondary

Body

application/json

E-Way Bill schema.

username
string
required

API username of taxpayer as set on E-Way Bill portal

password
string
required

API password of taxpayer as set on E-Way Bill portal

gstin
string
required

GSTIN of the taxpayer

Response

200 - application/json

200 Authenticated / 108 Invalid login credentials

An E-Way Bill success or NIC business-failure response. Both variants use HTTP 200.

code
enum<integer>
required

NIC response code.

Available options:
200
timestamp
integer<int64>
required

Unix timestamp.

transaction_id
string
required

Request transaction identifier.

data
E-Way Bill authentication success payload · object
required

E-Way Bill schema.