Create DICT funds recovery

curl --request POST \
  --url https://spi.sandbox.lerian.net/api/v1/dict/funds-recoveries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "participantISPB": "12345678",
  "rootTransactionId": "E12345678202607101200B3C4D5E6F7A",
  "situationType": "SCAM",
  "reportDetails": "<string>"
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"participantISPB\": \"12345678\",\n  \"rootTransactionId\": \"E12345678202607101200B3C4D5E6F7A\",\n  \"situationType\": \"SCAM\",\n  \"reportDetails\": \"<string>\"\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({
    participantISPB: '12345678',
    rootTransactionId: 'E12345678202607101200B3C4D5E6F7A',
    situationType: 'SCAM',
    reportDetails: '<string>'
  })
};

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"

payload = {
    "participantISPB": "12345678",
    "rootTransactionId": "E12345678202607101200B3C4D5E6F7A",
    "situationType": "SCAM",
    "reportDetails": "<string>"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "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",
  "operationId": "01930000-0000-7000-8000-000000000000",
  "operationStatus": "UNKNOWN_OUTCOME",
  "originOperationId": "01930000-0000-7000-8000-000000000000",
  "refundDeadlineAt": "2026-06-17T12:00:00Z",
  "reportDetails": "<string>"
}

{
  "operationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "operationStatus": "RESERVED"
}

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

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

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

POST

api

dict

funds-recoveries

Create DICT funds recovery

curl --request POST \
  --url https://spi.sandbox.lerian.net/api/v1/dict/funds-recoveries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "participantISPB": "12345678",
  "rootTransactionId": "E12345678202607101200B3C4D5E6F7A",
  "situationType": "SCAM",
  "reportDetails": "<string>"
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"participantISPB\": \"12345678\",\n  \"rootTransactionId\": \"E12345678202607101200B3C4D5E6F7A\",\n  \"situationType\": \"SCAM\",\n  \"reportDetails\": \"<string>\"\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({
    participantISPB: '12345678',
    rootTransactionId: 'E12345678202607101200B3C4D5E6F7A',
    situationType: 'SCAM',
    reportDetails: '<string>'
  })
};

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"

payload = {
    "participantISPB": "12345678",
    "rootTransactionId": "E12345678202607101200B3C4D5E6F7A",
    "situationType": "SCAM",
    "reportDetails": "<string>"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "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",
  "operationId": "01930000-0000-7000-8000-000000000000",
  "operationStatus": "UNKNOWN_OUTCOME",
  "originOperationId": "01930000-0000-7000-8000-000000000000",
  "refundDeadlineAt": "2026-06-17T12:00:00Z",
  "reportDetails": "<string>"
}

{
  "operationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "operationStatus": "RESERVED"
}

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

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

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

Headers

X-Idempotency

string

required

Required key used to prevent replaying the mutation.

Body

application/json

DICT MED 2.0 funds-recovery (createFundsRecovery) reported to BACEN first; only a CONFIRMED report is persisted locally — a rejection or ambiguous outcome creates no local row. Tracked by a durable operation intent (operationId) while pending.

participantISPB

string

required

ISPB (8 numeric digits) of the participant reporting the funds recovery; gated to the calling direct's scope

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

Example:

"12345678"

rootTransactionId

string

required

Identifier of the transaction being contested: the EndToEndID of the originating fraudulent payment (pacs.008, E-prefixed), or the RtrId of the return operation being contested (pacs.004, D-prefixed — DICT 8.4 §20.1.9, contestação de transação de devolução, where the contested return becomes the root transaction). Shaped as BACEN's InstrId2Type, message-type letter upper case. BACEN dedups a recovery per RootTransactionId

Pattern: ^[ED][0-9]{20}[a-zA-Z0-9]{11}$

Example:

"E12345678202607101200B3C4D5E6F7A"

situationType

enum<string>

required

MED 2.0 situation classification: SCAM, ACCOUNT_TAKEOVER, COERCION, FRAUDULENT_ACCESS, OTHER, or UNKNOWN

Available options:

SCAM,

ACCOUNT_TAKEOVER,

COERCION,

FRAUDULENT_ACCESS,

OTHER,

UNKNOWN

Example:

"SCAM"

reportDetails

string

Details helping the counterparty PSP analyse the case; mandatory when situationType is OTHER, optional otherwise (max 2000 characters). The regulator contact travels with it, read from the participant registry.

