get
https://api.somossimpay.com.br/v3/meds/
This endpoint allows listing PIX MED cases for a specific company using cursor-based pagination. It provides filtering capabilities by date range, status, reason, and infraction report status.
Headers
| Parameter | Type | Description | Example |
|---|---|---|---|
| Authorization | String | Bearer + Access_token | Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzEzMzAwOTMxLCJpYXQiOjE3MTMyOTczMzEsImp0aSI6Ijc2ZWI4ZTE5ZjM4YjQ4NmZiODdmNzNjNTdkMWVmNDJhIiwidXNlcl9pZCI6MjQ2fQ.5zekMa7CUj9p-MvNHns5ke4ZPhYV3Y1CLOsYL7hDUUo |
Params (Query Params)
| Parameter | Type | Description | Example |
|---|---|---|---|
| limit | integer | Optional. Number of records per page (Min: 1, Max: 100, Default: 5) | limit=20 |
| id | string | Optional. Cursor ID for pagination navigation | id=med-123-abc |
| dt | string | Optional. Cursor datetime for pagination navigation (ISO 8601 format) | dt=2024-01-15T14:30:00 |
| direction | string | Optional. Pagination direction: next or previous (Default: next) | direction=next |
Filter Parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
| filter_start_date | date | Optional. Start date for filtering MEDs (YYYY-MM-DD format) | filter_start_date=2024-01-01 |
| filter_end_date | date | Optional. End date for filtering MEDs (YYYY-MM-DD format) | filter_end_date=2024-01-31 |
| status | enum | Optional. Filter by MED status | status=WAITING |
| reason | enum | Optional. Filter by MED reason | reason=RETURN_REQUEST |
| infraction_report_status | enum | Optional. Filter by infraction report status | infraction_report_status=OPEN |
Filter Enums
MED Status (status)
| Value | Description |
|---|---|
| WAITING | Awaiting analysis |
| CANCELLED_BY_USER | Cancelled by the user |
| CANCELLED_BY_PSP | Cancelled by the PSP (Payment Service Provider) |
| ACCEPTED_BY_USER | Accepted by the user |
| ACCEPTED_BY_PSP | Accepted by the PSP |
| REJECTED_BY_USER | Rejected by the user |
| REJECTED_BY_PSP | Rejected by the PSP |
MED Reason (reason)
| Value | Description |
|---|---|
| RETURN_REQUEST | Request for transaction return |
| RETURN_CANCELLATION | Cancellation of return request |
Infraction Report Status (infraction_report_status)
| Value | Description |
|---|---|
| OPEN | Report is open for analysis |
| RECEIVED | Report has been received |
| CANCELLED | Report has been cancelled |
| ANALYZED | Report has been analyzed |
Important Filter Rules
- Date Range Validation: If you provide filter_start_date, you must also provide filter_end_date, and vice versa. Both parameters are required together.
- Date Format: Use ISO date format (YYYY-MM-DD) for date parameters.
- Timezone Handling: The system converts dates to UTC with a +3 hours offset for Brazilian timezone.
Response Details
{
"worked": true,
"next": "string|null",
"previous": "string|null",
"results": [
{
"pix_med_id": "med-123-abc-def",
"origin_situation_type": "SCAM_FRAUD",
"status": "WAITING",
"amount": 1000.50,
"user_document": "12345678901",
"email": "[email protected]",
"phone": "+5511999999999",
"analysis_result": null,
"creator_psp": "12345678",
"user_name": "João Silva",
"receiver_document": "98765432000123",
"receiver_name": "E2",
"receiver_agency": "0001",
"receiver_account": "123456",
"infraction_report_id": "report-456",
"endtoend": "E1234567820240115143000123",
"due_date": "2024-01-30T23:59:59",
"infraction_report_creation_datetime": "2024-01-15T14:30:00",
"created_at": "2024-01-15T14:30:00"
}
]
}
Response Fields
Main Response
| Field | Type | Description | |
|---|---|---|---|
| worked | boolean | Indicates if the request was processed successfully | |
| next | string\ | null | URL for the next page (null if no more pages) |
| previous | string\ | null | URL for the previous page (null if first page) |
| results | array | List of MED records |
MED Record Fields
| Field | Type | Description | |
|---|---|---|---|
| pix_med_id | string | Unique MED identifier | |
| origin_situation_type | enum | Type of situation that originated the MED | |
| status | enum | Current status of the MED | |
| amount | decimal | Transaction amount involved in the dispute | |
| user_document | string\ | null | Payer's document (CPF/CNPJ) |
| string | Contact email for the dispute | ||
| phone | string | Contact phone for the dispute | |
| analysis_result | enum\ | null | Result of analysis (if completed) |
| creator_psp | string | PSP that created the MED | |
| user_name | string\ | null | Payer's name |
| receiver_document | string\ | null | Receiver's document |
| receiver_name | string\ | null | Receiver's name (typically "E2") |
| receiver_agency | string\ | null | Receiver's bank agency |
| receiver_account | string\ | null | Receiver's bank account |
| infraction_report_id | string\ | null | Associated infraction report ID |
| endtoend | string | PIX end-to-end transaction identifier | |
| due_date | datetime\ | null | Due date for MED resolution |
| infraction_report_creation_datetime | datetime\ | null | When the infraction report was created |
| created_at | datetime | When the MED record was created |
Origin Situation Types
| Value | Description |
|---|---|
| SCAM_FRAUD | Scam or fraud situation |
| UNAUTHORIZED_TRANSACTION | Unauthorized transaction |
| COERCIVE_CRIME | Transaction under coercion |
| FRAUDULENT_ACCESS_AND_AUTHORIZATION | Fraudulent access and authorization |
| OTHER | Other type of situation |
| UNKNOWN | Unknown situation type |
Analysis Results
| Value | Description |
|---|---|
| ACCEPTED | MED analysis accepted the dispute |
| REJECTED | MED analysis rejected the dispute |