Skip to main content
POST
Effectuate a MED refund debit (THIRD RAIL — moves money)

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

idSolDevolucao
string
required

The accepted refund-request GUID to effectuate.

Example:

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

Query Parameters

ispb
string

The ISPB of the direct participant this request acts for. OPTIONAL: omit it and the request is answered exactly as before. Named, the record has to be one that participant is a party to - either side of a dispute, the creator of a value recovery, the participant a refund credit was booked for - or the answer is 404 PIX-0147 and nothing is read from JDPI or changed. A record this deployment does not hold is 404 PIX-0147 too when an ispb is named. An ISPB this deployment does not act as is 422 PIX-0128, before any record is read. It is ROUTING DATA you supply, never a credential, and a token confined to one participant has to name it here. Sending it empty (ispb=) reads the same as omitting it.

Pattern: ^[0-9]{8}$
Example:

"12345678"

indirectId
string<uuid>

The registered indirect participant (UUID) this request acts for. OPTIONAL: omit it and the request is answered exactly as before. Named, the refund request has to be over a payment this deployment recorded for that indirect - the rule GET /v1/med/refunds?indirectId= lists by - or the answer is 404 PIX-0147 and nothing is read from JDPI or changed; a record this deployment does not hold is 404 PIX-0147 too when an indirectId is named. It is ROUTING DATA you supply, never a credential, and a token confined to one indirect has to name it here. Not a valid UUID is 400 PIX-0061. Sending it empty (indirectId=) reads the same as omitting it.

Example:

"3f2504e0-4f89-41d3-9a0c-0305e82c3301"

Response

OK

effStatus
integer<int64>
required

Debit-effectuation FSM code (0=NotStarted, 1=DebitPending, 2=Settled, 3=Failed).

Example:

1

effStatusDescription
string
required

Human-readable eff_status label.

Example:

"DebitPending"

idOperacaoDebito
string
required

The Pending Midaz debit posting id (the reconcile commit/cancel reference).

Example:

"01HXYZ..."

idReqJdPi
string
required

The JDPI /od request id (the debit-poll handle).

Example:

"f1e2d3c4-b5a6-7890-1234-567890abcdef"

refundRequestId
string
required

The effectuated refund-request GUID.

Example:

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