Close refund blocks after a manual devolution

curl --request POST \
  --url https://api.example.com/dict-hub/v1/dict/refunds/{id}/blocks/close \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "endToEndId": "D12345678202601011210abcdef01234",
  "explanation": "devolucao conciliada manualmente apos falha do settle"
}
'

package main

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

func main() {

	url := "https://api.example.com/dict-hub/v1/dict/refunds/{id}/blocks/close"

	payload := strings.NewReader("{\n  \"endToEndId\": \"D12345678202601011210abcdef01234\",\n  \"explanation\": \"devolucao conciliada manualmente apos falha do settle\"\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: 'D12345678202601011210abcdef01234',
    explanation: 'devolucao conciliada manualmente apos falha do settle'
  })
};

fetch('https://api.example.com/dict-hub/v1/dict/refunds/{id}/blocks/close', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/dict-hub/v1/dict/refunds/{id}/blocks/close"

payload = {
    "endToEndId": "D12345678202601011210abcdef01234",
    "explanation": "devolucao conciliada manualmente apos falha do settle"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "alreadySettled": "200.00",
  "blocks": [
    {
      "amount": "600.00",
      "lockId": "b0f5c2a1-9e3d-4c7a-8f21-1a2b3c4d5e6f",
      "settledAmount": "600.00",
      "spiBlockId": "7c9a1b2d-3e4f-5a6b-7c8d-9e0f1a2b3c4d",
      "status": "SETTLED",
      "failureReason": {
        "code": "PIX-0652",
        "lockId": "c1a6d3b2-0f4e-5d8b-9032-2b3c4d5e6f70",
        "message": "falha no Midaz ao liberar o bloqueio"
      }
    }
  ],
  "blocksStatus": "SETTLED",
  "endToEndId": "D12345678202601011210abcdef01234",
  "originalAmount": "1000.00",
  "refundId": "018f8c1d-1234-7abc-9def-000000000010",
  "settledAmount": "800.00",
  "surplusAmount": "200.00"
}

{
  "code": "PIX-0030",
  "title": "Idempotency Key Required",
  "message": "The X-Idempotency header is required for this operation and must be within the accepted length."
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0005",
  "title": "Forbidden",
  "status": 403,
  "detail": "You do not have permission to perform this operation.",
  "code": "PIX-0005"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0011",
  "title": "Not Found",
  "status": 404,
  "detail": "No entity was found for the given ID. Please make sure to use the correct ID.",
  "code": "PIX-0011"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0012",
  "title": "Conflict",
  "status": 409,
  "detail": "The entity already exists or conflicts with an existing resource.",
  "code": "PIX-0012"
}

{
  "code": "PIX-0031",
  "title": "Idempotency Key Conflict",
  "message": "The X-Idempotency header is held by a request still running or whose receipt could not be stored, or was already used with a different request."
}

{
  "code": "PIX-0016",
  "title": "Unsupported Media Type",
  "message": "The request body must be sent with Content-Type: application/json."
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0013",
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "The operation could not be processed due to a business rule violation.",
  "code": "PIX-0013"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0000",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "internal error",
  "code": "PIX-0000"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0141",
  "title": "Bad Gateway",
  "status": 502,
  "detail": "internal error",
  "code": "PIX-0141"
}

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

dict

refunds

{id}

blocks

Close refund blocks after a manual devolution

curl --request POST \
  --url https://api.example.com/dict-hub/v1/dict/refunds/{id}/blocks/close \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "endToEndId": "D12345678202601011210abcdef01234",
  "explanation": "devolucao conciliada manualmente apos falha do settle"
}
'

package main

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

func main() {

	url := "https://api.example.com/dict-hub/v1/dict/refunds/{id}/blocks/close"

	payload := strings.NewReader("{\n  \"endToEndId\": \"D12345678202601011210abcdef01234\",\n  \"explanation\": \"devolucao conciliada manualmente apos falha do settle\"\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: 'D12345678202601011210abcdef01234',
    explanation: 'devolucao conciliada manualmente apos falha do settle'
  })
};

