← HomeFleetPay / API

Order payment of installment N for an MDF-e

Parameters, data structure and responses from the versioned contract.

POST/carriers/parcelas-repasse/pagar-por-mdfe

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

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

The manifest-based batch equivalent of pagar: applies the payment order for the specified installment position to each CT-e in the MDF-e, returning one result per CT-e (ordenada, ja_ordenada, recusada, ignorado). The individual order rules apply: the installment must be released (parcela_nao_liberada), the previous installment must have an order (parcela_anterior_sem_ordem), and the service must exist (servico_inexistente). An already released installment in automatic mode returns ja_ordenada: there is no manual order to issue.

Authentication

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

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

Parameters

No parameters declared for this operation.

Request Body

Required

`application/json`

PagarParcelasPorMdfe ↗

mdfestringRequired

maxLength64

posicaointegerRequired

minimum1

maximum3

Responses

200 HTTP Response

MDF-e processed; read resumo and documentos[].resultado.

`application/json`

RespostaParcelasPorMdfe ↗

dataobjectOptional

ParcelaPorMdfeLinha ↗

401 HTTP Response

Unauthenticated (autenticacao): missing, invalid or expired credentials, including an API key used in the wrong environment. A sandbox key is not valid in production, nor a production key in the sandbox; the error message indicates the expected environment.

`application/json`

Erro ↗

errorobjectOptional

403 HTTP Response

Credential does not have the operacao scope enabled.

`application/json`

Erro ↗

errorobjectOptional

404 HTTP Response

MDF-e not found or belongs to another carrier (mdfe_nao_encontrado).

`application/json`

Erro ↗

errorobjectOptional

422 HTTP Response

MDF-e has no linked CT-e (mdfe_sem_documentos), or the payload is invalid.

`application/json`

Erro ↗

errorobjectOptional

Complete Operation Definition

{
  "tags": [
    "Parcelas"
  ],
  "summary": "Ordenar o pagamento da parcela N de todos os CT-e de um MDF-e",
  "operationId": "pagarParcelasPorMdfe",
  "description": "Gêmea de `pagar`, em lote pelo manifesto: aplica a ordem de pagamento da posição a cada\nCT-e do MDF-e e devolve um resultado por CT-e (`ordenada`, `ja_ordenada`, `recusada`,\n`ignorado`). Valem as regras da ordem unitária — parcela precisa estar liberada\n(`parcela_nao_liberada`), a anterior precisa ter ordem (`parcela_anterior_sem_ordem`) e o\nserviço precisa existir (`servico_inexistente`). Parcela em modo automático já liberada\nresponde `ja_ordenada`: não há ordem manual a dar.\n",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/PagarParcelasPorMdfe"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "O MDF-e foi processado; leia `resumo` e `documentos[].resultado`.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/RespostaParcelasPorMdfe"
          }
        }
      }
    },
    "401": {
      "$ref": "#/components/responses/Erro401"
    },
    "403": {
      "description": "Credencial sem o escopo `operacao` habilitado.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    },
    "404": {
      "description": "MDF-e não encontrado, ou de outra transportadora (`mdfe_nao_encontrado`).",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    },
    "422": {
      "description": "MDF-e sem CT-e vinculado (`mdfe_sem_documentos`), ou payload inválido.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    }
  },
  "method": "POST",
  "path": "/carriers/parcelas-repasse/pagar-por-mdfe",
  "parameters": []
}