Sistema Gerencial MobTEF

Documentação API

Visão Geral

Esta documentação descreve como realizar uma requisição HTTP PUT para cancelar total ou parcialmente uma operação TEF.

URLs Disponíveis

Homologação: https://mobtef-homolog.conexaoapi.com.br/mpm/tef/cancelar
Produção: https://mobtef.conexaoapi.com.br/mpm/tef/cancelar

Método HTTP

PUT

Cabeçalhos (Headers)

Campo	Tipo	Obrigatório	Descrição	Exemplo
empresa_id	inteiro	Sim	Identificador da empresa	2
token	string	Sim	Token de autenticação	0202024
usuario_id	inteiro	Sim	ID do usuário autenticado	1
dispositivo_id	inteiro	Sim	ID do dispositivo utilizado	1
dispositivo_model	string	Sim	Modelo do dispositivo	1
dispositivo_tipo	string	Sim	Tipo do dispositivo	1
app_versao	string	Sim	Versão do aplicativo	1.0
app_nome	string	Sim	Nome do aplicativo	MEGAPDV
plataforma	string	Sim	Plataforma do aplicativo	WINDOWS
tef_id	inteiro	Sim	Identificador da operação TEF	163
Content-Type	string	Sim	Formato do corpo da requisição	application/json

Corpo da Requisição

Cancelamento Parcial

Utilizado quando deseja cancelar somente parte da transação.

{
  "status": 51,
  "motivo": "motivo do cancelamento",
  "pagamento_id": 2,
  "fechar_pedido": true
}

pagamento_id: Especifica qual pagamento da transação será cancelado.
fechar_pedido: Se true, encerra a transação atual com valor reduzido. Se false, permite nova transação para compensar o valor cancelado.

Cancelamento Completo

Utilizado para cancelar integralmente a transação.

{
  "status": 51,
  "motivo": "motivo do cancelamento"
}

Exemplo de requisição CURL

curl --location --request PUT 'https://mobtef-homolog.conexaoapi.com.br/mpm/tef/cancelar' \
--header 'empresa_id: 2' \
--header 'token: 0202024' \
--header 'usuario_id: 1' \
--header 'dispositivo_id: 1' \
--header 'dispositivo_model: 1' \
--header 'dispositivo_tipo: 1' \
--header 'app_versao: 1.0' \
--header 'app_nome: MEGAPDV' \
--header 'plataforma: WINDOWS' \
--header 'tef_id: 163' \
--header 'Content-Type: application/json' \
--data '{
    "status": 51,
    "motivo": "motivo do cancelamento",
    "pagamento_id": 2,
    "fechar_pedido": true
}'

Exemplo de Resposta

{
    "status": "success",
    "message": "Pedido 247 atualizado",
    "data": []
}

Nota: Verifique sempre as URLs para ambientes diferentes (homologação e produção) e mantenha o token seguro.