Skip to main content

Get MED

Use this endpoint to get the details of a specific MED by its id.

Available Environments​

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

Endpoint​

  • Method: GET
  • Endpoint: /med/{id}
  • Authentication: Bearer token

Path Params​

NameTypeRequiredDescriptionValidations
idstring (UUID v4)YesMED identifierMust be a valid UUID v4

Request Example​

curl --request GET \
--url https://api.gateway.com.br/core/med/553e8400-e29b-41d4-a716-436251480000 \
--header 'Authorization: Bearer your-jwt-token'

Success Response​

FieldTypeRequiredDescription
idstringYesMED identifier
acquirerstringYesAcquirer of the MED
transactionIdstringYesTransaction identifier
endToEndstringYesEnd-to-end identifier
notificationIdstringNoIdentifier of the associated notification
statusstring (enum) - PENDING, APPEALED, APPROVED, REJECTEDYesMED status
originstring (enum) - ACQUIRER, ADMINYesOrigin of the MED
reasonstring (enum) - SCAM, FRAUDULENT_ACCESS, OPERATIONAL_ERROR, OTHERYesReason of the MED
amountnumberYesMED amount (integer, in cents)
paymentMethodstring (enum) - PIXYesPayment method
payerobjectNoPayer data (see Sub-Object AccountHolder)
customerMessagestringNoCustomer message
userobjectYesUser data (UserVo)
decisionMessagestringNoDecision message
refundStatusstring (enum) - FULL_REFUND, PARTIAL_REFUND, INSUFFICIENT_FUNDSNoRefund status
appealContentobjectNoContent of the defense (AppealContent)
refundAmountnumberNoRefund amount (integer, in cents)
statusHistoryarrayYesStatus history (see Sub-Object StatusHistory)
medDatestring (ISO)YesDate of the MED
createdAtstring (ISO)YesCreation date
updatedAtstring (ISO)YesLast update date

Sub-Objects​

UserVo​

FieldTypeRequiredDescription
namestringYesUser name
emailstringYesUser e-mail
createdAtstring (ISO)YesCreation date of the user

AccountHolder​

FieldTypeRequiredDescription
typestring (enum) - PF, PJYesHolder type
namestringYesHolder name
documentstringYesHolder document
bankAccountobjectYesBank data (see Sub-Object BankAccount)
pixobjectYesPIX key of the holder (see Sub-Object PixKeyVo)

BankAccount​

FieldTypeRequiredDescription
typestringYesAccount type
digitstringYesAccount check digit
ispbstringYesISPB of the bank

PixKeyVo​

FieldTypeRequiredDescription
keystringYesPIX key
typestring (enum) - CPF, CNPJ, EMAIL, PHONE, EVPYesPIX key type

StatusHistory (item)​

FieldTypeRequiredDescription
statusstring (enum) - PENDING, APPEALED, APPROVED, REJECTEDYesMED status in the history
datestring (ISO)YesDate and time of the status change
durationInMillisecondsnumberNoDuration of the status in milliseconds

AppealContent​

FieldTypeRequiredDescription
messagestringNoDefense message
evidencesarrayNoEvidence of the defense (see Sub-Object FileVo)

FileVo (item of evidences)​

FieldTypeRequiredDescription
keystringYesFile key
isPrivatebooleanYesWhether the file is private
expirationDatestring (ISO)NoFile expiration date
urlstringNoSigned URL of the file

Response Example​

{
"id": "553e8400-e29b-41d4-a716-436251480000",
"acquirer": "ACQUIRER_EXEMPLO",
"transactionId": "553e8400-e29b-41d4-a716-446655440000",
"endToEnd": "E2E12345678",
"notificationId": null,
"status": "APPEALED",
"origin": "ACQUIRER",
"reason": "FRAUDULENT_ACCESS",
"amount": 1000,
"paymentMethod": "PIX",
"payer": {
"type": "PF",
"name": "Fulano de Tal",
"document": "***456789**",
"bankAccount": {
"type": "CHECKING",
"digit": "7",
"ispb": "12345678"
},
"pix": {
"key": "12345678910",
"type": "CPF"
}
},
"customerMessage": "Cliente informou não reconhecer a cobrança.",
"user": {
"name": "Loja Exemplo",
"email": "contato@lojaexemplo.com",
"createdAt": "2026-03-01T09:00:00.000Z"
},
"decisionMessage": "Defesa recebida e em análise.",
"refundStatus": "FULL_REFUND",
"appealContent": {
"message": "Anexamos comprovante de entrega.",
"evidences": [
{
"key": "med/evidence-1.pdf",
"isPrivate": true,
"expirationDate": "2026-03-25T10:00:00.000Z",
"url": null
}
]
},
"refundAmount": 1000,
"statusHistory": [
{
"status": "PENDING",
"date": "2026-03-24T10:00:00.000Z",
"durationInMilliseconds": 3600000
},
{
"status": "APPEALED",
"date": "2026-03-24T11:00:00.000Z",
"durationInMilliseconds": 1800000
},
{
"status": "APPROVED",
"date": "2026-03-24T11:30:00.000Z",
"durationInMilliseconds": null
}
],
"medDate": "2026-03-24T10:00:00.000Z",
"createdAt": "2026-03-24T10:00:00.000Z",
"updatedAt": "2026-03-24T11:30:00.000Z"
}

Possible Errors​

CodeDescriptionSolution
401Invalid credentialsCheck your credentials
403No permission/authorizationContact support
404MED not foundCheck the id you sent
500Internal errorContact support