Listar MEDs

Utilize este endpoint para listar MEDs com filtros.

Ambientes Disponíveis

Produção

https://api.gateway.com.br/core

Endpoint

• Método: GET
• Endpoint: /med
• Autenticação: Bearer token

Query Params

ℹ️ Datas em ISO

Os campos startDate e endDate devem ser enviados em ISO date string com horário.

Exemplo:

• 2026-03-24T12:00:00.000Z

ℹ️ Arrays em query string

O campo status aceita múltiplos valores.

Exemplo:

• status=PENDING&status=APPEALED

ℹ️ Paginação por snapshot

O snapshot não é um ponteiro para a "próxima página": é um identificador fixo da sessão de paginação, usado junto com page (que continua sendo enviado e incrementado normalmente) para manter os resultados consistentes mesmo se novos registros forem criados durante a navegação.

Pegue o valor de snapshot na primeira resposta (sem enviar snapshot no primeiro request) e reenvie esse mesmo valor, sem alterá-lo, nas requisições das páginas seguintes, junto com os mesmos filtros e o mesmo perPage usados originalmente. Se algum desses valores mudar enquanto um snapshot antigo é reenviado, a API retorna erro.

Nome	Tipo	Obrigatório	Descrição	Validações
snapshot	string	Não	Identificador da sessão de paginação (recebido no campo snapshot da primeira resposta); reenvie sem alterar junto com page nas páginas seguintes	Deve corresponder aos mesmos filtros e ao mesmo perPage da requisição original
startDate	string	Não	Data inicial do filtro	Deve ser ISO date string com horário
endDate	string	Não	Data final do filtro	Deve ser ISO date string com horário
status	string[] (enum) - PENDING, APPEALED, APPROVED, REJECTED	Não	Lista de status para filtrar	Deve ser array não vazio, único e sem duplicados
id	string (UUID v4)	Não	Identificador do MED	Deve ser UUID v4 válido
transactionId	string (UUID v4)	Não	Identificador da transação	Deve ser UUID v4 válido
endToEnd	string	Não	Identificador end-to-end	Deve ter entre 8 e 255 caracteres
amount	number	Não	Valor do MED (inteiro em centavos)	Inteiro entre 1 e 10000000
paymentMethod	string (enum) - PIX	Não	Método de pagamento	Deve ser um valor válido de método de pagamento

Exemplo de Requisição (com todos os campos)

cURL

curl --request GET \
--url "https://api.gateway.com.br/core/med?startDate=2026-03-01T00:00:00.000Z&endDate=2026-03-24T23:59:59.999Z&status=PENDING&status=APPEALED&id=553e8400-e29b-41d4-a716-436251480000&transactionId=553e8400-e29b-41d4-a716-446655440000&endToEnd=E2E12345678&amount=1000&paymentMethod=PIX" \
--header 'Authorization: Bearer seu-token-jwt'

JavaScript

const params = new URLSearchParams({
  startDate: '2026-03-01T00:00:00.000Z',
  endDate: '2026-03-24T23:59:59.999Z',
  id: '553e8400-e29b-41d4-a716-436251480000',
  transactionId: '553e8400-e29b-41d4-a716-446655440000',
  endToEnd: 'E2E12345678',
  amount: '1000',
  paymentMethod: 'PIX'
});

params.append('status', 'PENDING');
params.append('status', 'APPEALED');

