Skip to main content
POST
Create a Funds Recovery Request

Autorizações

Authorization
string
header
obrigatório

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

Corpo

application/json
contactInformation
object
obrigatório

ContactInformation contains the contact information of the person reporting the fraud

rootTransactionId
string
obrigatório

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

Exemplo:

"E12345678202411241430ABCDEFGHIJK"

situationType
enum<string>
obrigatório

SituationType is the type of fraud situation

Opções disponíveis:
SCAM,
ACCOUNT_TAKEOVER,
COERCION,
FRAUDULENT_ACCESS,
OTHER,
UNKNOWN
Exemplo:

"SCAM"

reportDetails
string

ReportDetails is the detailed description of the fraud incident

Maximum string length: 2000
Exemplo:

"Customer reported receiving a call from fake bank employee"

trackingGraphParameters
object

TrackingGraphParameters contains optional parameters for tracking graph generation

Resposta

Created

bacenFundsRecoveryId
string
Exemplo:

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

contactInformation
object
createdAt
string<date-time>
Exemplo:

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

id
string
Exemplo:

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

reportDetails
string
Exemplo:

"Customer reported receiving a call from fake bank employee"

reporterParticipant
string
Exemplo:

"12345678"

rootTransactionId
string
Exemplo:

"E12345678202411241430ABCDEFGHIJK"

situationType
enum<string>
Opções disponíveis:
SCAM,
ACCOUNT_TAKEOVER,
COERCION,
FRAUDULENT_ACCESS,
OTHER,
UNKNOWN
Exemplo:

"SCAM"

status
enum<string>
Opções disponíveis:
CREATED,
TRACKED,
AWAITING_ANALYSIS,
ANALYSED,
REFUNDING,
COMPLETED,
CANCELLED
Exemplo:

"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>
Exemplo:

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