curl --request POST \
  --url https://api.example.com/v1/med/credits/inbound \
  --header 'Authorization: Bearer <token>' \
  --header 'Chave-Idempotencia: <chave-idempotencia>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "endToEndIdDevolucao": "D1234567820240101000000000000099",
  "idReqJdPi": "f1e2d3c4-b5a6-7890-1234-567890abcdef",
  "valor": 150.85,
  "codigoDevolucao": "BE08",
  "dtContabil": "2024-09-20",
  "dtHrLiquidacao": "2024-09-20T04:00:01.001Z",
  "dtHrOp": "2024-09-20T04:00:01.001Z",
  "endToEndIdOriginal": "E1234567820240101000000000000001",
  "infEntreClientes": "Compra Paga",
  "motivoDevolucao": "Devolucao MED."
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"endToEndIdDevolucao\": \"D1234567820240101000000000000099\",\n  \"idReqJdPi\": \"f1e2d3c4-b5a6-7890-1234-567890abcdef\",\n  \"valor\": 150.85,\n  \"codigoDevolucao\": \"BE08\",\n  \"dtContabil\": \"2024-09-20\",\n  \"dtHrLiquidacao\": \"2024-09-20T04:00:01.001Z\",\n  \"dtHrOp\": \"2024-09-20T04:00:01.001Z\",\n  \"endToEndIdOriginal\": \"E1234567820240101000000000000001\",\n  \"infEntreClientes\": \"Compra Paga\",\n  \"motivoDevolucao\": \"Devolucao MED.\"\n}")

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

	req.Header.Add("Chave-Idempotencia", "<chave-idempotencia>")
	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: {
    'Chave-Idempotencia': '<chave-idempotencia>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    endToEndIdDevolucao: 'D1234567820240101000000000000099',
    idReqJdPi: 'f1e2d3c4-b5a6-7890-1234-567890abcdef',
    valor: 150.85,
    codigoDevolucao: 'BE08',
    dtContabil: '2024-09-20',
    dtHrLiquidacao: '2024-09-20T04:00:01.001Z',
    dtHrOp: '2024-09-20T04:00:01.001Z',
    endToEndIdOriginal: 'E1234567820240101000000000000001',
    infEntreClientes: 'Compra Paga',
    motivoDevolucao: 'Devolucao MED.'
  })
};

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

import requests

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

payload = {
    "endToEndIdDevolucao": "D1234567820240101000000000000099",
    "idReqJdPi": "f1e2d3c4-b5a6-7890-1234-567890abcdef",
    "valor": 150.85,
    "codigoDevolucao": "BE08",
    "dtContabil": "2024-09-20",
    "dtHrLiquidacao": "2024-09-20T04:00:01.001Z",
    "dtHrOp": "2024-09-20T04:00:01.001Z",
    "endToEndIdOriginal": "E1234567820240101000000000000001",
    "infEntreClientes": "Compra Paga",
    "motivoDevolucao": "Devolucao MED."
}
headers = {
    "Chave-Idempotencia": "<chave-idempotencia>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "dtHrCreditoSgct": "2024-09-20T04:00:01.001Z",
  "idCreditoSgct": "58F752C5-6376-3252-8305-A2DE3A8525D3",
  "idReqJdPi": "f1e2d3c4-b5a6-7890-1234-567890abcdef"
}

{
  "code": "ERR-0001",
  "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": "ERR-0001",
  "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": "ERR-0001",
  "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"
  }
}

Register a MED inbound refund credit (THIRD RAIL — moves money)

Posts the receiving-side refund CREDIT on the local Midaz ledger when SPI settles a MED devolucao (the plugin is the SGCT server; JDPI calls this after the pacs.004 is received, contract §2.28). It posts a balanced COMMITTED double-entry (clearing credit, recipient debit-mirror) and mints the idCreditoSgct. The Authorization (Bearer) header is mandatory on this financial ingress: a missing/invalid token is a coded 401. A re-delivered credit for the same endToEndIdDevolucao echoes the prior idCreditoSgct with no second post (idempotent).

POST

med

credits

inbound

curl --request POST \
  --url https://api.example.com/v1/med/credits/inbound \
  --header 'Authorization: Bearer <token>' \
  --header 'Chave-Idempotencia: <chave-idempotencia>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "endToEndIdDevolucao": "D1234567820240101000000000000099",
  "idReqJdPi": "f1e2d3c4-b5a6-7890-1234-567890abcdef",
  "valor": 150.85,
  "codigoDevolucao": "BE08",
  "dtContabil": "2024-09-20",
  "dtHrLiquidacao": "2024-09-20T04:00:01.001Z",
  "dtHrOp": "2024-09-20T04:00:01.001Z",
  "endToEndIdOriginal": "E1234567820240101000000000000001",
  "infEntreClientes": "Compra Paga",
  "motivoDevolucao": "Devolucao MED."
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"endToEndIdDevolucao\": \"D1234567820240101000000000000099\",\n  \"idReqJdPi\": \"f1e2d3c4-b5a6-7890-1234-567890abcdef\",\n  \"valor\": 150.85,\n  \"codigoDevolucao\": \"BE08\",\n  \"dtContabil\": \"2024-09-20\",\n  \"dtHrLiquidacao\": \"2024-09-20T04:00:01.001Z\",\n  \"dtHrOp\": \"2024-09-20T04:00:01.001Z\",\n  \"endToEndIdOriginal\": \"E1234567820240101000000000000001\",\n  \"infEntreClientes\": \"Compra Paga\",\n  \"motivoDevolucao\": \"Devolucao MED.\"\n}")

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

	req.Header.Add("Chave-Idempotencia", "<chave-idempotencia>")
	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: {
    'Chave-Idempotencia': '<chave-idempotencia>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    endToEndIdDevolucao: 'D1234567820240101000000000000099',
    idReqJdPi: 'f1e2d3c4-b5a6-7890-1234-567890abcdef',
    valor: 150.85,
    codigoDevolucao: 'BE08',
    dtContabil: '2024-09-20',
    dtHrLiquidacao: '2024-09-20T04:00:01.001Z',
    dtHrOp: '2024-09-20T04:00:01.001Z',
    endToEndIdOriginal: 'E1234567820240101000000000000001',
    infEntreClientes: 'Compra Paga',
    motivoDevolucao: 'Devolucao MED.'
  })
};

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

