Update a Funds Recovery Request

curl --request PATCH \
  --url https://api.example.com/v1/dict/funds-recoveries/{funds_recovery_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contactInformation": {
    "email": "customer@example.com",
    "phone": "+5511999999999"
  },
  "situationType": "SCAM",
  "reportDetails": "Updated details about the fraud incident"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/dict/funds-recoveries/{funds_recovery_id}"

	payload := strings.NewReader("{\n  \"contactInformation\": {\n    \"email\": \"customer@example.com\",\n    \"phone\": \"+5511999999999\"\n  },\n  \"situationType\": \"SCAM\",\n  \"reportDetails\": \"Updated details about the fraud incident\"\n}")

	req, _ := http.NewRequest("PATCH", 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))

}

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    contactInformation: {email: 'customer@example.com', phone: '+5511999999999'},
    situationType: 'SCAM',
    reportDetails: 'Updated details about the fraud incident'
  })
};

fetch('https://api.example.com/v1/dict/funds-recoveries/{funds_recovery_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/dict/funds-recoveries/{funds_recovery_id}"

payload = {
    "contactInformation": {
        "email": "customer@example.com",
        "phone": "+5511999999999"
    },
    "situationType": "SCAM",
    "reportDetails": "Updated details about the fraud incident"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "bacenFundsRecoveryId": "91d65e98-97c0-4b0f-b577-73625da1f9fc",
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "reporterParticipant": "12345678",
  "rootTransactionId": "E12345678202411241430ABCDEFGHIJK",
  "situationType": "SCAM",
  "status": "CREATED",
  "updatedAt": "2023-11-07T05:31:56Z",
  "contactInformation": {
    "email": "customer@example.com",
    "phone": "+5511999999999"
  },
  "reportDetails": "Customer reported receiving a call from fake bank employee"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

PATCH

dict

funds-recoveries

{funds_recovery_id}

Update a Funds Recovery Request

curl --request PATCH \
  --url https://api.example.com/v1/dict/funds-recoveries/{funds_recovery_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contactInformation": {
    "email": "customer@example.com",
    "phone": "+5511999999999"
  },
  "situationType": "SCAM",
  "reportDetails": "Updated details about the fraud incident"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/dict/funds-recoveries/{funds_recovery_id}"

	payload := strings.NewReader("{\n  \"contactInformation\": {\n    \"email\": \"customer@example.com\",\n    \"phone\": \"+5511999999999\"\n  },\n  \"situationType\": \"SCAM\",\n  \"reportDetails\": \"Updated details about the fraud incident\"\n}")

	req, _ := http.NewRequest("PATCH", 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))

}

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    contactInformation: {email: 'customer@example.com', phone: '+5511999999999'},
    situationType: 'SCAM',
    reportDetails: 'Updated details about the fraud incident'
  })
};

fetch('https://api.example.com/v1/dict/funds-recoveries/{funds_recovery_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/dict/funds-recoveries/{funds_recovery_id}"

payload = {
    "contactInformation": {
        "email": "customer@example.com",
        "phone": "+5511999999999"
    },
    "situationType": "SCAM",
    "reportDetails": "Updated details about the fraud incident"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "bacenFundsRecoveryId": "91d65e98-97c0-4b0f-b577-73625da1f9fc",
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "reporterParticipant": "12345678",
  "rootTransactionId": "E12345678202411241430ABCDEFGHIJK",
  "situationType": "SCAM",
  "status": "CREATED",
  "updatedAt": "2023-11-07T05:31:56Z",
  "contactInformation": {
    "email": "customer@example.com",
    "phone": "+5511999999999"
  },
  "reportDetails": "Customer reported receiving a call from fake bank employee"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Account-Id

string<uuid>

Account ID (UUID) from X-Account-Id header

Parámetros de ruta

funds_recovery_id

string<uuid>

requerido

Funds Recovery ID (UUID format)

Cuerpo

application/json

contactInformation

object

requerido

Contact information of the person reporting the fraud

Show child attributes

situationType

enum<string>

requerido

Type of fraud situation

Opciones disponibles:

SCAM,

ACCOUNT_TAKEOVER,

COERCION,

FRAUDULENT_ACCESS,

OTHER,

UNKNOWN

Minimum string length: 1

Ejemplo:

"SCAM"

reportDetails

string

Detailed description of the fraud incident (max 2000 characters)

Maximum string length: 2000

Ejemplo:

"Updated details about the fraud incident"

Respuesta

bacenFundsRecoveryId

string

requerido

BACEN/BTG funds recovery external identifier

Ejemplo:

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

createdAt

string<date-time>

requerido

Creation timestamp (ISO 8601 UTC)

Ejemplo:

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

string

requerido

Unique identifier for the funds recovery (UUID)

Ejemplo:

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

reporterParticipant

string

requerido

ISPB of the PSP reporting the fraud (8 uppercase alphanumeric characters)

Ejemplo:

"12345678"

rootTransactionId

string

requerido

Pix End-to-End transaction ID (32 characters)

Ejemplo:

"E12345678202411241430ABCDEFGHIJK"

situationType

enum<string>

requerido

Type of fraud situation

Opciones disponibles:

SCAM,

ACCOUNT_TAKEOVER,

COERCION,

FRAUDULENT_ACCESS,

OTHER,

UNKNOWN

Ejemplo:

"SCAM"

status

enum<string>

requerido

Current status of the funds recovery

Opciones disponibles:

CREATED,

TRACKED,

AWAITING_ANALYSIS,

ANALYSED,

REFUNDING,

COMPLETED,

CANCELLED

Ejemplo:

"CREATED"

updatedAt

string<date-time>

requerido

Last update timestamp (ISO 8601 UTC)

Ejemplo:

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

contactInformation

object

Contact information of the person reporting the fraud

Show child attributes

reportDetails

string

Detailed description of the fraud incident

Ejemplo:

"Customer reported receiving a call from fake bank employee"

API de DICT

API de Reclamaciones

MED · Infracciones

MED · Marcadores de fraude

MED · Solicitudes de devolución

MED · Estadísticas

API de Transacciones

API de Códigos QR

API de Cobros

API de Recuperación de Fondos

API de Conciliación

API de Pix Automático

API de Programaciones

API de Informes de Transacción

Tiempos de transacciones

API de Webhooks

Manejo de errores

Eventos

Update a Funds Recovery Request

Autorizaciones

Encabezados

Parámetros de ruta

Cuerpo

Respuesta