get
https://api.somossimpay.com.br/v3/meds/
Retrieves comprehensive details for a specific MED, including account information, bank details, QR code information, analysis data, and chargeback history.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
MED Details Endpoint
GET /v3/meds/{med_id}
Retrieves comprehensive details for a specific MED, including account information, bank details, QR code information, analysis data, and chargeback history.
Authentication
| Header | Type | Required | Example |
|---|---|---|---|
| Authorization | String | Yes | Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| med_id | String | Yes | Unique identifier of the MED to retrieve |
Response (200 OK)
{
"pix_med_id": "med-123-abc-def",
"e2e": "E1234567820240115143000123",
"amount": 1000.50,
"transaction_date": "2024-01-15T14:30:00",
"reason": "RETURN_REQUEST",
"status": "ACCEPTED_BY_PSP",
"infraction_report_id": "report-456",
"infraction_report_status": "ANALYZED",
"origin_situation_type": "SCAM_FRAUD",
"details": "Detailed description of the dispute",
"payer_name": "João Silva",
"payer_document": "12345678901",
"debited": {
"ispb": "12345678",
"bank": "Banco Example",
"agency": "1234",
"account": "567890",
"document": "12345678901",
"name": "João Silva"
},
"credited": {
"ispb": "35535240",
"bank": "Example Bank",
"agency": "0001",
"account": "123456",
"document": "98765432000123",
"name": "Company Name"
},
"qrcode_details": {
"qr_code_id": 123,
"tx_id": "tx-456",
"pix_type": "DYNAMIC",
"status": "PAID",
"key": "[email protected]",
"expiration_date": "2024-01-15T23:59:59",
"due_date": "2024-01-15T23:59:59",
"copy_and_paste": "00020126580014...",
"payment_date": "2024-01-15T14:30:00",
"created_at": "2024-01-15T10:00:00"
},
"analysis": {
"analysis_result": "ACCEPTED",
"analysis_details_user": "User analysis details",
"analysis_details_psp": "PSP confirmed fraudulent transaction",
"internal_notes": null,
"user_analyzed_by": "Ana Costa",
"psp_analyzed_by": "Carlos Silva"
},
"chargebacks": [
{
"status": "SUCCESS",
"info_text": "Chargeback successful",
"error_descriptor": null,
"amount": 1000.50,
"created_at": "2024-01-16T10:00:00",
"updated_at": "2024-01-16T10:30:00"
}
],
"created_at": "2024-01-15T14:30:00",
"updated_at": "2024-01-16T10:30:00"
}Response Fields
Main Fields
| Field | Type | Description |
|---|---|---|
| pix_med_id | String | Unique MED identifier |
| e2e | String | End-to-end transaction identifier |
| amount | Decimal | Disputed amount |
| transaction_date | Datetime | When the transaction occurred |
| reason | String | RETURN_REQUEST or RETURN_CANCELLATION |
| status | String | Current MED status |
| infraction_report_id | String | Infraction report identifier |
| infraction_report_status | String | OPEN, RECEIVED, ANALYZED, or CANCELLED |
| origin_situation_type | String | Type of fraud situation |
| details | String | Dispute description |
| payer_name | String | Name of the payer |
| payer_document | String | CPF/CNPJ of the payer |
Account Information (debited/credited)
| Field | Type | Description |
|---|---|---|
| ispb | String | Bank's ISPB code |
| bank | String | Bank name |
| agency | String | Bank agency code |
| account | String | Account number |
| document | String | Account holder document |
| name | String | Account holder name |
QR Code Details
| Field | Type | Description |
|---|---|---|
| qr_code_id | Integer | QR Code unique identifier |
| tx_id | String | Transaction ID |
| pix_type | Enum | STATIC or DYNAMIC |
| status | Enum | QR Code status |
| key | String | PIX key used |
| expiration_date | Datetime | QR Code expiration |
| due_date | Datetime | Payment due date |
| copy_and_paste | String | QR Code string |
| payment_date | Datetime | When payment was made |
| created_at | Datetime | QR Code creation date |
Analysis Information
| Field | Type | Description |
|---|---|---|
| analysis_result | Enum | ACCEPTED or REJECTED |
| analysis_details_user | String | User analysis details |
| analysis_details_psp | String | PSP analysis details |
| internal_notes | String | Internal notes (currently not used) |
| user_analyzed_by | String | Name of user who analyzed |
| psp_analyzed_by | String | Name of PSP analyst |
Chargeback History
| Field | Type | Description |
|---|---|---|
| status | Enum | PENDING, SUCCESS, or REJECTED |
| info_text | String | Additional information |
| error_descriptor | String | Error description if failed |
| amount | Decimal | Chargeback amount |
| created_at | Datetime | Chargeback creation date |
| updated_at | Datetime | Last update date |
Usage Examples
cURL
curl --request GET \
--url https://api.somossimpay.com.br/v3/meds/med-123-abc-def \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'Error Responses
404 Not Found
{
"detail": "MED not found"
}401 Unauthorized
{
"detail": "Invalid authentication credentials"
}Related Documentation
- List MEDs - List all MEDs with filtering
- MED API Overview - Complete MED API guide
400Bad request - Invalid parameters
401Unauthorized - Invalid or missing authentication
404MED not found
500Internal server error
