List FundsRecovery records

Lists PIX MED FundsRecovery records for the local PSP participant. Results are scoped to records where the local PSP is the reporter. Optional filters: status, modifiedAfter. Bacen citation: DICT API v2.10.1 §4.2.4 (mgmt/bacen-docs/med/Guia_MED.pdf, SHA256:d9daabc5).

Query Parameters
  • status
    Type: string enum

    Filter by FundsRecovery lifecycle status.

    values
    • CREATED
    • TRACKED
    • AWAITING_ANALYSIS
    • ANALYSED
    • REFUNDING
    • COMPLETED
    • CANCELLED
  • modifiedAfter
    Type: string Format: date-time

    Return only records modified after this ISO-8601 timestamp (UTC).

  • modifiedBefore
    Type: string Format: date-time

    Return only records modified before this ISO-8601 timestamp (UTC). Cursor anchor for stable page-by-page iteration — pass the earliest lastModified from the previous page to fetch the next.

  • limit
    Type: string

    Maximum number of results to return. Min: 1. Max: 1000 (Bacen limit).

Responses
  • application/json
  • application/json
  • application/json
Request Example for get/api/v1/funds-recovery
curl http://localhost:8080/api/v1/funds-recovery \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "transactionId": "string",
    "status": "CREATED",
    "participantIspb": "string",
    "situationType": "SCAM",
    "reportDetails": null,
    "contactEmail": null,
    "contactPhone": null,
    "trackingParameters": {
      "minTransactionAmount": 0.01,
      "maxTransactions": 1,
      "hopWindow": "PT24H",
      "maxHops": 1
    },
    "effectiveRefundedAmount": null,
    "createdAt": "2026-07-29T19:28:46.547Z",
    "lastModified": "2026-07-29T19:28:46.547Z"
  }
]