FASTag Balance API

Introduction

The FASTag Balance API returns the live FASTag wallet balance of an Indian vehicle, along with how much more can be recharged and the status of the tag. You send the vehicle's registration number and the name of the bank that issued its FASTag. In return you get the available balance, the available recharge limit, the tag status and the account holder's name as held by the issuer.

Sample Curl

curl --location 'https://api.signzy.app/api/v3/vehicle/fastag-balance' \
--header 'Content-Type: application/json' \
--header 'Authorization: <Auth Token>' \
--data '{
    "vehicleNumber": "MH03CM4824",
    "providerName": "axis_bank"
}'

Input Parameters

Parameter	Description	Required
vehicleNumber	Vehicle registration number Example: MH03CM4824.	Yes
providerName	FASTag issuer name. Exactly one value from the Supported Providers list. Example: airtel_payments_bank_netc.	Yes

Supported Providers

Send providerName exactly as listed below.

Provider Name	Provider Name	Provider Name
au_bank	axis_bank	canara_bank
union_bank_of_india	uco_bank	federal_bank
airtel_payments_bank_netc	indian_bank_recharge	idfc_first_bank
equitas_recharge	iob	karnataka_bank
hdfc_bank	yes_bank	bajaj_pay
bank_of_baroda	jammu_and_kashmir_bank	indusind_bank
idbi_bank	indian_highways_management_company_ltd	livquik_technology_india_private_limited
state_bank_of_india_netc	icici_bank	south_indian_bank
bandhan_bank	bank_of_maharashtra	kotak_mahindra_bank

Sample Response

{
  "result": {
    "vehicleNumber": "MH03CM4824",
    "providerName": "axis_bank",
    "providerCode": "<NETC issuer code>",
    "customerName": "Ravi Kumar",
    "availableRechargeLimit": "2500.00",
    "availableBalance": "1240.00",
    "tagStatus": "Active",
    "vehicleClass": "VC4",
    "vehicleClassDesc": "CAR/JEEP/VAN",
    "modelName": "<Model name>"
  }
}

Response Parameters

PARAMETER NAME	DATA TYPE	DESCRIPTION
result	Object	Wrapper for the successful response.
result.vehicleNumber	String	Registration number as resolved by the issuer, in upper case.
result.providerName	String	The providerName from the request, returned unchanged.
result.providerCode	String	NETC issuer code of the provider, for example AIRT00000NATVI.
result.customerName	String	Name of the FASTag account holder as registered with the issuer. This may differ from the registered owner on the RC.
result.availableBalance	String	Current usable wallet balance in INR, as a decimal string, for example 862.45.
result.availableRechargeLimit	String	Maximum amount in INR that can still be recharged into the wallet, as a decimal string, for example 25000.0. Depends on the account's KYC tier.
result.tagStatus	String	Status of the tag as reported by the issuer, for example Active, Low Balance or Blacklist. Values come directly from the issuer and are not normalised. Treat any value other than Active as needing attention.
result.vehicleClass	String	NETC vehicle class code, for example VC4. Empty string if the issuer does not supply it.
result.vehicleClassDesc	String	Readable vehicle class, for example CAR/JEEP/VAN. Empty string if the issuer does not supply it.
result.modelName	String	Vehicle model as recorded by the issuer. Empty string if the issuer does not supply it.

Error Code Response & Mapping

{
    "error": {
        "message": "No data found for the given combination",
        "reason": "NOT_FOUND",
        "status": 404,
        "type": "Not Found",
        "statusCode": 404,
        "name": "error"
    }
}

Field	Type	Description
name	string	Text displayed on the screen explaining error type.
reason	string	Reason for the error.
status	number	HTTP status code.
message	string	Error message indicating an upstream error.
type	string	Error type.
statusCode	number	Status code representing the error scenario.

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.

We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!