Consultar MED de Retiro
Utilice este endpoint para consultar un MED de retiro específico por su id.
Entornos Disponibles
- Producción
https://api.gateway.com.br/core
Endpoint
- Método:
GET - Endpoint:
/med/withdrawal/{id} - Autenticación: Bearer token
Path Params
| Nombre | Tipo | Obligatorio | Descripción | Validaciones |
|---|---|---|---|---|
id | string (UUID) | Sí | Identificador del MED de retiro | Debe ser un UUID válido |
Ejemplo de Solicitud
- cURL
- JavaScript
curl --request GET \
--url https://api.gateway.com.br/core/med/withdrawal/553e8400-e29b-41d4-a716-436251480000 \
--header 'Authorization: Bearer su-token-jwt'
const response = await fetch('https://api.gateway.com.br/core/med/withdrawal/553e8400-e29b-41d4-a716-436251480000', {
method: 'GET',
headers: {
'Authorization': 'Bearer su-token-jwt'
}
});
const data = await response.json();
Respuesta Exitosa
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
id | string | Sí | Identificador del MED |
acquirer | string | Sí | Adquirente del MED |
endToEnd | string | Sí | Identificador end-to-end del retiro en disputa |
notificationId | string | No | Identificador de la notificación asociada |
withdrawalId | string (UUID) | Sí | Identificador del retiro en disputa |
status | string (enum) - PENDING, APPEALED, APPROVED, REJECTED | Sí | Estado del MED |
origin | string (enum) - USER, ADMIN | Sí | Origen de la apertura: USER cuando lo abre usted, ADMIN cuando lo abre el equipo de operaciones |
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) |
receiver | object | No | Datos del receptor (ver Sub-Objeto AccountHolder) |
message | string | No | Mensaje indicado en la apertura |
user | object | Sí | Datos del usuario (ver Sub-Objeto UserVo) |
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
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 del estado |
durationInMilliseconds | number | Sí | Duración del estado en milisegundos |
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 del 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 |
Ejemplo de Respuesta
Datos enmascarados
Los valores sensibles pueden estar enmascarados con ***.
{
"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": {
"type": "PJ",
"name": "Empresa Exemplo LTDA",
"document": "12345678000199",
"bankAccount": {
"type": "CHECKING",
"digit": "0",
"ispb": "12345678"
},
"pix": {
"key": "contato@exemplo.com",
"type": "EMAIL"
}
},
"receiver": {
"type": "PF",
"name": "Fulano de Tal",
"document": "***456789**",
"bankAccount": {
"type": "CHECKING",
"digit": "7",
"ispb": "12345678"
},
"pix": {
"key": "12345678910",
"type": "CPF"
}
},
"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ódigo | Descripción | Solución |
|---|---|---|
| 401 | Credenciales inválidas | Verifique sus credenciales |
| 403 | Sin permiso/autorización | Contacte al soporte |
| 404 | Registro no encontrado | Verifique el id enviado |
| 422 | Datos inválidos o faltantes | Verifique el formato de los datos |
| 422 | Validaciones | Contacte al soporte |
| 500 | Error interno | Contacte al soporte |