Listar MED

Utilice este endpoint para listar MED con filtros.

Entornos Disponibles

Producción

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

Endpoint

• Método: GET
• Endpoint: /med
• Autenticación: Bearer token

Query Params

ℹ️ Fechas en ISO

Los campos startDate y endDate deben enviarse como ISO date string con hora.

Ejemplo:

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

ℹ️ Arreglos en el query string

El campo status acepta múltiples valores.

Ejemplo:

• status=PENDING&status=APPEALED

ℹ️ Paginación por snapshot

El snapshot no es un puntero a la "página siguiente": es un identificador fijo de la sesión de paginación, usado junto con page (que sigue siendo enviado e incrementado normalmente) para mantener los resultados consistentes incluso si se crean nuevos registros durante la navegación.

Tome el valor de snapshot de la primera respuesta (enviada sin snapshot en la primera solicitud) y reenvíe ese mismo valor, sin modificarlo, en las solicitudes de las páginas siguientes, junto con los mismos filtros y el mismo perPage usados originalmente. Si alguno de esos valores cambia mientras se reenvía un snapshot antiguo, la API devuelve un error.

Nombre	Tipo	Obligatorio	Descripción	Validaciones
snapshot	string	No	Identificador de la sesión de paginación (recibido en el campo snapshot de la primera respuesta); reenvíelo sin modificar junto con page en las páginas siguientes	Debe corresponder a los mismos filtros y al mismo perPage de la solicitud original
startDate	string	No	Fecha inicial del filtro	Debe ser una ISO date string con hora
endDate	string	No	Fecha final del filtro	Debe ser una ISO date string con hora
status	string[] (enum) - PENDING, APPEALED, APPROVED, REJECTED	No	Lista de estados para filtrar	Debe ser un arreglo no vacío, único y sin duplicados
id	string (UUID v4)	No	Identificador del MED	Debe ser un UUID v4 válido
transactionId	string (UUID v4)	No	Identificador de la transacción	Debe ser un UUID v4 válido
endToEnd	string	No	Identificador end-to-end	Debe tener entre 8 y 255 caracteres
amount	number	No	Monto del MED (entero, en centavos)	Entero entre 1 y 10000000
paymentMethod	string (enum) - PIX	No	Método de pago	Debe ser un valor válido de método de pago

Ejemplo de Solicitud (con todos los 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 su-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 su-token-jwt'
  }
});

const data = await response.json();

Respuesta Exitosa

Campo	Tipo	Obligatorio	Descripción
totalPages	number	Sí	Total de páginas
currentPage	number	Sí	Página actual
perPage	number	Sí	Elementos por página
snapshot	string	No	Identificador de la sesión de paginación; reenvíelo sin modificar en las páginas siguientes
data	array	Sí	Lista de MED

Campos del elemento en data

Campo	Tipo	Obligatorio	Descripción
id	string	Sí	Identificador del MED
acquirer	string	Sí	Adquirente del MED
transactionId	string	Sí	Identificador de la transacción
endToEnd	string	Sí	Identificador end-to-end
notificationId	string	No	Identificador de la notificación asociada
status	string (enum) - PENDING, APPEALED, APPROVED, REJECTED	Sí	Estado del MED
origin	string (enum) - ACQUIRER, ADMIN	Sí	Origen del MED
reason	string (enum) - SCAM, FRAUDULENT_ACCESS, OPERATIONAL_ERROR, OTHER	Sí	Motivo del MED
amount	number	Sí	Monto del MED (entero, en centavos)
paymentMethod	string (enum) - PIX	Sí	Método de pago
payer	object	No	Datos del pagador (ver Sub-Objeto AccountHolder)
customerMessage	string	No	Mensaje del cliente
user	object	Sí	Datos del usuario (UserVo)
decisionMessage	string	No	Mensaje de decisión
refundStatus	string (enum) - FULL_REFUND, PARTIAL_REFUND, INSUFFICIENT_FUNDS	No	Estado del reembolso
appealContent	object	No	Contenido de la defensa (AppealContent)
refundAmount	number	No	Monto del reembolso (entero, en centavos)
statusHistory	array	Sí	Historial de estados (ver Sub-Objeto StatusHistory)
medDate	string (ISO)	Sí	Fecha del MED
createdAt	string (ISO)	Sí	Fecha de creación
updatedAt	string (ISO)	Sí	Fecha de la última actualización

Sub-Objetos

UserVo

Campo	Tipo	Obligatorio	Descripción
name	string	Sí	Nombre del usuario
email	string	Sí	Correo electrónico del usuario
createdAt	string (ISO)	Sí	Fecha de creación del usuario

AccountHolder

Campo	Tipo	Obligatorio	Descripción
type	string (enum) - PF, PJ	Sí	Tipo de titular
name	string	Sí	Nombre del titular
document	string	Sí	Documento del titular
bankAccount	object	Sí	Datos bancarios (ver Sub-Objeto BankAccount)
pix	object	Sí	Clave PIX del titular (ver Sub-Objeto PixKeyVo)

BankAccount

Campo	Tipo	Obligatorio	Descripción
type	string	Sí	Tipo de cuenta
digit	string	Sí	Dígito de la cuenta
ispb	string	Sí	ISPB del banco

PixKeyVo

Campo	Tipo	Obligatorio	Descripción
key	string	Sí	Clave PIX
type	string (enum) - CPF, CNPJ, EMAIL, PHONE, EVP	Sí	Tipo de la clave PIX

StatusHistory (elemento)

Campo	Tipo	Obligatorio	Descripción
status	string (enum) - PENDING, APPEALED, APPROVED, REJECTED	Sí	Estado del MED en el historial
date	string (ISO)	Sí	Fecha y hora del cambio de estado
durationInMilliseconds	number	No	Duración del estado en milisegundos

AppealContent

Campo	Tipo	Obligatorio	Descripción
message	string	No	Mensaje de la defensa
evidences	array	No	Evidencias de la defensa (ver Sub-Objeto FileVo)

FileVo (elemento de evidences)

Campo	Tipo	Obligatorio	Descripción
key	string	Sí	Clave del archivo
isPrivate	boolean	Sí	Indica si el archivo es privado
expirationDate	string (ISO)	No	Fecha de expiración del archivo
url	string	No	URL firmada del archivo

Ejemplo de Respuesta

{
  "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"
    }
  ]
}

Errores Posibles

Código	Descripción	Solución
401	Credenciales inválidas	Verifique sus credenciales
403	Sin permiso/autorización	Contacte al soporte
422	Datos inválidos o faltantes	Verifique el formato de los datos
500	Error interno	Contacte al soporte