Através deste endpoint é possível realizar um evento de Alteração do Pagamento do Serviço de Transporte para um manifesto previamente autorizado através da API.
Autor do Evento: O autor é o emitente do MDFe.
URL
https://mdfe.ns.eti.br/mdfe/alterpayment
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.: 2023-01-24T15:04:10-02:00 |
| nProt | Número do protocolo de autorização do MDF-e | 1-1 | - | N | |
| nSeqEvento | Número sequencial do evento | 1-1 | - | N | |
| infPag | Grupo de Informações dos pgto do MDFe | 1-1 | - | O | |
| xNome | Nome do contratante | 0-1 | infPag | C | |
| CPF | Número do CPF do contratante do serviço | 1-1 | infPag | N | |
| CNPJ | Número do CNPJ do contratante do serviço | 1-1 | infPag | N | |
| idEstrangeiro | Identificador do contratante em caso de contratante estrangeiro | 1-1 | infPag | C | |
| 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 | N | |
| xComp | Descrição do componente do tipo outros | 0-1 | Comp | C | |
| vContrato | Valor total do contrato | 1-1 | infPag | N | |
| indPag | Indicador da Forma de Pagamento | 1-1 | infPag | N | 0-Pagamento à Vista; 1-Pagamento à Prazo. |
| vAdiant | Valor do Adiantamento | 0-1 | infPag | N | Informar apenas para pagamento a Prazo |
| indAntecipaAdiant | Antecipar o Pagamento | 0-1 | infPag | N | Informar apenas se for autorizado antecipar o pagamento |
| infPrazo | Informações do pagamento a prazo. | 0-n | infPag | O | Informar somente se o pagamento for à prazo |
| nParcela | Número da parcela | 1-1 | infPrazo | N | |
| dVenc | Data de vencimento da Parcela | 1-1 | infPrazo | Date | AAAA-MM-DD |
| vParcela | Valor da parcela | 1-1 | infPrazo | N | |
| tpAntecip | Tipo de Permissão em relação a antecipação das parcelas | 0-1 | infPrazo | N | 0 - Não permite antecipar; 1 - Permite antecipar as parcelas; 2 - Permite antecipar as parcelas mediante confirmação |
| infBanc | Informações bancárias. | 1-1 | infPag | O | |
| codBanco | Número do Banco | 1-1 | infBanc | C | |
| codAgencia | Número da Agência | 1-1 | infBanc | C | |
| CNPJIPEF | Número do CNPJ da Instituição de Pagamento eletrônico do Frete | 1-1 | infBanc | N | |
| PIX | Chave PIX | 1-1 | infBanc | C | Pode ser email, CPF/ CNPJ (somente números), Telefone com a seguinte formatação (+5599999999999) ou a chave aleatória gerada pela instituição. |
Exemplo de Requisição
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"X-AUTH-TOKEN": "ADQWREQW561D32AWS1D6",
"chMDFe": "43230107364617000135580010000119961104332214",
"nProt": "943230000000320",
"dhEvento": "2023-01-24T14:39:00-03:00",
"tpAmb": "2",
"nSeqEvento": "3",
"infPag": {
"xNome": "NS TECNOLOGIA",
"CPF": null,
"CNPJ": "07364617000135",
"idEstrangeiro": null,
"Comp": [
{
"tpComp": "99",
"vComp": "1000",
"xComp": "teste",
"vAdiant":"10.00"
}
],
"vContrato": "1000.00",
"indPag": "0",
"infBanc": {
"codBanco": null,
"codAgencia": null,
"CNPJIPEF": null,
"PIX": "+5551981494036"
}
}
}'\
https://mdfe.ns.eti.br/mdfe/alterpayment
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 status igual à 200 |
| cStat | Código de situação do processamento | C | retEvento | |
| xMotivo | Descrição literal da situação do processamento na Sefaz | A | retEvento | |
| idEvento | Id de identificação do Evento | N | retEvento | |
| chMDFe | Chave de acesso do MDF-e | N | retEvento | |
| dhRegEvento | Data e hora de registro do evento na Sefaz | Date | retEvento | AAAA-MM-DDTHH:MM:SS + UTC |
| nProt | Número do protocolo de autorização do evento | N | retEvento | |
| xml | XML de distribuição do evento de Alteração do Pagamento | S | retEvento | |
| erro | Objeto contendo as informações de erro caso o cancelamento não possa ser realizado com sucesso | O | - | Somente status diferente de 200 |
| cStat | Código de status do erro | N | erro | |
| xMotivo | Descrição literal do erro | A | erro |
Exemplo de Retorno
Retorno com sucesso:
{
"status": 200,
"motivo": "Alteração de Pagamento de Operação incluído com sucesso",
"retEvento": {
"cStat": "135",
"xMotivo": "Evento registrado e vinculado ao MDF-e",
"idEvento": "1101184323010736461700013558001000011996110433221403",
"chMDFe": "43230107364617000135580010000119961104332214",
"dhRegEvento": "2023-01-24T16:04:54-03:00",
"nProt": "943230000001750",
"xml": "<?xml version=\"1.0\" encoding=\"utf-8\"?><procEventoMDF
...</retEventoMDFe></procEventoMDFe>"
}
}
Retorno com falha:
{
"status": -6,
"motivo": "Xml específico do evento invalido de acordo com a validacao contra schema",
"erros": [
"Comp : cvc-complex-type.2.4.a: Invalid content... is expected."
]
}
Códigos de Retorno
| Código | Descrição |
|---|---|
| 200 | Alteração de Pagamento de Operação incluído com sucesso |
| -3 | Não foi possível vincular o evento ao MDF-e, consulte o Objeto de 'erros' para ver os detalhes |
| -6 | Erro de esquema, consulte o Objeto de 'erros' para ver os detalhes |