import requests

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

payload = {
    "endToEndIdDevolucao": "D1234567820240101000000000000099",
    "idReqJdPi": "f1e2d3c4-b5a6-7890-1234-567890abcdef",
    "valor": 150.85,
    "codigoDevolucao": "BE08",
    "dtContabil": "2024-09-20",
    "dtHrLiquidacao": "2024-09-20T04:00:01.001Z",
    "dtHrOp": "2024-09-20T04:00:01.001Z",
    "endToEndIdOriginal": "E1234567820240101000000000000001",
    "infEntreClientes": "Compra Paga",
    "motivoDevolucao": "Devolucao MED."
}
headers = {
    "Chave-Idempotencia": "<chave-idempotencia>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "dtHrCreditoSgct": "2024-09-20T04:00:01.001Z",
  "idCreditoSgct": "58F752C5-6376-3252-8305-A2DE3A8525D3",
  "idReqJdPi": "f1e2d3c4-b5a6-7890-1234-567890abcdef"
}

{
  "code": "ERR-0001",
  "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": "ERR-0001",
  "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": "ERR-0001",
  "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

Authorization

string

Bearer access token (the financial-ingress gate; the handler fails closed with PIX-0082 when absent).

Example:

"Bearer eyJ..."

Chave-Idempotencia

string

required

Idempotency key (= the endToEndIdDevolucao). Mandatory per the MED SPI credit contract.

Example:

"D1111111120240918150000000000099"

Body

application/json

endToEndIdDevolucao

string

required

EndToEndId of the devolucao (pacs.004; the natural key / idempotency anchor, 32-char).

Example:

"D1234567820240101000000000000099"

idReqJdPi

string

required

The JDPI request id of the credit notification.

Example:

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

valor

number<double>

required

Credited refund amount, in reais (a JSON number; JDPI 9.3.3).

Example:

150.85

codigoDevolucao

string

Refund reason code (BE08/FR01/MD06/SL02; §9.3.3 Obrg=Sim, tolerated-absent).

Example:

"BE08"

dtContabil

string

SPI accounting date (§9.3.3, Obrg=Sim, aaaa-mm-dd).

Example:

"2024-09-20"

dtHrLiquidacao

string

SPI settlement instant (§9.3.3, Obrg=Sim, UTC).

Example:

"2024-09-20T04:00:01.001Z"

dtHrOp

string

Recebedor-informed original instant (UTC).

Example:

"2024-09-20T04:00:01.001Z"

endToEndIdOriginal

string

EndToEndId of the original contested payment (32-char; §9.3.3 Obrg=Sim, tolerated-absent).

Example:

"E1234567820240101000000000000001"

infEntreClientes

string

Payer-to-payee free-text information (§9.3.3, Obrg=Nao).

Example:

"Compra Paga"

motivoDevolucao

string

Free-text refund detail.

Example:

"Devolucao MED."

pagador

object

Payer (pagador) identity; retained for audit/observability.

Show child attributes

recebedor

object

Recipient (recebedor) identity; the credit distribute leg target (design D2 mirror). recebedor.ispb is enforced by Validate().

Show child attributes

Response

dtHrCreditoSgct

string

required

The SGCT credit-commit instant (UTC, RFC 3339).

Example:

"2024-09-20T04:00:01.001Z"

idCreditoSgct

string

required

The plugin-minted credit-entry id (GUID).

Example:

"58F752C5-6376-3252-8305-A2DE3A8525D3"

idReqJdPi

string

required

The JDPI request id (echoed).

Example:

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

Key DICT API

Key Claims API

Banks API

Indirect participants API

Transactions API

Transaction Limits API

QR Codes API

Refunds API

Pix Automático · Authorization requests

Pix Automático · Authorization management

Pix Automático · Composite QR codes

Pix Automático · Authorization events

Pix Automático · Schedule events

Pix Automático · Schedules and payment instructions

Pix Automático · Settlement

MED · Refunds

MED · Fraud markers

MED · Infractions

MED · Value recovery

Webhooks API

Error handling

Events

Register a MED inbound refund credit (THIRD RAIL — moves money)

Authorizations

Headers

Body

Response