← HomeFleetPay / API

Cancel an MDF-e

Parameters, data structure and responses from the versioned contract.

POST/fiscal/mdfe/{mdfe_uuid}/cancelamento

cancelMdfeSandbox 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.

Parameters

mdfe_uuidpath · stringRequired

Public MDF-e UUID.

Constraints

{
  "type": "string",
  "format": "uuid"
}

Request Body

Required

`application/json`

JustificationInput ↗

justificationstringRequired

minLength15

maxLength255

Responses

200 HTTP Response

MDF-e operation completed.

`application/json`

MdfeOperationEnvelope ↗

dataobjectRequired

MdfeOperationData ↗

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.

404 HTTP Response

Resource not found in the authenticated tenant.

`application/json`

ErrorEnvelope ↗

errorobjectRequired

ErrorBody ↗

Headers

X-Request-Id

Call correlation identifier.

422 HTTP Response

Invalid payload, outstanding requirement or business rule.

`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.

503 HTTP Response

The result could not be confirmed or retrieved at this time. Query before repeating commands.

`application/json`

ErrorEnvelope ↗

errorobjectRequired

ErrorBody ↗

Headers

X-Request-Id

Call correlation identifier.

Complete Operation Definition

{
  "tags": [
    "MDF-e"
  ],
  "summary": "Cancelar MDF-e",
  "operationId": "cancelMdfe",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/JustificationInput"
        }
      }
    }
  },
  "responses": {
    "200": {
      "$ref": "#/components/responses/MdfeOperationOk"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "403": {
      "$ref": "#/components/responses/Forbidden"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    },
    "422": {
      "$ref": "#/components/responses/ValidationOrBusinessRuleFailed"
    },
    "429": {
      "$ref": "#/components/responses/RateLimited"
    },
    "500": {
      "$ref": "#/components/responses/InternalError"
    },
    "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
    }
  },
  "method": "POST",
  "path": "/fiscal/mdfe/{mdfe_uuid}/cancelamento",
  "parameters": [
    {
      "$ref": "#/components/parameters/MdfeUuid"
    }
  ]
}