List DICT funds recoveries

curl --request GET \
  --url https://spi.sandbox.lerian.net/api/v1/dict/funds-recoveries \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

	url := "https://spi.sandbox.lerian.net/api/v1/dict/funds-recoveries"

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

	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: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://spi.sandbox.lerian.net/api/v1/dict/funds-recoveries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://spi.sandbox.lerian.net/api/v1/dict/funds-recoveries"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

{
  "items": [
    {
      "createdAt": "2026-06-14T12:00:00Z",
      "id": "550e8400-e29b-41d4-a716-446655440003",
      "reportStatus": "SENT",
      "reporterParticipant": "12345678",
      "rootTransactionId": "E12345678202607101200B3C4D5E6F7A",
      "situationType": "SCAM",
      "status": "CREATED",
      "updatedAt": "2026-06-14T12:00:00Z",
      "analysisAcceptedAt": "2026-06-14T12:00:00Z",
      "bacen": {
        "correlationId": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
        "lastModified": "2026-06-14T12:00:00Z",
        "responseTime": "2026-06-14T12:00:00Z"
      },
      "bacenCreationTime": "2026-06-14T12:00:00Z",
      "bacenReporterParticipant": "12345678",
      "completion": "REFUNDED",
      "contactInformation": {
        "email": "compliance@participant.example",
        "phone": "+5511999999999"
      },
      "flowType": "AUTOMATED",
      "originOperationId": "01930000-0000-7000-8000-000000000000",
      "refundDeadlineAt": "2026-06-17T12:00:00Z",
      "reportDetails": "<string>"
    }
  ],
  "limit": 123,
  "offset": 123,
  "requestId": "<string>"
}

{
  "correlationId": "req-7a3f9c2e",
  "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"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "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"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "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"
  }
}

GET

api

dict

funds-recoveries

List DICT funds recoveries

curl --request GET \
  --url https://spi.sandbox.lerian.net/api/v1/dict/funds-recoveries \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

	url := "https://spi.sandbox.lerian.net/api/v1/dict/funds-recoveries"

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

	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: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://spi.sandbox.lerian.net/api/v1/dict/funds-recoveries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://spi.sandbox.lerian.net/api/v1/dict/funds-recoveries"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

{
  "items": [
    {
      "createdAt": "2026-06-14T12:00:00Z",
      "id": "550e8400-e29b-41d4-a716-446655440003",
      "reportStatus": "SENT",
      "reporterParticipant": "12345678",
      "rootTransactionId": "E12345678202607101200B3C4D5E6F7A",
      "situationType": "SCAM",
      "status": "CREATED",
      "updatedAt": "2026-06-14T12:00:00Z",
      "analysisAcceptedAt": "2026-06-14T12:00:00Z",
      "bacen": {
        "correlationId": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
        "lastModified": "2026-06-14T12:00:00Z",
        "responseTime": "2026-06-14T12:00:00Z"
      },
      "bacenCreationTime": "2026-06-14T12:00:00Z",
      "bacenReporterParticipant": "12345678",
      "completion": "REFUNDED",
      "contactInformation": {
        "email": "compliance@participant.example",
        "phone": "+5511999999999"
      },
      "flowType": "AUTOMATED",
      "originOperationId": "01930000-0000-7000-8000-000000000000",
      "refundDeadlineAt": "2026-06-17T12:00:00Z",
      "reportDetails": "<string>"
    }
  ],
  "limit": 123,
  "offset": 123,
  "requestId": "<string>"
}

{
  "correlationId": "req-7a3f9c2e",
  "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"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "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"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "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.

Query Parameters

limit

integer<int64>

default:25

Page size (default 25, max 100)

Required range: 1 <= x <= 100

offset

integer<int64>

default:0

Page offset (default 0)

Required range: x >= 0

refundDeadlineBefore

string<date-time>

Narrows the page to the DICT 8.4 §20.1.6 open refund work whose 72-hour deadline (refundDeadlineAt) falls at or before this instant — still ANALYSED, refund step never observed — ordered most-overdue-first instead of newest-first. Pass the current instant for the recoveries already expired. Omit both deadline bounds for the unfiltered newest-first page.

Example:

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

refundDeadlineAfter

string<date-time>

Lower bound of the same §20.1.6 refund-deadline window: drops recoveries whose deadline is at or before this instant. Combine with refundDeadlineBefore to page exactly one alarm gauge's rows — refundDeadlineAfter=&refundDeadlineBefore=<now+horizon> is the due-soon set alone, where an upper bound by itself returns every already-expired recovery first and can push the actionable rows off the page.

Example:

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

Response

items

object[]

required

Local DICT funds-recovery records for the requested limit/offset window.

Show child attributes

limit

integer<int64>

required

Effective page size applied to this response.

offset

integer<int64>

required

Zero-based offset of the first item in this page.

requestId

string

Request-scoped identifier echoing X-Request-ID, for pivoting from response to trace. This is OUR OWN echo, distinct from any item's bacen.correlationId, which is BACEN's own value.