Skip to main content
POST
/
v1
/
dict
/
funds-recoveries
Create a Funds Recovery Request
curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/v1/dict/funds-recoveries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contactInformation": {
    "email": "customer@example.com",
    "phone": "+5511999999999"
  },
  "rootTransactionId": "E12345678202411241430ABCDEFGHIJK",
  "situationType": "SCAM",
  "reportDetails": "Customer reported receiving a call from fake bank employee",
  "trackingGraphParameters": {
    "hopWindow": "PT24H",
    "maxHops": 5,
    "maxTransactions": 500,
    "minTransactionAmount": "200.00"
  }
}
'
{
  "bacenFundsRecoveryId": "91d65e98-97c0-4b0f-b577-73625da1f9fc",
  "contactInformation": {
    "email": "customer@example.com",
    "phone": "+5511999999999"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "reportDetails": "Customer reported receiving a call from fake bank employee",
  "reporterParticipant": "12345678",
  "rootTransactionId": "E12345678202411241430ABCDEFGHIJK",
  "situationType": "SCAM",
  "status": "CREATED",
  "trackingGraph": {
    "accounts": [
      {
        "id": 1,
        "openingDate": "2020-01-15",
        "ownerId": 1,
        "participant": "12345678"
      }
    ],
    "creationTime": "2023-11-07T05:31:56Z",
    "fundsRecoveryId": "550e8400-e29b-41d4-a716-446655440000",
    "parameters": {
      "hopWindow": "PT24H",
      "maxHops": 5,
      "maxTransactions": 500,
      "minTransactionAmount": "200.00"
    },
    "persons": [
      {
        "entityCreationDate": "2020-01-15",
        "id": 1,
        "type": "NATURAL_PERSON"
      }
    ],
    "rootTransactionId": "E12345678202411241430ABCDEFGHIJK",
    "transactions": [
      {
        "amount": 1000.5,
        "creditorAccountId": 2,
        "debtorAccountId": 1,
        "id": "E12345678202411241430ABCDEFGHIJK",
        "refundableAmount": 1000.5,
        "settlementTime": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
contactInformation
object
required

ContactInformation contains the contact information of the person reporting the fraud

​
rootTransactionId
string
required

RootTransactionID is the original Pix End-to-End transaction ID

Example:

"E12345678202411241430ABCDEFGHIJK"

​
situationType
enum<string>
required

SituationType is the type of fraud situation

Available options:
SCAM,
ACCOUNT_TAKEOVER,
COERCION,
FRAUDULENT_ACCESS,
OTHER,
UNKNOWN
Example:

"SCAM"

​
reportDetails
string

ReportDetails is the detailed description of the fraud incident

Maximum string length: 2000
Example:

"Customer reported receiving a call from fake bank employee"

​
trackingGraphParameters
object

TrackingGraphParameters contains optional parameters for tracking graph generation

Response

Created

​
bacenFundsRecoveryId
string
Example:

"91d65e98-97c0-4b0f-b577-73625da1f9fc"

​
contactInformation
object
​
createdAt
string<date-time>
Example:

"2023-11-07T05:31:56Z"

​
id
string
Example:

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

​
reportDetails
string
Example:

"Customer reported receiving a call from fake bank employee"

​
reporterParticipant
string
Example:

"12345678"

​
rootTransactionId
string
Example:

"E12345678202411241430ABCDEFGHIJK"

​
situationType
enum<string>
Available options:
SCAM,
ACCOUNT_TAKEOVER,
COERCION,
FRAUDULENT_ACCESS,
OTHER,
UNKNOWN
Example:

"SCAM"

​
status
enum<string>
Available options:
CREATED,
TRACKED,
AWAITING_ANALYSIS,
ANALYSED,
REFUNDING,
COMPLETED,
CANCELLED
Example:

"CREATED"

​
trackingGraph
object

TrackingGraph is the tracking graph generated during creation (PRD 4.1 / US-01) Present when trackingGraphParameters were provided in the request

​
updatedAt
string<date-time>
Example:

"2023-11-07T05:31:56Z"