List Withdrawal MEDs

Use this endpoint to list the withdrawal MEDs, with filters by period, status and data of the disputed withdrawal.

Available Environments

Production

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

Endpoint

• Method: GET
• Endpoint: /med/withdrawal
• Authentication: Bearer token

Query Params

ℹ️ Dates in ISO

The startDate and endDate fields must be sent as an ISO date string with time.

Example:

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

Name	Type	Required	Description	Validations
startDate	string	No	Start date of the filter	Must be an ISO date string with time
endDate	string	No	End date of the filter	Must be an ISO date string with time
status	string[] (enum) - PENDING, APPEALED, APPROVED, REJECTED	No	List of statuses to filter by	Must be a non-empty array with no duplicates
id	string (UUID)	No	MED identifier	Must be a valid UUID
withdrawalId	string (UUID)	No	Identifier of the disputed withdrawal	Must be a valid UUID
endToEnd	string	No	End-to-end identifier of the withdrawal	Must be between 8 and 255 characters
amount	number	No	MED amount (integer, in cents)	Must be an integer in cents; minimum 1 (R$0.01) and maximum 10000000 (R$100,000.00)
paymentMethod	string (enum) - PIX	No	Payment method	Must be a valid enum

Request Example

cURL

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

JavaScript

const params = new URLSearchParams({
  startDate: '2026-03-01T00:00:00.000Z',
  endDate: '2026-03-24T23:59:59.999Z'
});
params.append('status', 'PENDING');

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

Success Response

Field	Type	Required	Description
totalPages	number	Yes	Total pages
currentPage	number	Yes	Current page
perPage	number	Yes	Items per page
data	array	Yes	List of withdrawal MEDs

Fields of the item in data

Each item has the same shape as Get Withdrawal MED, including the AccountHolder, UserVo and StatusHistory sub-objects.

Response Example

Masked data

Sensitive values may be masked with ***.

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

Possible Errors

Code	Description	Solution
401	Invalid credentials	Check your credentials
403	No permission/authorization	Contact support
422	Invalid or missing data	Check the format of the data
422	Validations	Contact support
500	Internal error	Contact support