Skip to main content

Get Withdrawal MED

Use this endpoint to get a specific withdrawal MED by its id.

Available Environments​

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

Endpoint​

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

Path Params​

NameTypeRequiredDescriptionValidations
idstring (UUID)YesIdentifier of the withdrawal MEDMust be a valid UUID

Request Example​

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

Success Response​

FieldTypeRequiredDescription
idstringYesMED identifier
acquirerstringYesAcquirer of the MED
endToEndstringYesEnd-to-end identifier of the disputed withdrawal
notificationIdstringNoIdentifier of the associated notification
withdrawalIdstring (UUID)YesIdentifier of the disputed withdrawal
statusstring (enum) - PENDING, APPEALED, APPROVED, REJECTEDYesMED status
originstring (enum) - USER, ADMINYesOrigin of the opening: USER when opened by you, ADMIN when opened by the operations team
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)
receiverobjectNoReceiver data (see Sub-Object AccountHolder)
messagestringNoMessage sent when it was opened
userobjectYesUser data (see Sub-Object UserVo)
statusHistoryarrayYesStatus history (see Sub-Object StatusHistory)
medDatestring (ISO)YesDate of the MED
createdAtstring (ISO)YesCreation date
updatedAtstring (ISO)YesLast update date

Sub-Objects​

StatusHistory (item)​

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

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

Response Example​

Masked data

Sensitive values may be masked with ***.

{
"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": {
"type": "PJ",
"name": "Empresa Exemplo LTDA",
"document": "12345678000199",
"bankAccount": {
"type": "CHECKING",
"digit": "0",
"ispb": "12345678"
},
"pix": {
"key": "contato@exemplo.com",
"type": "EMAIL"
}
},
"receiver": {
"type": "PF",
"name": "Fulano de Tal",
"document": "***456789**",
"bankAccount": {
"type": "CHECKING",
"digit": "7",
"ispb": "12345678"
},
"pix": {
"key": "12345678910",
"type": "CPF"
}
},
"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​

CodeDescriptionSolution
401Invalid credentialsCheck your credentials
403No permission/authorizationContact support
404Record not foundCheck the id you sent
422Invalid or missing dataCheck the format of the data
422ValidationsContact support
500Internal errorContact support