Skip to main content
POST
Create a Funds Recovery Request

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Account-Id
string<uuid>

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

Body

application/json
contactInformation
object
required

Contact information of the person reporting the fraud

rootTransactionId
string
required

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

Minimum string length: 1
Example:

"E12345678202411241430ABCDEFGHIJK"

situationType
enum<string>
required

Type of fraud situation

Available options:
SCAM,
ACCOUNT_TAKEOVER,
COERCION,
FRAUDULENT_ACCESS,
OTHER,
UNKNOWN
Minimum string length: 1
Example:

"SCAM"

reportDetails
string

Detailed description of the fraud incident (max 2000 characters)

Maximum string length: 2000
Example:

"Customer reported receiving a call from fake bank employee"

trackingGraphParameters
object

Optional parameters for tracking graph generation

Response

Created

bacenFundsRecoveryId
string
required

BACEN/BTG funds recovery external identifier

Example:

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

createdAt
string<date-time>
required

Creation timestamp (ISO 8601 UTC)

Example:

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

id
string
required

Unique identifier for the funds recovery (UUID)

Example:

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

reporterParticipant
string
required

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

Example:

"12345678"

rootTransactionId
string
required

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

Example:

"E12345678202411241430ABCDEFGHIJK"

situationType
enum<string>
required

Type of fraud situation

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

"SCAM"

status
enum<string>
required

Current status of the funds recovery

Available options:
CREATED,
TRACKED,
AWAITING_ANALYSIS,
ANALYSED,
REFUNDING,
COMPLETED,
CANCELLED
Example:

"CREATED"

updatedAt
string<date-time>
required

Last update timestamp (ISO 8601 UTC)

Example:

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

contactInformation
object

Contact information of the person reporting the fraud

reportDetails
string

Detailed description of the fraud incident

Example:

"Customer reported receiving a call from fake bank employee"

trackingGraph
object

Tracking graph generated during creation (when trackingGraphParameters provided)