Saltar al contenido principal

Listar MED de Retiro

Utilice este endpoint para listar los MED de retiro, con filtros por período, estado y datos del retiro en disputa.

Entornos Disponibles​

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

Endpoint​

  • Método: GET
  • Endpoint: /med/withdrawal
  • 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-06T12:00:00.000Z
NombreTipoObligatorioDescripciónValidaciones
startDatestringNoFecha inicial del filtroDebe ser una ISO date string con hora
endDatestringNoFecha final del filtroDebe ser una ISO date string con hora
statusstring[] (enum) - PENDING, APPEALED, APPROVED, REJECTEDNoLista de estados para filtrarDebe ser un arreglo no vacío y sin duplicados
idstring (UUID)NoIdentificador del MEDDebe ser un UUID válido
withdrawalIdstring (UUID)NoIdentificador del retiro en disputaDebe ser un UUID válido
endToEndstringNoIdentificador end-to-end del retiroDebe tener entre 8 y 255 caracteres
amountnumberNoMonto del MED (entero, en centavos)Debe ser entero en centavos; mínimo 1 (BRL 0.01) y máximo 10000000 (BRL 100,000.00)
paymentMethodstring (enum) - PIXNoMétodo de pagoDebe ser un enum válido

Ejemplo de Solicitud​

curl --request GET \
--url "https://api.gateway.com.br/core/med/withdrawal?startDate=2026-03-01T00:00:00.000Z&endDate=2026-03-24T23:59:59.999Z&status=PENDING" \
--header 'Authorization: Bearer su-token-jwt'

Respuesta Exitosa​

CampoTipoObligatorioDescripción
totalPagesnumberSíTotal de páginas
currentPagenumberSíPágina actual
perPagenumberSíElementos por página
dataarraySíLista de MED de retiro

Campos del elemento en data​

Cada elemento tiene el mismo formato que Consultar MED de Retiro, incluidos los sub-objetos AccountHolder, UserVo y StatusHistory.

Ejemplo de Respuesta​

Datos enmascarados

Los valores sensibles pueden estar enmascarados con ***.

{
"totalPages": 1,
"currentPage": 1,
"perPage": 20,
"data": [
{
"id": "553e8400-e29b-41d4-a716-436251480000",
"acquirer": "ACQUIRER_EXEMPLO",
"endToEnd": "E12345678202603061249abcdef0123",
"notificationId": null,
"withdrawalId": "553e8400-e29b-41d4-a716-436251480001",
"status": "PENDING",
"origin": "USER",
"reason": "OPERATIONAL_ERROR",
"amount": 10000,
"paymentMethod": "PIX",
"payer": null,
"receiver": null,
"message": "Saque enviado para a chave errada",
"user": {
"name": "Usuário Exemplo",
"email": "usuario@exemplo.com",
"createdAt": "2026-01-15T10:00:00.000Z"
},
"statusHistory": [
{
"status": "PENDING",
"date": "2026-03-06T12:49:04.681Z",
"durationInMilliseconds": 1000
}
],
"medDate": "2026-03-06T12:49:04.681Z",
"createdAt": "2026-03-06T12:49:04.681Z",
"updatedAt": "2026-03-06T12:49:04.681Z"
}
]
}

Errores Posibles​

CódigoDescripciónSolución
401Credenciales inválidasVerifique sus credenciales
403Sin permiso/autorizaciónContacte al soporte
422Datos inválidos o faltantesVerifique el formato de los datos
422ValidacionesContacte al soporte
500Error internoContacte al soporte