Skip to content

List MED

List PIX MED records.

Endpoint

GET /meds/list

Authentication

Merchant Credential. See Authentication.

Request headers

NameInTypeRequiredDescriptionExample
X-NonceheaderstringYesa9f3c1d47e8b9a2c4d1f9e8a7b6c5d4e
X-Merchant-IdheaderstringYes2492265300
X-TimestampheaderstringYes1638123456
DigestheaderstringYesSHA-256=Jr9cX0nM6yT7uF9GQ5G8ZC5M8vRZrQZP9+VbQ8Z8z0Q=
AuthorizationheaderstringYesSignature keyId="m123456",alg="ES256",headers="(request-target) x-timestamp x-nonce digest",signature="MEUCIQD8VxkzR7q5hF3k9dY0v6mKk7K0Nq9nYw+7Ck8LJr9mYAIgC5VQ7J0Z9YqL5F8Wc6E2Yw5qf1z8bYyYcR9kX8pY="

Query parameters

NameInTypeRequiredDescriptionExample
limitqueryintegerNoPage limit20
cursorTimequeryintegerYesCursor start position per page1670374577
startDatequerystringNo2024-01-01
endDatequerystringNo2024-01-11
statusquerystringYesStatusWAITING
reasonquerystringNoReasonRETURN_REQUEST

Response

HTTP 200 — Success

FieldTypeRequiredDescription
statusintegerYes
msgstringYes
dataarrayYes

Response example

json
{
  "status": 200,
  "msg": "string|null",
  "data": [
    {
      "pixMedId": "med-123-abc-def",
      "originSituationType": "SCAM_FRAUD",
      "status": "WAITING",
      "amount": 1000.5,
      "userDocument": "12345678901",
      "email": "user@example.com",
      "phone": "+5511999999999",
      "analysisResult": null,
      "creatorPsp": "12345678",
      "userName": "João Silva",
      "receiverDocument": "98765432000123",
      "receiverName": "SAQ",
      "receiverAgency": "0001",
      "receiverAccount": "123456",
      "infractionReportId": "report-456",
      "endtoend": "E1234567820240115143000123",
      "due_date": "2024-01-30T23:59:59",
      "infractionReportCreationDatetime": "2024-01-15T14:30:00",
      "createdAt": "2024-01-15T14:30:00"
    }
  ]
}