Skip to main content
GET
/
meds
/
list
curl -X GET 'https://api.goatpay.com.br/v1/meds/list?page=1&pageSize=50&status=OPEN' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "MEDs listados",
  "data": {
    "items": [
      {
        "id": "clx_med",
        "protocol": "MED-123",
        "transactionId": "clx_pix_in",
        "status": "OPEN",
        "amount": 99.9,
        "currency": "BRL",
        "reason": "Não reconhecimento",
        "infractionId": "inf_abc",
        "endToEndId": "E12345678202505301234567890123456",
        "openedAt": "2026-05-28T12:00:00.000Z",
        "dueAt": "2026-06-04T12:00:00.000Z",
        "resolvedAt": null
      }
    ],
    "page": 1,
    "pageSize": 50,
    "total": 1,
    "pages": 1
  },
  "requestId": "req_abc"
}

curl -X GET 'https://api.goatpay.com.br/v1/meds/list?page=1&pageSize=50&status=OPEN' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "MEDs listados",
  "data": {
    "items": [
      {
        "id": "clx_med",
        "protocol": "MED-123",
        "transactionId": "clx_pix_in",
        "status": "OPEN",
        "amount": 99.9,
        "currency": "BRL",
        "reason": "Não reconhecimento",
        "infractionId": "inf_abc",
        "endToEndId": "E12345678202505301234567890123456",
        "openedAt": "2026-05-28T12:00:00.000Z",
        "dueAt": "2026-06-04T12:00:00.000Z",
        "resolvedAt": null
      }
    ],
    "page": 1,
    "pageSize": 50,
    "total": 1,
    "pages": 1
  },
  "requestId": "req_abc"
}

​
Parâmetros de query

​
page
number
Página (padrão 1).
​
pageSize
number
Itens por página (padrão 50, máx. 100).
​
dateFrom
string
ISO 8601 — início (openedAt).
​
dateTo
string
ISO 8601 — fim (openedAt).
​
status
string
OPEN, UNDER_REVIEW, ACCEPTED, REJECTED, CANCELED ou EXPIRED.
​
search
string
Busca em id, protocol, transactionId ou infractionId.

Authorizations

​
X-API-Key
string
header
required

Chave gp_live_... criada em Integrações → Chaves de API no dashboard.

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
pageSize
integer
default:50
Required range: 1 <= x <= 100
​
dateFrom
string<date-time>
​
dateTo
string<date-time>
​
status
enum<string>
Available options:
OPEN,
UNDER_REVIEW,
ACCEPTED,
REJECTED,
CANCELED,
EXPIRED
​
search
string

Busca parcial em id, description, externalReference, endToEndId, referenceId e pixKey.

Response

200 - application/json

Lista paginada de disputas MED.

​
success
boolean
required
​
message
string
required
​
data
object
required
​
requestId
string