Open a MED refund request

curl --request POST \
  --url https://api.example.com/v1/med/refunds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "endToEndId": "E1234567820240101000000000000001",
  "reason": 1,
  "refundAmount": 25000,
  "details": "Suspected scam.",
  "ispb": "12345678"
}
'

package main

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

func main() {

	url := "https://api.example.com/v1/med/refunds"

	payload := strings.NewReader("{\n  \"endToEndId\": \"E1234567820240101000000000000001\",\n  \"reason\": 1,\n  \"refundAmount\": 25000,\n  \"details\": \"Suspected scam.\",\n  \"ispb\": \"12345678\"\n}")

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

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	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>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    endToEndId: 'E1234567820240101000000000000001',
    reason: 1,
    refundAmount: 25000,
    details: 'Suspected scam.',
    ispb: '12345678'
  })
};

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

import requests

url = "https://api.example.com/v1/med/refunds"

payload = {
    "endToEndId": "E1234567820240101000000000000001",
    "reason": 1,
    "refundAmount": 25000,
    "details": "Suspected scam.",
    "ispb": "12345678"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "breached": false,
  "contestedIspb": "87654321",
  "createdAt": "2024-01-01T12:00:00.000Z",
  "endToEndId": "E1234567820240101000000000000001",
  "reason": 1,
  "reasonDescription": "Fraude",
  "refundAmount": 25000,
  "refundRequestId": "d4e5f6a7-b8c9-0123-def4-56789012345a",
  "requesterIspb": "12345678",
  "status": 0,
  "statusDescription": "Aberta",
  "updatedAt": "2024-01-01T12:05:00.000Z",
  "analysisDeadline": "2024-01-01T18:00:00.000Z",
  "analysisDetails": "Insufficient balance.",
  "analysisResult": 0,
  "analysisResultDescription": "Aceita Totalmente",
  "details": "Operational failure.",
  "infractionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "recoveryId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
  "refundEndToEndId": "D1234567820240101000000000000099",
  "refundedAmount": 25000,
  "registeredAt": "2021-08-06T10:33:08.241Z",
  "rejectionReason": 0,
  "rejectionReasonDescription": "Falta de saldo"
}

{
  "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"
  }
}

POST

med

refunds

Open a MED refund request

curl --request POST \
  --url https://api.example.com/v1/med/refunds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "endToEndId": "E1234567820240101000000000000001",
  "reason": 1,
  "refundAmount": 25000,
  "details": "Suspected scam.",
  "ispb": "12345678"
}
'

package main

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

func main() {

	url := "https://api.example.com/v1/med/refunds"

	payload := strings.NewReader("{\n  \"endToEndId\": \"E1234567820240101000000000000001\",\n  \"reason\": 1,\n  \"refundAmount\": 25000,\n  \"details\": \"Suspected scam.\",\n  \"ispb\": \"12345678\"\n}")

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

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	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>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    endToEndId: 'E1234567820240101000000000000001',
    reason: 1,
    refundAmount: 25000,
    details: 'Suspected scam.',
    ispb: '12345678'
  })
};

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

import requests

url = "https://api.example.com/v1/med/refunds"

payload = {
    "endToEndId": "E1234567820240101000000000000001",
    "reason": 1,
    "refundAmount": 25000,
    "details": "Suspected scam.",
    "ispb": "12345678"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "breached": false,
  "contestedIspb": "87654321",
  "createdAt": "2024-01-01T12:00:00.000Z",
  "endToEndId": "E1234567820240101000000000000001",
  "reason": 1,
  "reasonDescription": "Fraude",
  "refundAmount": 25000,
  "refundRequestId": "d4e5f6a7-b8c9-0123-def4-56789012345a",
  "requesterIspb": "12345678",
  "status": 0,
  "statusDescription": "Aberta",
  "updatedAt": "2024-01-01T12:05:00.000Z",
  "analysisDeadline": "2024-01-01T18:00:00.000Z",
  "analysisDetails": "Insufficient balance.",
  "analysisResult": 0,
  "analysisResultDescription": "Aceita Totalmente",
  "details": "Operational failure.",
  "infractionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "recoveryId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
  "refundEndToEndId": "D1234567820240101000000000000099",
  "refundedAmount": 25000,
  "registeredAt": "2021-08-06T10:33:08.241Z",
  "rejectionReason": 0,
  "rejectionReasonDescription": "Falta de saldo"
}