const response = await fetch(`https://api.gateway.com.br/core/med?${params}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer seu-token-jwt'
  }
});

const data = await response.json();

Resposta de Sucesso

Campo	Tipo	Obrigatório	Descrição
totalPages	number	Sim	Total de páginas
currentPage	number	Sim	Página atual
perPage	number	Sim	Itens por página
snapshot	string	Não	Identificador da sessão de paginação; reenvie sem alterações nas páginas seguintes
data	array	Sim	Lista de MEDs

Campos do item em data

Campo	Tipo	Obrigatório	Descrição
id	string	Sim	Identificador do MED
acquirer	string	Sim	Adquirente do MED
transactionId	string	Sim	Identificador da transação
endToEnd	string	Sim	Identificador end-to-end
notificationId	string	Não	Identificador da notificação associada
status	string (enum) - PENDING, APPEALED, APPROVED, REJECTED	Sim	Status do MED
origin	string (enum) - ACQUIRER, ADMIN	Sim	Origem do MED
reason	string (enum) - SCAM, FRAUDULENT_ACCESS, OPERATIONAL_ERROR, OTHER	Sim	Motivo do MED
amount	number	Sim	Valor do MED (inteiro em centavos)
paymentMethod	string (enum) - PIX	Sim	Método de pagamento
payer	object	Não	Dados do pagador (ver Sub-Objeto AccountHolder)
customerMessage	string	Não	Mensagem do cliente
user	object	Sim	Dados do usuário (UserVo)
decisionMessage	string	Não	Mensagem de decisão
refundStatus	string (enum) - FULL_REFUND, PARTIAL_REFUND, INSUFFICIENT_FUNDS	Não	Status de estorno
appealContent	object	Não	Conteúdo da defesa (AppealContent)
refundAmount	number	Não	Valor de estorno (inteiro em centavos)
statusHistory	array	Sim	Histórico de status (ver Sub-Objeto StatusHistory)
medDate	string (ISO)	Sim	Data do MED
createdAt	string (ISO)	Sim	Data de criação
updatedAt	string (ISO)	Sim	Data da última atualização

Sub-Objetos

UserVo

Campo	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do usuário
email	string	Sim	E-mail do usuário
createdAt	string (ISO)	Sim	Data de criação do usuário

AccountHolder

Campo	Tipo	Obrigatório	Descrição
type	string (enum) - PF, PJ	Sim	Tipo do titular
name	string	Sim	Nome do titular
document	string	Sim	Documento do titular
bankAccount	object	Sim	Dados bancários (ver Sub-Objeto BankAccount)
pix	object	Sim	Chave PIX do titular (ver Sub-Objeto PixKeyVo)

BankAccount

Campo	Tipo	Obrigatório	Descrição
type	string	Sim	Tipo de conta
digit	string	Sim	Dígito da conta
ispb	string	Sim	ISPB do banco

PixKeyVo

Campo	Tipo	Obrigatório	Descrição
key	string	Sim	Chave PIX
type	string (enum) - CPF, CNPJ, EMAIL, PHONE, EVP	Sim	Tipo da chave PIX

StatusHistory (item)

Campo	Tipo	Obrigatório	Descrição
status	string (enum) - PENDING, APPEALED, APPROVED, REJECTED	Sim	Status do MED no histórico
date	string (ISO)	Sim	Data/hora da mudança de status
durationInMilliseconds	number	Não	Duração do status em milissegundos

AppealContent

Campo	Tipo	Obrigatório	Descrição
message	string	Não	Mensagem da defesa
evidences	array	Não	Evidências da defesa (ver Sub-Objeto FileVo)

FileVo (item de evidences)

Campo	Tipo	Obrigatório	Descrição
key	string	Sim	Chave do arquivo
isPrivate	boolean	Sim	Indica se o arquivo é privado
expirationDate	string (ISO)	Não	Data de expiração do arquivo
url	string	Não	URL assinada do arquivo

Exemplo de Resposta

{
  "totalPages": 1,
  "currentPage": 1,
  "perPage": 15,
  "snapshot": "b3BhcXVlLXNuYXBzaG90LXRva2Vu",
  "data": [
    {
      "id": "553e8400-e29b-41d4-a716-436251480000",
      "acquirer": "ACQUIRER_EXEMPLO",
      "transactionId": "553e8400-e29b-41d4-a716-446655440000",
      "endToEnd": "E2E12345678",
      "notificationId": null,
      "status": "PENDING",
      "origin": "ACQUIRER",
      "reason": "SCAM",
      "amount": 1000,
      "paymentMethod": "PIX",
      "payer": {
        "type": "PF",
        "name": "Fulano de Tal",
        "document": "***456789**",
        "bankAccount": {
          "type": "CHECKING",
          "digit": "7",
          "ispb": "12345678"
        },
        "pix": {
          "key": "12345678910",
          "type": "CPF"
        }
      },
      "customerMessage": "Cliente informou não reconhecer a cobrança.",
      "user": {
        "name": "Loja Exemplo",
        "email": "contato@lojaexemplo.com",
        "createdAt": "2026-03-01T09:00:00.000Z"
      },
      "decisionMessage": "Decisão administrativa em análise.",
      "refundStatus": "PARTIAL_REFUND",
      "appealContent": {
        "message": "Enviamos comprovante da entrega e da autenticação do pedido.",
        "evidences": [
          {
            "key": "med/evidence-1.pdf",
            "isPrivate": true,
            "expirationDate": "2026-03-25T10:00:00.000Z",
            "url": null
          }
        ]
      },
      "refundAmount": 500,
      "statusHistory": [
        {
          "status": "PENDING",
          "date": "2026-03-24T10:00:00.000Z",
          "durationInMilliseconds": 3600000
        },
        {
          "status": "APPEALED",
          "date": "2026-03-24T11:00:00.000Z",
          "durationInMilliseconds": null
        }
      ],
      "medDate": "2026-03-24T10:00:00.000Z",
      "createdAt": "2026-03-24T10:00:00.000Z",
      "updatedAt": "2026-03-24T11:00:00.000Z"
    }
  ]
}

Possíveis Erros

Código	Descrição	Solução
401	Credenciais inválidas	Verifique suas credenciais
403	Sem permissão/autorização	Contate o suporte
422	Dados inválidos ou faltando	Verifique o formato dos dados
500	Erro interno	Contate o suporte