Skip to main content
POST
Cancel a MED refund request

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

idSolDevolucao
string
obrigatório

The refund-request GUID.

Exemplo:

"d4e5f6a7-b8c9-0123-def4-56789012345a"

Corpo

application/json
idempotencyKey
string
obrigatório

Client-supplied idempotency key: any stable business string. The plugin projects it deterministically into the GUID form JDPI requires (contract 6), so the same value always dedups against the same JDPI request and the raw value is never sent verbatim.

Exemplo:

"med-cancel-2024-0001"

Resposta

OK

breached
boolean
obrigatório

True when the analysis deadline has been reached or passed (computed at read time); false when no deadline is set.

Exemplo:

false

dtHrCriacao
string
obrigatório

JDPI creation timestamp (RFC 3339 UTC).

Exemplo:

"2024-01-01T12:00:00.000Z"

dtHrUltModificacao
string
obrigatório

JDPI last-modification timestamp (RFC 3339 UTC) — the poll watermark.

Exemplo:

"2024-01-01T12:05:00.000Z"

endToEndId
string
obrigatório

EndToEndId of the contested payment or devolucao.

Exemplo:

"E1234567820240101000000000000001"

idSolDevolucao
string
obrigatório

Refund-request GUID (the natural key).

Exemplo:

"d4e5f6a7-b8c9-0123-def4-56789012345a"

ispbContestado
string
obrigatório

ISPB of the contested PSP.

Exemplo:

"87654321"

ispbSolicitante
string
obrigatório

ISPB of the requesting PSP.

Exemplo:

"12345678"

motivo
integer<int64>
obrigatório

Refund motivo code (0=Falha Operacional, 1=Fraude, 3=Pix Automatico).

Exemplo:

1

motivoDescription
string
obrigatório

Human-readable refund motivo label.

Exemplo:

"Fraude"

status
integer<int64>
obrigatório

stSolDevolucao lifecycle code (0=Aberta, 1=Cancelada, 2=Analisada).

Exemplo:

0

statusDescription
string
obrigatório

Human-readable stSolDevolucao label.

Exemplo:

"Aberta"

valorDevolucao
integer<int64>
obrigatório

Requested refund amount, in centavos.

Exemplo:

25000

analysisDeadline
string

Contestado-side analysis deadline (RFC 3339 UTC; contract §5, 6h Fraude / 48h otherwise); null for filer-side and terminal requests.

Exemplo:

"2024-01-01T18:00:00.000Z"

detalhes
string

Free-text detail.

Exemplo:

"Operational failure."

detalhesAnalise
string

Analysis detail.

Exemplo:

"Insufficient balance."

dtHrRegistro
string

dtHrRegistro — when the request was REGISTERED in the JDPI base (raw JDPI instant), distinct from dtHrCriacao (the DICT creation instant). Returned by the §8.2.26 JDPI-base read only.

Exemplo:

"2021-08-06T10:33:08.241Z"

endToEndIdDevolucao
string

pacs.004/pacs.008 devolucao reference, recorded at analysis.

Exemplo:

"D1234567820240101000000000000099"

idRecValores
string

Value-recovery GUID, when from a recovery.

Exemplo:

"b2c3d4e5-f6a7-8901-bcde-f23456789012"

idRelatoInfracao
string

Linked infraction GUID, when fraud.

Exemplo:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

motivoRejeicao
integer<int64>

Rejection reason (0,1,3,4); present only when the analysis rejected the request.

Exemplo:

0

motivoRejeicaoDescription
string

Human-readable rejection-reason label.

Exemplo:

"Falta de saldo"

resultadoAnalise
integer<int64>

Refund analysis result (0=Aceita Totalmente, 1=Aceita Parcialmente, 2=Rejeitada); null until analysed.

Exemplo:

0

resultadoAnaliseDescription
string

Human-readable refund analysis-result label.

Exemplo:

"Aceita Totalmente"

valorDevolvido
integer<int64>

Amount actually refunded, in centavos; null when absent.

Exemplo:

25000