> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a Funds Recovery Request

> Use this endpoint to create a new funds recovery request for a Pix transaction suspected of fraud.

**Notes:**
- The rootTransactionId must be a valid 32-character Pix End-to-End ID
- situationType indicates the type of fraud situation (SCAM, ACCOUNT_TAKEOVER, COERCION, FRAUDULENT_ACCESS, OTHER, UNKNOWN)
- Contact information (email and phone) is required for communication during the recovery process



## OpenAPI

````yaml en/openapi/v3-current/indirect-pix.yaml POST /v1/dict/funds-recoveries
openapi: 3.0.3
info:
  title: Plugin BR Pix Indirect - Complete API
  description: |
    Complete API for Brazilian Pix instant payment system including
    Pix key dictionary operations, QR code generation/decoding, transactions and
    transaction limits.
  version: 1.0.0
servers:
  - url: https://plugin-pix-indirect.api.lerian.net
security:
  - bearerAuth: []
paths:
  /v1/dict/funds-recoveries:
    post:
      tags:
        - Funds Recovery API
      summary: Create a Funds Recovery Request
      description: >-
        Use this endpoint to create a new funds recovery request for a Pix
        transaction suspected of fraud.


        **Notes:**

        - The rootTransactionId must be a valid 32-character Pix End-to-End ID

        - situationType indicates the type of fraud situation (SCAM,
        ACCOUNT_TAKEOVER, COERCION, FRAUDULENT_ACCESS, OTHER, UNKNOWN)

        - Contact information (email and phone) is required for communication
        during the recovery process
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFundsRecoveryInput'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateFundsRecoveryOutput'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
      deprecated: false
      security:
        - bearerAuth: []
components:
  schemas:
    CreateFundsRecoveryInput:
      properties:
        contactInformation:
          allOf:
            - $ref: '#/components/schemas/ContactInformation'
          description: >-
            ContactInformation contains the contact information of the person
            reporting the fraud
        reportDetails:
          description: ReportDetails is the detailed description of the fraud incident
          example: Customer reported receiving a call from fake bank employee
          maxLength: 2000
          type: string
        rootTransactionId:
          description: RootTransactionID is the original Pix End-to-End transaction ID
          example: E12345678202411241430ABCDEFGHIJK
          type: string
        situationType:
          description: SituationType is the type of fraud situation
          enum:
            - SCAM
            - ACCOUNT_TAKEOVER
            - COERCION
            - FRAUDULENT_ACCESS
            - OTHER
            - UNKNOWN
          example: SCAM
          type: string
        trackingGraphParameters:
          allOf:
            - $ref: '#/components/schemas/TrackingGraphParametersInput'
          description: >-
            TrackingGraphParameters contains optional parameters for tracking
            graph generation
      required:
        - contactInformation
        - rootTransactionId
        - situationType
      type: object
    CreateFundsRecoveryOutput:
      properties:
        bacenFundsRecoveryId:
          example: 91d65e98-97c0-4b0f-b577-73625da1f9fc
          type: string
        contactInformation:
          $ref: '#/components/schemas/ContactInformation'
        createdAt:
          example: '2023-11-07T05:31:56Z'
          format: date-time
          type: string
        id:
          example: 550e8400-e29b-41d4-a716-446655440000
          type: string
        reportDetails:
          example: Customer reported receiving a call from fake bank employee
          type: string
        reporterParticipant:
          example: '12345678'
          type: string
        rootTransactionId:
          example: E12345678202411241430ABCDEFGHIJK
          type: string
        situationType:
          enum:
            - SCAM
            - ACCOUNT_TAKEOVER
            - COERCION
            - FRAUDULENT_ACCESS
            - OTHER
            - UNKNOWN
          example: SCAM
          type: string
        status:
          enum:
            - CREATED
            - TRACKED
            - AWAITING_ANALYSIS
            - ANALYSED
            - REFUNDING
            - COMPLETED
            - CANCELLED
          example: CREATED
          type: string
        trackingGraph:
          allOf:
            - $ref: '#/components/schemas/TrackingGraphOutput'
          description: >-
            TrackingGraph is the tracking graph generated during creation (PRD
            4.1 / US-01)

            Present when trackingGraphParameters were provided in the request
        updatedAt:
          example: '2023-11-07T05:31:56Z'
          format: date-time
          type: string
      type: object
    ErrorFormat:
      type: object
      description: The response message error.
      required:
        - code
        - title
        - message
      properties:
        code:
          type: string
          description: A unique, stable identifier for the error.
        title:
          type: string
          description: A brief summary of the issue.
        message:
          type: string
          description: Detailed guidance for resolving the error.
    ContactInformation:
      properties:
        email:
          description: Email is the email address of the customer reporting the fraud
          example: customer@example.com
          type: string
        phone:
          description: |-
            Phone is the phone number of the customer reporting the fraud
            Format: E.164 format recommended (e.g., +5511999999999)
          example: '+5511999999999'
          type: string
      required:
        - email
        - phone
      type: object
    TrackingGraphParametersInput:
      properties:
        hopWindow:
          example: PT24H
          type: string
        maxHops:
          example: 5
          type: integer
        maxTransactions:
          example: 500
          type: integer
        minTransactionAmount:
          example: '200.00'
          type: string
      type: object
    TrackingGraphOutput:
      properties:
        accounts:
          items:
            $ref: '#/components/schemas/TrackingGraphAccountOutput'
          type: array
        creationTime:
          example: '2023-11-07T05:31:56Z'
          format: date-time
          type: string
        fundsRecoveryId:
          example: 550e8400-e29b-41d4-a716-446655440000
          type: string
        parameters:
          $ref: '#/components/schemas/TrackingGraphParametersOutput'
        persons:
          items:
            $ref: '#/components/schemas/TrackingGraphPersonOutput'
          type: array
        rootTransactionId:
          example: E12345678202411241430ABCDEFGHIJK
          type: string
        transactions:
          items:
            $ref: '#/components/schemas/TrackingGraphTxOutput'
          type: array
      type: object
    TrackingGraphAccountOutput:
      properties:
        id:
          type: integer
          example: 1
        openingDate:
          example: '2020-01-15'
          type: string
        ownerId:
          type: integer
          example: 1
        participant:
          example: '12345678'
          type: string
      type: object
    TrackingGraphParametersOutput:
      properties:
        hopWindow:
          example: PT24H
          type: string
        maxHops:
          example: 5
          type: integer
        maxTransactions:
          example: 500
          type: integer
        minTransactionAmount:
          example: '200.00'
          type: string
      type: object
    TrackingGraphPersonOutput:
      properties:
        entityCreationDate:
          example: '2020-01-15'
          type: string
        id:
          type: integer
          example: 1
        type:
          example: NATURAL_PERSON
          type: string
      type: object
    TrackingGraphTxOutput:
      properties:
        amount:
          example: 1000.5
          type: number
        creditorAccountId:
          example: 2
          type: integer
        debtorAccountId:
          type: integer
          example: 1
        id:
          example: E12345678202411241430ABCDEFGHIJK
          type: string
        refundableAmount:
          example: 1000.5
          type: number
        settlementTime:
          example: '2023-11-07T05:31:56Z'
          type: string
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````