List MED refund requests

Lists the refund requests detected by the worker pollers (requested by this institution or against it), filterable by status, role ISPB, and the contested payment’s endToEndId. Read projection — no upstream round-trip.

GET /v1/med/refunds

List MED refund requests

cURL

curl --request GET \
  --url https://plugin-pix-direct.api.lerian.net/v1/med/refunds \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "breached": true,
      "dtHrCriacao": "<string>",
      "dtHrUltModificacao": "<string>",
      "endToEndId": "<string>",
      "idSolDevolucao": "<string>",
      "ispbContestado": "<string>",
      "ispbSolicitante": "<string>",
      "motivo": 123,
      "motivoDescription": "<string>",
      "status": 123,
      "statusDescription": "<string>",
      "valorDevolucaoCents": 123,
      "analysisDeadline": "<string>",
      "detalhes": "<string>",
      "detalhesAnalise": "<string>",
      "endToEndIdDevolucao": "<string>",
      "idRecValores": "<string>",
      "idRelatoInfracao": "<string>",
      "motivoRejeicao": 123,
      "motivoRejeicaoDescription": "<string>",
      "resultadoAnalise": 123,
      "resultadoAnaliseDescription": "<string>",
      "valorDevolvidoCents": 123
    }
  ]
}

Authorizations

Authorization · string · header · required

JWT Bearer token authentication. Obtain token from /v1/login/oauth/access_token endpoint using client credentials (clientId and clientSecret).

Include token in Authorization header: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Token expires after 3600 seconds (1 hour).

Query Parameters

status · string

Filter on stSolDevolucao (0=Aberta, 1=Cancelada, 2=Analisada).

ispb_contestado · string

Filter on the contested ISPB (refunds requested against this institution).

ispb_solicitante · string

Filter on the requester ISPB (refunds this institution requested).

end_to_end_id · string

Filter on the contested payment's endToEndId.

Response

200

application/json

OK

data · object[] | null · required

The list of detected refund requests, newest first.

Show child attributes