Maximum string length: 2000

Response

Created

Persisted local DICT funds-recovery record, or {operationId, operationStatus} while BACEN's outcome is pending (202).

createdAt

string

required

Record creation timestamp (RFC 3339, UTC)

Example:

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

string

required

BACEN-assigned funds-recovery resource UUID — the public, canonical identity of this record

Example:

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

reportStatus

string

required

BACEN report delivery state. Always SENT at rest (a resource row is persisted only once BACEN has confirmed it; a rejected or ambiguous attempt creates no row).

Example:

"SENT"

reporterParticipant

string

required

ISPB of the participant that reported this funds recovery — our own configured value, the same one createFundsRecovery sends as Participant. This is a LOCAL value, distinct from bacenReporterParticipant below.

Example:

"12345678"

rootTransactionId

string

required

Identifier of the contested transaction: the originating fraudulent payment's EndToEndID (pacs.008, E-prefixed) or the contested return operation's RtrId (pacs.004, D-prefixed — a contestação de transação de devolução), projected verbatim

Example:

"E12345678202607101200B3C4D5E6F7A"

situationType

string

required

MED 2.0 situation classification

Example:

"SCAM"

status

string

required

Local funds-recovery lifecycle state: CREATED, TRACKED, AWAITING_ANALYSIS, ANALYSED, REFUNDING, COMPLETED, or CANCELLED. This is a LOCAL view: TRACKED is representable but this rail has no producer for it, so it never appears in practice.

Example:

"CREATED"

updatedAt

string

required

Last update timestamp (RFC 3339, UTC)

Example:

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

analysisAcceptedAt

string

When the analysis step was observed to complete — the instant the 72-hour refund window opens (RFC 3339, UTC). Absent until observed. When no BACEN snapshot stated the transition, this is the DICT's notification-creation instant instead: an upper bound on it, so the window shown here never closes earlier than the one the DICT counts.

Example:

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

bacen

object

BACEN's own operational envelope for its most recent interaction on this funds recovery, including its LastModified version; omitted when no BACEN interaction has ever landed on it.

Show child attributes

bacenCreationTime

string

When BACEN created this funds recovery (RFC 3339, UTC); distinct from createdAt

Example:

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

bacenReporterParticipant

string

BACEN-assigned reporter participant ISPB (ExtendedFundsRecovery.ReporterParticipant); empty until BACEN answers

Example:

"12345678"

completion

enum<string>

Why a COMPLETED recovery completed: REFUNDED (the refund step was observed to start), REFUND_DEADLINE_LAPSED (no refund step was observed and the DICT concluded it at or after the 72 hours), or UNKNOWN (nothing observed here explains it — the analysis step was never seen, or the DICT concluded it before the deadline, which a refund impossibility, an all-rejected notification set, an unobserved refund and a lapse concluded just inside a window anchored on the DICT's notification-creation instant all explain equally). Absent while the recovery is not COMPLETED.

Available options:

REFUNDED,

REFUND_DEADLINE_LAPSED,

UNKNOWN

Example:

"REFUNDED"

contactInformation

object

BACEN-echoed regulator-facing contact

Show child attributes

flowType

string

ExtendedFundsRecovery.FlowType, verbatim (BACEN's spec defines only AUTOMATED); not actionable

Example:

"AUTOMATED"

operationId

string

Durable MED operation-intent id: the operation that produced this resource's current state. Present on both a synchronous 200/201 and a pending 202.

Example:

"01930000-0000-7000-8000-000000000000"

operationStatus

enum<string>

Durable operation-intent status. Always COMPLETED on a synchronous 200/201; on a pending 202 it is never REJECTED or LOCAL_FAILURE — both are BACEN-final/local-final outcomes mapped to their own HTTP status instead of a 202.

Available options:

RESERVED,

SUBMITTED,

CONFIRMED,

SYNC_PENDING,

UNKNOWN_OUTCOME,

MANUAL_REVIEW,

COMPLETED

Example:

"UNKNOWN_OUTCOME"

originOperationId

string

Durable operation-intent id that produced this snapshot's current state, when known

Example:

"01930000-0000-7000-8000-000000000000"

refundDeadlineAt

string

When the 72-hour window to start the refund step closes (RFC 3339, UTC); the DICT concludes the recovery itself after it. Absent until the analysis step has been observed.

Example:

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

reportDetails

string

Details for the counterparty PSP's analysis; present when the situation type carries one