← HomeFleetPay / API

Check fiscal access and readiness

Parameters, data structure and responses from the versioned contract.

GET/fiscal/status

getFiscalStatusSandbox Base: https://api.fleetpay.site/v1

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

Authentication

[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]

Availability depends on the environment, enabled scopes and provider. This reference does not execute requests or collect credentials.

First Request

curl --request GET \
  https://api.fleetpay.site/v1/fiscal/status \
  --header "Authorization: Bearer $FLEETPAY_API_KEY" \
  --header "Accept: application/json"

Parameters

No parameters declared for this operation.

Responses

200 HTTP Response

Fiscal access available to the carrier.

`application/json`

StatusEnvelope ↗

dataobjectRequired

StatusData ↗

environmentobjectRequired

Environment ↗

Headers

X-Request-Id

Call correlation identifier.

401 HTTP Response

FleetPay API key missing or invalid.

`application/json`

ErrorEnvelope ↗

errorobjectRequired

ErrorBody ↗

Headers

X-Request-Id

Call correlation identifier.

403 HTTP Response

Fiscal scope disabled for the key, or no active carrier associated with the key.

`application/json`

ErrorEnvelope ↗

errorobjectRequired

ErrorBody ↗

Headers

X-Request-Id

Call correlation identifier.

429 HTTP Response

Per-carrier limit exceeded.

`application/json`

ErrorEnvelope ↗

errorobjectRequired

ErrorBody ↗

Headers

X-Request-Id

Call correlation identifier.

Retry-After

Seconds until another attempt.

500 HTTP Response

Internal failure without operational integration details.

`application/json`

ErrorEnvelope ↗

errorobjectRequired

ErrorBody ↗

Headers

X-Request-Id

Call correlation identifier.

Complete Operation Definition

{
  "tags": [
    "Serviço"
  ],
  "summary": "Verificar acesso e prontidão fiscal",
  "operationId": "getFiscalStatus",
  "responses": {
    "200": {
      "$ref": "#/components/responses/StatusOk"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "403": {
      "$ref": "#/components/responses/Forbidden"
    },
    "429": {
      "$ref": "#/components/responses/RateLimited"
    },
    "500": {
      "$ref": "#/components/responses/InternalError"
    }
  },
  "method": "GET",
  "path": "/fiscal/status",
  "parameters": []
}