GET - Purchase Status | Help Center

Retrieves the status and result of a toll voucher purchase using the GUID returned in the POST request.

Endpoint

GET /valePedagio/comprar/{enterpriseId}/{guid}

Body

Response

Success Example

{
  "valor": 500.0,
  "numeroVP": 123456789012,
  "codigoVerificadorVP": "ABCD",
  "idANTT": "12345678901234567890",
  "sucesso": true,
  "erros": []
}

Success Layout

Field	Type	Description
valor	number	Total toll voucher amount
numeroVP	number	System-generated toll voucher number
codigoVerificadorVP	string	Verification code associated with the toll voucher
idANTT	string	Unique ANTT identifier for the toll voucher
sucesso	boolean	Indicates successful processing
erros	array	List of errors (empty if none)

Error Example

{
  "sucesso": false,
  "erros": [
    {
      "codigo": 400,
      "mensagem": "Failed to process operation: Insufficient balance in payment account"
    }
  ]
}

Field	Type	Description
sucesso	boolean	Always `false`, indicating the request failed
erros	array	List of errors
erros.codigo	number	Error code (e.g., `400` for validation or specific condition errors)
erros.mensagem	string	Error description (e.g., "Failed to process operation: Insufficient balance in payment account")

Error Layout

Field	Type	Description
sucesso	boolean	Always `false`, indicating the request failed
erros	array	List of errors
codigo	number	Error code (e.g., `400` for validation or specific condition errors)
mensagem	string	Error description (e.g., "Failed to process operation: Insufficient balance in payment account")