Através deste endpoint é possível realizar um evento de Pagamento da Operação de Transporte para um manifesto previamente autorizado através da API.
Este evento é possível apenas para TAC-Agregado.
URL
Produção: POST https://mdfe.ns.eti.br/mdfe/operpayment
Dados de entrada
| Campo | Descrição | Ocorrência | Pai | Tipo | Observação |
|---|---|---|---|---|---|
| X-AUTH-TOKEN | Token de acesso do usuário | 1-1 | C | ||
| chMDFe | Chave de acesso da MDF-e | 1-1 | N | ||
| tpAmb | Tipo do ambiente de autorização do MDF-e | 1-1 | N | 1 - Produção; 2 - Homologação | |
| dhEvento | Data e hora da ocorrência do evento | 1-1 | Date | Padrão Sefaz AAAA-MM-DDTHH:MM:SS + UTC Ex.: 2016-06-13T15:04:10-02:00 | |
| nProt | Número do protocolo de autorização do MDF-e | 1-1 | N | ||
| infViagens | Informações do total de viagens acobertadas pelo Evento “pagamento do frete” | 1-1 | O | ||
| qtdViagens | Quantidade total de viagens realizadas com o pagamento do Frete | 1-1 | infViagens | N | Tamanho: 5 |
| nroViagem | Número de referência da viagem do MDF-e referenciado | 1-1 | infViagens | N | Tamanho: 5 |
| infPag | Grupo de Informações dos pgto do MDF-e | 1-N | Array | ||
| xNome | Nome do contratante | 0-1 | infPag | C | Tamanho: 2-60 |
| CNPJ | Número do CNPJ do contratante do serviço | 1-1 | infPag | N | Obrigatório quando CPF e idEstrangeiro não preenchidos |
| CPF | Número do CPF do contratante do serviço | 1-1 | infPag | N | Obrigatório quando CNPJ e idEstrangeiro não preenchidos |
| idEstrangeiro | Identificador do contratante em caso de contratante estrangeiro | 1-1 | infPag | C | Obrigatório quando CNPJ e CPF não preenchidos |
| vContrato | Valor total do contrato | 1-1 | infPag | Dec | Formato: 13v2 |
| indPag | Indicador da Forma de Pagamento | 1-1 | infPag | N | 0-Pagamento à Vista; 1-Pagamento à Prazo; |
| infBanc | Informações bancárias | 1-1 | infPag | O | |
| codBanco | Número do banco | 1-1 | infBanc | C | Obrigatório quando CNPJIPEF não preenchido |
| codAgencia | Número da Agência | 1-1 | infBanc | C | Obrigatório quando CNPJIPEF não preenchido |
| CNPJIPEF | Número do CNPJ da Instituição de pagamento Eletrônico do Frete | 1-1 | infBanc | N | Obrigatório quando codBanco e codAgencia não preenchidos |
| Comp | Componentes do Pagamento do Frete | 1-N | infPag | O | |
| tpComp | Tipo do Componente | 1-1 | Comp | N | 01 - Vale Pedágio 02 - Impostos, taxas e contribuições 03 - Despesas (bancárias, meios de pagamento, outras) 99 – Outros |
| vComp | Valor do Componente | 1-1 | Comp | Dec | Formato: 13v2 |
| xComp | Descrição do componente do tipo Outros | 0-1 | Comp | C | Tamanho: 2-60 |
| infPrazo | Informações do pagamento a prazo | 0-1 | infPag | Informar somente se indPag for à Prazo | |
| nParcela | Número da parcela | 0-1 | infPrazo | N | Tamanho: 3 |
| dVenc | Data de vencimento da Parcela | 0-1 | infPrazo | D | Formato: AAAA-MM-DD |
| vParcela | Valor da parcela | 1-1 | infPrazo | N | Formato: 13v2 |
Exemplo de requisição
Requisição de encerramento de MDF-e
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"chMDFe": "99999999999999999999999999999999999999999999",
"nProt": "999999999999999",
"tpAmb": 2,
"dhEvento": "2020-03-23T18:06:00-03:00",
"infViagens": {
"qtdViagens": "00001",
"nroViagem": "05897"
},
"infPag": [
{
"CPF": "99999999999",
"vContrato": "5.00",
"indPag": "0",
"infBanc": {
"CNPJIPEF": "99999999999999"
},
"Comp": [
{
"tpComp": "01",
"vComp": "5.00"
}
]
}
]
}'\
https://mdfe.ns.eti.br/mdfe/operpayment
Dados retornados
| Campo | Descrição | Tipo | Pai | Observação |
|---|---|---|---|---|
| status | Código de status do processamento | N | ||
| motivo | Descrição literal do status de processamento | A | ||
| retEvento | Objeto contendo os dados de processamento do cancelamento na Sefaz | O | Somente em status = 200 | |
| cStat | Código de situação do processamento | C | retEvento | |
| xMotivo | Descrição literal da situação do processamento na Sefaz | A | retEvento | |
| chMDFe | Chave de acesso do MDF-e | N | retEvento | Somente em cStat = 135 |
| dhRegEvento | Data e hora de registro do evento na Sefaz | D | retEvento | Padrão Sefaz AAAA-MM-DDTHH:MM:SS + UTC Ex.: 2016-06-13T15:04:10-03:00 Somente em cStat = 135 |
| nProt | Número do protocolo de autorização do evento | N | retEvento | Somente em cStat = 135 |
| xml | XML de distribuição do evento de cancelamento | S | retEvento | Somente em cStat = 135 |
| erro | Objeto contendo as informações de erro caso o cancelamento não possa ser realizado com sucesso | O | Somente em status diferente de 200 | |
| cStat | Código de status do erro | N | erro | |
| xMotivo | Descrição literal do erro | A | erro |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Pagamento de Operação incluído com sucesso",
"retEvento": {
"cStat": "135",
"xMotivo": "Evento registrado e vinculado ao MDF-e",
"chMDFe": "43170507364617000135580000000003431000003367",
"dhRegEvento": "2017-05-15T12:01:00-03:00""nProt": "184211003521139""xml": "<procEventoMDFe></procEventoMDFe>"
}
}
Códigos de retorno
| Código | Descrição |
|---|---|
| 200 | MDF-e cancelado com sucesso |
| -2 | Chave de acesso inválida |
| -3 | Não foi possível cancelar a MDF-e Verifique o objeto erro para maiores informações |
| -4 | Problema com certificado digital Verifique o objeto erro para maiores informações |
| -7 | Deve ser informada uma lista de infPag contendo ao menos 1 elemento |