Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Funds recovery

Create funds recovery [beta]

Creates and establishes a new funds recovery to track and block diverted funds in Pix fraud cases.

The tracking follows the chain of subsequent transactions starting from the original fraudulent transaction.

Automated flow

DICT manages the entire process automatically. You only define the initial parameters and the system executes tracking, prioritization, and blocking. Use for: Standard cases, high volume of recoveries, or when you trust DICT's default algorithm.

Notes:

  • Fraudulent transactions must have occurred less than 80 days ago
  • Only the debtor participant (payer) can create funds recovery
  • Recipient PSPs have 7 calendar days to analyze infraction notifications
  • Refund must be initiated within 72 hours after analysis completion
  • Once refunding starts, the process cannot be cancelled

Thie endpoint generates a Pix funds recovery status changed event.

For more information refer to Pix funds recovery.

post/v1/pix/funds-recoveries

Request body

root_transaction_idstring required

Fraudulent transaction end-to-end-id

situation_type'SCAM' | 'ACCOUNT_TAKEOVER' | 'COERCION' | 'FRAUDULENT_ACCESS' | 'OTHER' | 'UNKNOWN' required

Situation type:

  • SCAM - Scam/fraud through social engineering
  • ACCOUNT_TAKEOVER - Unauthorized transaction without digital authentication
  • COERCION - Coercion crime (kidnapping, extortion)
  • FRAUDULENT_ACCESS - Fraudulent access and authorization (phishing, stolen password) |
  • OTHER - Other cases. This option REQUIRES you pass report_details.
  • UNKNOWN - Unknown state
report_detailsstring

Details about report

Example request

{
  "root_transaction_id": "E1234567890123456789012345678901",
  "contact_information": {
    "phone": "551154874551",
    "email": "polly_ester@email.com"
  },
  "report_details": "Details that can help the receiving participant to analyze the suspected violation",
  "tracking_graph_parameters": {
    "hop_window": "PT2H"
  }
}

Response

Created - synchronous success

idstring

Funds recovery identifier.

Returned from the Create funds recovery endpoint.

status'CREATED' | 'AWAITING_ANALYSIS' | 'TRACKED' | 'ANALYSED' | 'REFUNDING' | 'COMPLETED' | 'CANCELLED'

Funds recovery status:

  • CREATED - For INTERACTIVE
  • AWAITING_ANALYSIS - For AUTOMATED when processed synchronously
  • CREATED - Recovery created, awaiting next action. Both flows.
  • TRACKED - Tracking graph created. INTERACTIVE only
  • AWAITING_ANALYSIS - Awaiting analysis from receiver PSPs (deadline: 7 days). Both flows.
  • ANALYSED - Analysis completed, ready for refund. Both flows
  • REFUNDING - Refund process in progress. Both flows.
  • COMPLETED - Recovery successfully completed. Both flows.
  • CANCELLED - Recovery cancelled. Both flows.
root_transaction_idstring

Fraudulent transaction end-to-end-id

situation_type'SCAM' | 'ACCOUNT_TAKEOVER' | 'COERCION' | 'FRAUDULENT_ACCESS' | 'OTHER' | 'UNKNOWN'

Situation type:

  • SCAM - Scam/fraud through social engineering
  • ACCOUNT_TAKEOVER - Unauthorized transaction without digital authentication
  • COERCION - Coercion crime (kidnapping, extortion)
  • FRAUDULENT_ACCESS - Fraudulent access and authorization (phishing, stolen password) |
  • OTHER - Other cases. This option REQUIRES you pass report_details.
  • UNKNOWN - Unknown state
reporter_participantstring

Reporter participant ID

report_detailsstring

Details about report

created_atstring date-time

Creation datetime. A RFC 3339 date-time value. For example - 2023-04-12T23:20:50.52Z.

updated_atstring date-time

Updated datetime. A RFC 3339 date-time value. For example - 2023-04-12T23:20:50.52Z.

Example response

{
  "id": "53D0F66A-BAB0-49D7-B7DC-807B82AABD8D",
  "status": "CREATED",
  "root_transaction_id": "E1234567890123456789012345678901",
  "reporter_participant": "12345678",
  "contact_information": {
    "phone": "551154874551",
    "email": "polly_ester@email.com"
  },
  "report_details": "Details that can help the receiving participant to analyze the suspected violation",
  "created_at": "2020-08-13T13:49:03Z",
  "updated_at": "2020-08-13T13:49:03Z"
}