Cerrar devolución DICT

curl --request POST \
  --url https://spi.sandbox.lerian.net/api/v1/dict/refunds/{id}/close \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "analysisResult": "<string>",
  "analysisDetails": "<string>",
  "effectiveRefundedAmountCents": 123,
  "rejectionReason": "<string>"
}
'

import requests

url = "https://spi.sandbox.lerian.net/api/v1/dict/refunds/{id}/close"

payload = {
    "analysisResult": "<string>",
    "analysisDetails": "<string>",
    "effectiveRefundedAmountCents": 123,
    "rejectionReason": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    analysisResult: '<string>',
    analysisDetails: '<string>',
    effectiveRefundedAmountCents: 123,
    rejectionReason: '<string>'
  })
};

fetch('https://spi.sandbox.lerian.net/api/v1/dict/refunds/{id}/close', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://spi.sandbox.lerian.net/api/v1/dict/refunds/{id}/close",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'analysisResult' => '<string>',
    'analysisDetails' => '<string>',
    'effectiveRefundedAmountCents' => 123,
    'rejectionReason' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://spi.sandbox.lerian.net/api/v1/dict/refunds/{id}/close"

	payload := strings.NewReader("{\n  \"analysisResult\": \"<string>\",\n  \"analysisDetails\": \"<string>\",\n  \"effectiveRefundedAmountCents\": 123,\n  \"rejectionReason\": \"<string>\"\n}")

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

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

}

HttpResponse<String> response = Unirest.post("https://spi.sandbox.lerian.net/api/v1/dict/refunds/{id}/close")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"analysisResult\": \"<string>\",\n  \"analysisDetails\": \"<string>\",\n  \"effectiveRefundedAmountCents\": 123,\n  \"rejectionReason\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://spi.sandbox.lerian.net/api/v1/dict/refunds/{id}/close")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"analysisResult\": \"<string>\",\n  \"analysisDetails\": \"<string>\",\n  \"effectiveRefundedAmountCents\": 123,\n  \"rejectionReason\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "amountCents": 123,
  "createdAt": "<string>",
  "endToEndId": "<string>",
  "id": "<string>",
  "reason": "<string>",
  "reportStatus": "<string>",
  "requestedByISPB": "<string>",
  "status": "<string>",
  "updatedAt": "<string>",
  "effectiveRefundedAmountCents": 123,
  "fundsRecoveryId": "<string>",
  "monitorAccount": true,
  "refundAccount": {
    "accountNumber": "<string>",
    "accountType": "<string>",
    "participant": "<string>",
    "taxIdNumber": "<string>",
    "branch": "<string>"
  }
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

POST

api

dict

refunds

{id}

Cerrar devolución DICT

curl --request POST \
  --url https://spi.sandbox.lerian.net/api/v1/dict/refunds/{id}/close \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "analysisResult": "<string>",
  "analysisDetails": "<string>",
  "effectiveRefundedAmountCents": 123,
  "rejectionReason": "<string>"
}
'

import requests

url = "https://spi.sandbox.lerian.net/api/v1/dict/refunds/{id}/close"

payload = {
    "analysisResult": "<string>",
    "analysisDetails": "<string>",
    "effectiveRefundedAmountCents": 123,
    "rejectionReason": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    analysisResult: '<string>',
    analysisDetails: '<string>',
    effectiveRefundedAmountCents: 123,
    rejectionReason: '<string>'
  })
};

fetch('https://spi.sandbox.lerian.net/api/v1/dict/refunds/{id}/close', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://spi.sandbox.lerian.net/api/v1/dict/refunds/{id}/close",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'analysisResult' => '<string>',
    'analysisDetails' => '<string>',
    'effectiveRefundedAmountCents' => 123,
    'rejectionReason' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://spi.sandbox.lerian.net/api/v1/dict/refunds/{id}/close"

	payload := strings.NewReader("{\n  \"analysisResult\": \"<string>\",\n  \"analysisDetails\": \"<string>\",\n  \"effectiveRefundedAmountCents\": 123,\n  \"rejectionReason\": \"<string>\"\n}")

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

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

}

