Cancel a MED infraction

curl --request POST \
  --url https://api.example.com/v1/med/infractions/{idRelatoInfracao}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Idempotency: <x-idempotency>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/med/infractions/{idRelatoInfracao}/cancel"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {'X-Idempotency': '<x-idempotency>', Authorization: 'Bearer <token>'}
};

fetch('https://api.example.com/v1/med/infractions/{idRelatoInfracao}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/med/infractions/{idRelatoInfracao}/cancel"

headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, headers=headers)

print(response.text)

{
  "counterpartIspb": "87654321",
  "createdAt": "2024-01-01T12:00:00.000Z",
  "creatorIspb": "12345678",
  "endToEndId": "E1234567820240101000000000000001",
  "infractionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "reason": 1,
  "reasonDescription": "Solicitacao de refund",
  "status": 0,
  "statusDescription": "Aberto",
  "tpSitOrigem": 0,
  "tpSitOrigemDescription": "Golpe/Estelionato",
  "updatedAt": "2024-01-01T12:05:00.000Z",
  "analysisDetails": "Confirmed.",
  "analysisResult": 0,
  "analysisResultDescription": "Aceita",
  "details": "Suspected scam.",
  "fraudMarkerId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
  "recoveryId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
  "vlrInfracao": 15000
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Cancel a MED infraction

Cancels an infraction as the creator PSP (JDPI relato-infracao/cancelar, contract §2.3). Cancel is allowed at any time, even after Analisado. An unknown id returns a coded 404. Persists the JDPI response entity and returns it. Optional ispb names the direct participant the request acts for: named, the record has to be one that participant is a party to, or the answer is 404 PIX-0147 before anything is read from JDPI or changed; an ISPB this deployment does not act as is 422 PIX-0128 before any record is read; a token confined to one participant has to name it. Optional indirectId names the registered indirect participant the request acts for: named, the infraction has to be over a payment this deployment recorded for that indirect — the rule GET /v1/med/infractions?indirectId= lists by — or the answer is 404 PIX-0147 before anything is read from JDPI or changed; a token confined to one indirect has to name it; a malformed indirectId is 400 PIX-0061.

POST

med

infractions

{idRelatoInfracao}

cancel

Cancel a MED infraction

curl --request POST \
  --url https://api.example.com/v1/med/infractions/{idRelatoInfracao}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Idempotency: <x-idempotency>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/med/infractions/{idRelatoInfracao}/cancel"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {'X-Idempotency': '<x-idempotency>', Authorization: 'Bearer <token>'}
};

fetch('https://api.example.com/v1/med/infractions/{idRelatoInfracao}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/med/infractions/{idRelatoInfracao}/cancel"

headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, headers=headers)

print(response.text)

{
  "counterpartIspb": "87654321",
  "createdAt": "2024-01-01T12:00:00.000Z",
  "creatorIspb": "12345678",
  "endToEndId": "E1234567820240101000000000000001",
  "infractionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "reason": 1,
  "reasonDescription": "Solicitacao de refund",
  "status": 0,
  "statusDescription": "Aberto",
  "tpSitOrigem": 0,
  "tpSitOrigemDescription": "Golpe/Estelionato",
  "updatedAt": "2024-01-01T12:05:00.000Z",
  "analysisDetails": "Confirmed.",
  "analysisResult": 0,
  "analysisResultDescription": "Aceita",
  "details": "Suspected scam.",
  "fraudMarkerId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
  "recoveryId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
  "vlrInfracao": 15000
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency

string

requerido

Idempotency key for this write: any stable business string you choose, sent as the X-Idempotency request header - the same header, by the same name, that the Midaz ledger takes, so one integration sends one thing by one name. Send the SAME value again to retry safely: the plugin projects it deterministically into the GUID form JDPI requires (contract 6), so a repeat lands in the same JDPI dedup slot inside JD's 24h window and the operation is applied once. The raw value is never forwarded verbatim, so correlate JDPI-side logs with the projection rather than with what you sent. The header is REQUIRED: omitting it is refused 400 PIX-0061 before any JDPI call. BREAKING CHANGE: this value used to be the body field idempotencyKey, which no longer exists.

Ejemplo:

"med-infraction-cancel-2024-0001"

Parámetros de ruta

idRelatoInfracao

string

requerido

The infraction GUID.

Ejemplo:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Parámetros de consulta

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-9A-Z]{8}$

Ejemplo:

"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 infraction has to be over a payment this deployment recorded for that indirect - the rule GET /v1/med/infractions?indirectId= lists by - or the answer is 404 PIX-0147 and nothing is read from JDPI or changed; an infraction 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.

Ejemplo:

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

Respuesta

counterpartIspb

string

requerido

ISPB of the counterparty.

Ejemplo:

"87654321"

createdAt

string

requerido

JDPI creation timestamp (RFC 3339 UTC).

Ejemplo:

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

creatorIspb

string

requerido

ISPB of the infraction creator.

Ejemplo:

"12345678"

endToEndId

string

requerido

EndToEndId of the suspect payment.

Ejemplo:

"E1234567820240101000000000000001"

infractionId

string

requerido

Infraction GUID (the natural key).

Ejemplo:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

reason

integer<int64>

requerido

Infraction reason code (1=refund request, 2=refund cancellation).

Ejemplo:

1

reasonDescription

string

requerido

Human-readable infraction reason label.

Ejemplo:

"Solicitacao de refund"

status

integer<int64>

requerido

stRelatoInfracao lifecycle code (0=Aberto, 1=Recebido, 2=Cancelado, 3=Analisado).

Ejemplo:

0

statusDescription

string

requerido

Human-readable stRelatoInfracao label.

Ejemplo:

"Aberto"

tpSitOrigem

integer<int64>

requerido

Situation-origin code (0..5).

Ejemplo:

0

tpSitOrigemDescription

string

requerido

Human-readable tpSitOrigem label.

Ejemplo:

"Golpe/Estelionato"

updatedAt

string

requerido

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

Ejemplo:

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

analysisDetails

string

Analysis detail.

Ejemplo:

"Confirmed."

analysisResult

integer<int64>

Infraction analysis result (0=Aceita, 1=Rejeitada); null until analysed.

Ejemplo:

0

analysisResultDescription

string

Human-readable infraction analysis-result label.

Ejemplo:

"Aceita"

details

string

Free-text detail to help the receiving PSP analyse.

Ejemplo:

"Suspected scam."

fraudMarkerId

string

Fraud-marker GUID, when analysis produced one.

Ejemplo:

"c3d4e5f6-a7b8-9012-cdef-345678901234"

recoveryId

string

Value-recovery GUID, when the infraction came from a recovery.

Ejemplo:

"b2c3d4e5-f6a7-8901-bcde-f23456789012"

vlrInfracao

integer<int64>

Amount to block on the account, in centavos; null when absent.

Ejemplo:

15000

APIs del participante directo

APIs de participantes indirectos

Cancel a MED infraction

Autorizaciones

Encabezados

Parámetros de ruta

Parámetros de consulta

Respuesta