Cancel a Funds Recovery Request

Use this endpoint to cancel a funds recovery request. Cancellation is allowed before refund has been initiated (CREATED, TRACKED, AWAITING_ANALYSIS, or ANALYSED status).

Notes:

• Cancelled requests cannot be reopened or modified
• Cancellation is not allowed for requests in REFUNDING, COMPLETED, or CANCELLED status

POST /v1/dict/funds-recoveries/{funds_recovery_id}/cancel

Cancel a Funds Recovery Request

cURL

curl --request POST \
  --url https://api.example.com/v1/dict/funds-recoveries/{funds_recovery_id}/cancel \
  --header 'Authorization: Bearer <token>'

200

{
  "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": "[e-mail]",
    "phone": "[phone]"
  },
  "reportDetails": "Customer reported receiving a call from fake bank employee"
}

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)

Respuesta

200

application/json

OK

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"

id · 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"