fetch('https://api.example.com/dict-hub/v1/dict/refunds/{id}/blocks/close', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/dict-hub/v1/dict/refunds/{id}/blocks/close"

payload = {
    "endToEndId": "D12345678202601011210abcdef01234",
    "explanation": "devolucao conciliada manualmente apos falha do settle"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "alreadySettled": "200.00",
  "blocks": [
    {
      "amount": "600.00",
      "lockId": "b0f5c2a1-9e3d-4c7a-8f21-1a2b3c4d5e6f",
      "settledAmount": "600.00",
      "spiBlockId": "7c9a1b2d-3e4f-5a6b-7c8d-9e0f1a2b3c4d",
      "status": "SETTLED",
      "failureReason": {
        "code": "PIX-0652",
        "lockId": "c1a6d3b2-0f4e-5d8b-9032-2b3c4d5e6f70",
        "message": "falha no Midaz ao liberar o bloqueio"
      }
    }
  ],
  "blocksStatus": "SETTLED",
  "endToEndId": "D12345678202601011210abcdef01234",
  "originalAmount": "1000.00",
  "refundId": "018f8c1d-1234-7abc-9def-000000000010",
  "settledAmount": "800.00",
  "surplusAmount": "200.00"
}

{
  "code": "PIX-0030",
  "title": "Idempotency Key Required",
  "message": "The X-Idempotency header is required for this operation and must be within the accepted length."
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0005",
  "title": "Forbidden",
  "status": 403,
  "detail": "You do not have permission to perform this operation.",
  "code": "PIX-0005"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0011",
  "title": "Not Found",
  "status": 404,
  "detail": "No entity was found for the given ID. Please make sure to use the correct ID.",
  "code": "PIX-0011"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0012",
  "title": "Conflict",
  "status": 409,
  "detail": "The entity already exists or conflicts with an existing resource.",
  "code": "PIX-0012"
}

{
  "code": "PIX-0031",
  "title": "Idempotency Key Conflict",
  "message": "The X-Idempotency header is held by a request still running or whose receipt could not be stored, or was already used with a different request."
}

{
  "code": "PIX-0016",
  "title": "Unsupported Media Type",
  "message": "The request body must be sent with Content-Type: application/json."
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0013",
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "The operation could not be processed due to a business rule violation.",
  "code": "PIX-0013"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0000",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "internal error",
  "code": "PIX-0000"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0141",
  "title": "Bad Gateway",
  "status": 502,
  "detail": "internal error",
  "code": "PIX-0141"
}

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

REQUIRED. Client-supplied replay key, at most 64 bytes. A request without it is refused with PIX-0030 @ 400 before the handler runs. Resending the same key and request within 1 hour returns the original response, its status included, with X-Idempotency-Replayed: true. Reusing the key with a divergent method, path or body, or while the first request runs, is PIX-0031 @ 412.

Required string length: 1 - 64

X-Correlation-Id

string

Best-effort business correlation id (observability only; never fabricated).

Parámetros de ruta

string

requerido

Refund internal ID (UUID format)

Ejemplo:

"018f8c1d-1234-7abc-9def-000000000010"

Cuerpo

application/json

endToEndId

string

requerido

Ejemplo:

"D12345678202601011210abcdef01234"

explanation

string

requerido

Mandatory recovery justification, at most 512 characters; recorded on each block's SPI close

Ejemplo:

"devolucao conciliada manualmente apos falha do settle"

Respuesta

alreadySettled

string

requerido

Ejemplo:

"200.00"

blocks

object[] | null

requerido

Show child attributes

blocksStatus

enum<string>

requerido

Opciones disponibles:

SETTLED

Ejemplo:

"SETTLED"

endToEndId

string

requerido

Ejemplo:

"D12345678202601011210abcdef01234"

originalAmount

string

requerido

Ejemplo:

"1000.00"

refundId

string

requerido

Ejemplo:

"018f8c1d-1234-7abc-9def-000000000010"

settledAmount

string

requerido

Ejemplo:

"800.00"

surplusAmount

string

requerido

Ejemplo:

"200.00"

DICT y claves Pix

Cobros y códigos BR

Pagos y devoluciones

API de Pix Automático

Manejo de errores

Close refund blocks after a manual devolution

Autorizaciones

Encabezados

Parámetros de ruta

Cuerpo

Respuesta