CreateFundsRecoveryRequest

Request body to create a new FundsRecovery record (Recuperação de Valores MED 2.0). Bacen-conformant per OpenAPI v2.10.1 FundsRecovery.required.

  • contactInformation
    Type: object · ContactInfo
    required

    Contact information for the fraud reporting team

    • email
      Type: string
      max length:  
      255

      Email address of the fraud reporting team

    • phone
      Type: string
      max length:  
      64

      Phone number of the fraud reporting team (E.164 format recommended)

  • situationType
    Type: string enum
    required

    Type of fraud/dispute situation (per Bacen DICT API v2.10.1 SituationType schema — shared across InfractionReport and FundsRecovery)

    values
    • SCAM
    • ACCOUNT_TAKEOVER
    • COERCION
    • FRAUDULENT_ACCESS
    • OTHER
    • UNKNOWN
  • transactionId
    Type: string
    min length:  
    1    Pattern: [A-Za-z0-9]{8,32}
    required

    End-to-end ID of the original PIX transaction subject to funds recovery (Bacen EndToEndId, alphanumeric, 8–32 chars)

  • reportDetails
    Type: string
    max length:  
    2000

    Free-text details about the fraud situation (max 2000 chars; required when situationType=OTHER)

  • trackingParameters
    Type: object | null · TrackingGraphParameters

    Tracking graph parameters used for forensic analysis; null when not provided

    • hopWindow
      Type: string Format: duration

      Time window around each transaction that DICT considers when linking graph edges. ISO-8601 duration. Optional (Bacen default: PT24H).

    • maxHops
      Type: integer Format: int32
      min:  
      1
      max:  
      10

      Maximum number of hops (graph depth) that DICT will traverse from the originating transaction. Limits depth of the fraud network analysis. Optional (Bacen default: 5; Bacen ceiling: 10 per OpenAPI v2.10.1 line 4748).

    • maxTransactions
      Type: integer Format: int32
      min:  
      1

      Maximum number of outgoing transactions per account node that DICT will follow. Caps graph traversal breadth to prevent analysis explosion on high-volume accounts. Optional (Bacen default: 500).

    • minTransactionAmount
      Type: number
      min:  
      0.01

      Minimum transaction amount (BRL) to include in the forensic graph traversal. Transactions below this value are excluded from the fraud network graph. Optional — Bacen applies its own floor when absent (default: 200.00).