Effectuate a MED refund debit

Effectuates the refund DEBIT at SPI for an accepted refund: posts a balanced PENDING Midaz double-entry (contestado debit, clearing credit) and generates the pacs.004. The debit commits on the settlement reconcile poll. The precondition (accepted AND not-yet-effectuated) is checked before any ledger touch; a non-accepted or already-effectuated request returns a coded 422 and a re-delivery is an idempotent no-double-post echo. An unknown id returns a coded 404.

POST /v1/med/refunds/{idSolDevolucao}/effectuate

Effectuate a MED refund debit

cURL

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

200

{
  "effStatus": 123,
  "effStatusDescription": "<string>",
  "idOperacaoDebito": "<string>",
  "idReqJdPi": "<string>",
  "idSolDevolucao": "<string>"
}

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).

Path Parameters

idSolDevolucao · string · required

The accepted refund-request GUID to effectuate.

Response

200

application/json

OK

effStatus · integer<int64> · required

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

effStatusDescription · string · required

Human-readable eff_status label.

idOperacaoDebito · string · required

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

idReqJdPi · string · required

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

idSolDevolucao · string · required

The effectuated refund-request GUID.