Pular para o conteúdo principal

Listar MEDs de Saque

Utilize este endpoint para listar os MEDs de saque, com filtros por período, status e dados do saque contestado.

Ambientes Disponíveis​

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

Endpoint​

  • Método: GET
  • Endpoint: /med/withdrawal
  • 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-06T12:00:00.000Z
NomeTipoObrigatórioDescriçãoValidações
startDatestringNãoData inicial do filtroDeve ser ISO date string com horário
endDatestringNãoData final do filtroDeve ser ISO date string com horário
statusstring[] (enum) - PENDING, APPEALED, APPROVED, REJECTEDNãoLista de status para filtrarDeve ser um array não vazio e sem duplicados
idstring (UUID)NãoIdentificador do MEDDeve ser UUID válido
withdrawalIdstring (UUID)NãoIdentificador do saque contestadoDeve ser UUID válido
userIdstring (UUID v4)NãoIdentificador do usuário dono do saqueDeve ser UUID v4 válido
endToEndstringNãoIdentificador end-to-end do saqueDeve ter entre 8 e 255 caracteres
amountnumberNãoValor do MED (inteiro em centavos)Deve ser inteiro em centavos; mínimo 1 (R$ 0,01) e máximo 10000000 (R$ 100.000,00)
paymentMethodstring (enum) - PIXNãoMétodo de pagamentoDeve ser um enum válido

Exemplo de Requisição​

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 seu-token-jwt'

Resposta de Sucesso​

CampoTipoObrigatórioDescrição
totalPagesnumberSimTotal de páginas
currentPagenumberSimPágina atual
perPagenumberSimItens por página
dataarraySimLista de MEDs de saque

Campos do item em data​

Cada item tem o mesmo formato de Buscar MED de Saque, incluindo os sub-objetos AccountHolder, UserVo e StatusHistory.

Exemplo de Resposta​

Dados mascarados

Valores sensíveis podem estar mascarados com ***.

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

Possíveis Erros​

CódigoDescriçãoSolução
401Credenciais inválidasVerifique suas credenciais
403Sem permissão/autorizaçãoContate o suporte
422Dados inválidos ou faltandoVerifique o formato dos dados
422ValidaçõesContate o suporte
500Erro internoContate o suporte