{
  "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"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency

string

required

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.

Example:

"med-refund-2024-0001"

Body

application/json

endToEndId

string

required

EndToEndId of the contested payment (or pacs.004 id for a cancellation reason).

Example:

"E1234567820240101000000000000001"

reason

integer<int64>

required

Refund reason (0=operational failure, 1=fraud, 3=Pix Automatico).

Example:

1

refundAmount

integer<int64>

required

Requested refund amount, in centavos.

Example:

25000

details

string

Free-text detail; required when reason=0 (Falha Operacional).

Example:

"Suspected scam."

ispb

string

The ISPB of the direct participant this operation acts as. This deployment may act as SEVERAL direct SPI participants - one ISPB each, each with its own customers and its own JDPI credential - and this field is the only thing on the request that says which of them acts. OPTIONAL while it acts as a single participant: omit it and that one acts. REQUIRED once it acts as several - omitted is 422 PIX-0127, and an ISPB this deployment does not act as is 422 PIX-0128. It is ROUTING DATA you supply and guarantee, exactly like payerIspb on a transaction: never a credential, never read from a header or a path, and it never widens what your token can reach. It also selects the JDPI channel the call goes out on, so a MED write made under the wrong one reaches a JD that has never heard of this institution. Send it as an absent key, not an empty string; an empty value is refused 400 PIX-0061.

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

Example:

"12345678"

Response

Accepted

breached

boolean

required

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

Example:

false

contestedIspb

string

required

ISPB of the contested PSP.

Example:

"87654321"

createdAt

string

required

JDPI creation timestamp (RFC 3339 UTC).

Example:

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

endToEndId

string

required

EndToEndId of the contested payment or refund.

Example:

"E1234567820240101000000000000001"

reason

integer<int64>

required

Refund reason code (0=operational failure, 1=fraud, 3=Pix Automatico).

Example:

1

reasonDescription

string

required

Human-readable refund reason label.

Example:

"Fraude"

refundAmount

integer<int64>

required

Requested refund amount, in centavos.

Example:

25000

refundRequestId

string

required

Refund-request GUID (the natural key).

Example:

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

requesterIspb

string

required

ISPB of the requesting PSP.

Example:

"12345678"

status

integer<int64>

required

stSolDevolucao lifecycle code (0=open, 1=cancelled, 2=analyzed).

Example:

0

statusDescription

string

required

Human-readable stSolDevolucao label.

Example:

"Aberta"

updatedAt

string

required

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

Example:

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

analysisDeadline

string

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

Example:

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

analysisDetails

string

Analysis detail.

Example:

"Insufficient balance."

analysisResult

integer<int64>

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

Example:

0

analysisResultDescription

string

Human-readable refund analysis-result label.

Example:

"Aceita Totalmente"

details

string

Free-text detail.

Example:

"Operational failure."

infractionId

string

Linked infraction GUID, when fraud.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

recoveryId

string

Value-recovery GUID, when from a recovery.

Example:

"b2c3d4e5-f6a7-8901-bcde-f23456789012"

refundEndToEndId

string

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

Example:

"D1234567820240101000000000000099"

refundedAmount

integer<int64>

Amount actually refunded, in centavos; null when absent.

Example:

25000

registeredAt

string

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

Example:

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

rejectionReason

integer<int64>

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

Example:

0

rejectionReasonDescription

string

Human-readable rejection-reason label.

Example:

"Falta de saldo"

Direct participant APIs

Indirect participant APIs

Open a MED refund request

Authorizations

Headers

Body

Response