HttpResponse<String> response = Unirest.post("https://spi.sandbox.lerian.net/api/v1/dict/refunds/{id}/close")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"analysisResult\": \"<string>\",\n  \"analysisDetails\": \"<string>\",\n  \"effectiveRefundedAmountCents\": 123,\n  \"rejectionReason\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://spi.sandbox.lerian.net/api/v1/dict/refunds/{id}/close")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"analysisResult\": \"<string>\",\n  \"analysisDetails\": \"<string>\",\n  \"effectiveRefundedAmountCents\": 123,\n  \"rejectionReason\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "amountCents": 123,
  "createdAt": "<string>",
  "endToEndId": "<string>",
  "id": "<string>",
  "reason": "<string>",
  "reportStatus": "<string>",
  "requestedByISPB": "<string>",
  "status": "<string>",
  "updatedAt": "<string>",
  "effectiveRefundedAmountCents": 123,
  "fundsRecoveryId": "<string>",
  "monitorAccount": true,
  "refundAccount": {
    "accountNumber": "<string>",
    "accountType": "<string>",
    "participant": "<string>",
    "taxIdNumber": "<string>",
    "branch": "<string>"
  }
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

string

requerido

Refund UUID

Cuerpo

application/json

closeRefund analysis body

analysisResult

string

requerido

Refund analysis outcome: TOTALLY_ACCEPTED, PARTIALLY_ACCEPTED, or REJECTED

Ejemplo:

"TOTALLY_ACCEPTED"

analysisDetails

string

Optional free-text analysis details

effectiveRefundedAmountCents

integer<int64> | null

Effective refunded amount in cents; mandatory when analysisResult is TOTALLY_ACCEPTED or PARTIALLY_ACCEPTED

rejectionReason

string

BACEN rejection reason; mandatory when analysisResult is REJECTED, omit when accepted

Respuesta

Persisted local DICT refund request record

amountCents

integer<int64>

requerido

Refund amount in integer minor units (BRL centavos)

Ejemplo:

150000

createdAt

string

requerido

Record creation timestamp (RFC 3339, UTC)

Ejemplo:

"2026-06-14T12:00:00Z"

endToEndId

string

requerido

BACEN end-to-end identifier (E2E ID) of the refunded PIX transaction

Ejemplo:

"E1234567820260614ABCDEFGHIJKLMNO"

string

requerido

Server-assigned refund record UUID

Ejemplo:

"550e8400-e29b-41d4-a716-446655440001"

reason

string

requerido

Free-text justification for the refund request

reportStatus

string

requerido

BACEN report delivery state: PENDING, SENT, or FAILED (FAILED is retryable; the local record stands)

Ejemplo:

"SENT"

requestedByISPB

string

requerido

ISPB (8 numeric digits) of the participant that requested the refund

Ejemplo:

"12345678"

status

string

requerido

Local refund lifecycle state: REQUESTED, ACCEPTED, REJECTED, SETTLED, or CANCELLED

Ejemplo:

"REQUESTED"

updatedAt

string

requerido

Last update timestamp (RFC 3339, UTC)

Ejemplo:

"2026-06-14T12:00:00Z"

effectiveRefundedAmountCents

integer<int64>

MED 2.0: effective refunded amount in cents recorded on an accepting close (verbatim); omitted until close

Ejemplo:

75000

fundsRecoveryId

string

Local funds-recovery id this refund is bound to (refund-under-recovery); omitted for a standalone refund

Ejemplo:

"550e8400-e29b-41d4-a716-446655440003"

monitorAccount

boolean

MED 2.0: whether the destination account is monitored

Ejemplo:

true

refundAccount

object

MED 2.0: destination account of a refund-under-recovery; omitted for a standalone refund

Show child attributes

⌘I

Pix — Lerian SPI (mensajería nativa)

Pix — JD (interfaz, directo)

Pix — BTG (interfaz, indirecto)

TED — Lerian SPB (mensajería nativa)

TED — JD (interfaz)

Boletos — BTG (interfaz)

Lerian SILOC (mensajería nativa)

Lerian SLC (mensajería nativa)

Lerian STA (mensajería nativa)

Lerian SISBAJUD (mensajería nativa)

Lerian Consignado (mensajería nativa)

Cerrar devolución DICT

Autorizaciones

Parámetros de ruta

Cuerpo

Respuesta