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"
}
}
'import requests
url = "https://plugin-pix-indirect.api.lerian.net/v1/dict/funds-recoveries"
payload = {
"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"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
}
})
};
fetch('https://plugin-pix-indirect.api.lerian.net/v1/dict/funds-recoveries', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://plugin-pix-indirect.api.lerian.net/v1/dict/funds-recoveries",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://plugin-pix-indirect.api.lerian.net/v1/dict/funds-recoveries"
payload := strings.NewReader("{\n \"contactInformation\": {\n \"email\": \"customer@example.com\",\n \"phone\": \"+5511999999999\"\n },\n \"rootTransactionId\": \"E12345678202411241430ABCDEFGHIJK\",\n \"situationType\": \"SCAM\",\n \"reportDetails\": \"Customer reported receiving a call from fake bank employee\",\n \"trackingGraphParameters\": {\n \"hopWindow\": \"PT24H\",\n \"maxHops\": 5,\n \"maxTransactions\": 500,\n \"minTransactionAmount\": \"200.00\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://plugin-pix-indirect.api.lerian.net/v1/dict/funds-recoveries")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contactInformation\": {\n \"email\": \"customer@example.com\",\n \"phone\": \"+5511999999999\"\n },\n \"rootTransactionId\": \"E12345678202411241430ABCDEFGHIJK\",\n \"situationType\": \"SCAM\",\n \"reportDetails\": \"Customer reported receiving a call from fake bank employee\",\n \"trackingGraphParameters\": {\n \"hopWindow\": \"PT24H\",\n \"maxHops\": 5,\n \"maxTransactions\": 500,\n \"minTransactionAmount\": \"200.00\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://plugin-pix-indirect.api.lerian.net/v1/dict/funds-recoveries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contactInformation\": {\n \"email\": \"customer@example.com\",\n \"phone\": \"+5511999999999\"\n },\n \"rootTransactionId\": \"E12345678202411241430ABCDEFGHIJK\",\n \"situationType\": \"SCAM\",\n \"reportDetails\": \"Customer reported receiving a call from fake bank employee\",\n \"trackingGraphParameters\": {\n \"hopWindow\": \"PT24H\",\n \"maxHops\": 5,\n \"maxTransactions\": 500,\n \"minTransactionAmount\": \"200.00\"\n }\n}"
response = http.request(request)
puts response.read_body{
"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"
}{
"code": "<string>",
"title": "<string>",
"message": "<string>"
}{
"code": "<string>",
"title": "<string>",
"message": "<string>"
}{
"code": "<string>",
"title": "<string>",
"message": "<string>"
}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
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"
}
}
'import requests
url = "https://plugin-pix-indirect.api.lerian.net/v1/dict/funds-recoveries"
payload = {
"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"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
}
})
};
fetch('https://plugin-pix-indirect.api.lerian.net/v1/dict/funds-recoveries', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://plugin-pix-indirect.api.lerian.net/v1/dict/funds-recoveries",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://plugin-pix-indirect.api.lerian.net/v1/dict/funds-recoveries"
payload := strings.NewReader("{\n \"contactInformation\": {\n \"email\": \"customer@example.com\",\n \"phone\": \"+5511999999999\"\n },\n \"rootTransactionId\": \"E12345678202411241430ABCDEFGHIJK\",\n \"situationType\": \"SCAM\",\n \"reportDetails\": \"Customer reported receiving a call from fake bank employee\",\n \"trackingGraphParameters\": {\n \"hopWindow\": \"PT24H\",\n \"maxHops\": 5,\n \"maxTransactions\": 500,\n \"minTransactionAmount\": \"200.00\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://plugin-pix-indirect.api.lerian.net/v1/dict/funds-recoveries")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contactInformation\": {\n \"email\": \"customer@example.com\",\n \"phone\": \"+5511999999999\"\n },\n \"rootTransactionId\": \"E12345678202411241430ABCDEFGHIJK\",\n \"situationType\": \"SCAM\",\n \"reportDetails\": \"Customer reported receiving a call from fake bank employee\",\n \"trackingGraphParameters\": {\n \"hopWindow\": \"PT24H\",\n \"maxHops\": 5,\n \"maxTransactions\": 500,\n \"minTransactionAmount\": \"200.00\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://plugin-pix-indirect.api.lerian.net/v1/dict/funds-recoveries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contactInformation\": {\n \"email\": \"customer@example.com\",\n \"phone\": \"+5511999999999\"\n },\n \"rootTransactionId\": \"E12345678202411241430ABCDEFGHIJK\",\n \"situationType\": \"SCAM\",\n \"reportDetails\": \"Customer reported receiving a call from fake bank employee\",\n \"trackingGraphParameters\": {\n \"hopWindow\": \"PT24H\",\n \"maxHops\": 5,\n \"maxTransactions\": 500,\n \"minTransactionAmount\": \"200.00\"\n }\n}"
response = http.request(request)
puts response.read_body{
"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"
}{
"code": "<string>",
"title": "<string>",
"message": "<string>"
}{
"code": "<string>",
"title": "<string>",
"message": "<string>"
}{
"code": "<string>",
"title": "<string>",
"message": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
ContactInformation contains the contact information of the person reporting the fraud
Show child attributes
Show child attributes
RootTransactionID is the original Pix End-to-End transaction ID
Example:
"E12345678202411241430ABCDEFGHIJK"
SituationType is the type of fraud situation
Available options:
SCAM, ACCOUNT_TAKEOVER, COERCION, FRAUDULENT_ACCESS, OTHER, UNKNOWN Example:
"SCAM"
ReportDetails is the detailed description of the fraud incident
Maximum string length:
2000Example:
"Customer reported receiving a call from fake bank employee"
TrackingGraphParameters contains optional parameters for tracking graph generation
Show child attributes
Show child attributes
Response
Created
Example:
"91d65e98-97c0-4b0f-b577-73625da1f9fc"
Show child attributes
Show child attributes
Example:
"2023-11-07T05:31:56Z"
Example:
"550e8400-e29b-41d4-a716-446655440000"
Example:
"Customer reported receiving a call from fake bank employee"
Example:
"12345678"
Example:
"E12345678202411241430ABCDEFGHIJK"
Available options:
SCAM, ACCOUNT_TAKEOVER, COERCION, FRAUDULENT_ACCESS, OTHER, UNKNOWN Example:
"SCAM"
Available options:
CREATED, TRACKED, AWAITING_ANALYSIS, ANALYSED, REFUNDING, COMPLETED, CANCELLED Example:
"CREATED"
TrackingGraph is the tracking graph generated during creation (PRD 4.1 / US-01) Present when trackingGraphParameters were provided in the request
Show child attributes
Show child attributes
Example:
"2023-11-07T05:31:56Z"
Was this page helpful?
⌘I