Retrieve Tracking Graph

Use this endpoint to retrieve the tracking graph for a funds recovery request. The tracking graph shows the flow of funds from the root transaction.

Notes:

• The query parameters min_transaction_amount, max_transactions, hop_window and max_hops are deprecated: accepted for compatibility and ignored, because BTG returns the graph built with the parameters used when the funds recovery was created
• The graph includes persons, accounts, and transactions related to the fraud

GET /v1/dict/funds-recoveries/{funds_recovery_id}/tracking-graph

Retrieve Tracking Graph

cURL

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

200

{
  "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": 2,
    "maxTransactions": 5,
    "minTransactionAmount": "200.00"
  },
  "persons": [
    {
      "id": 1,
      "type": "NATURAL_PERSON",
      "entityCreationDate": "2020-01-15"
    }
  ],
  "rootTransactionId": "E12345678202411241430ABCDEFGHIJK",
  "transactions": [
    {
      "amount": 1000.5,
      "creditorAccountId": 2,
      "debtorAccountId": 1,
      "id": "E12345678202411241430ABCDEFGHIJK",
      "refundableAmount": 1000.5,
      "settlementTime": "2023-11-07T05:31:56Z",
      "transactionDepth": 1
    }
  ]
}

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)

Parámetros de consulta

min_transaction_amount · string · obsoleto

Minimum transaction amount to include in the graph. Accepted for compatibility and ignored: BTG returns the graph built with the parameters used when the funds recovery was created.

max_transactions · integer<int64> · obsoleto

Maximum number of transactions to include. Accepted for compatibility and ignored: BTG returns the graph built with the parameters used when the funds recovery was created.

hop_window · string · obsoleto

Time window for hop analysis (ISO 8601 duration). Accepted for compatibility and ignored: BTG returns the graph built with the parameters used when the funds recovery was created.

max_hops · integer<int64> · obsoleto

Maximum number of hops to follow. Accepted for compatibility and ignored: BTG returns the graph built with the parameters used when the funds recovery was created.

Respuesta

200

application/json

OK

accounts · object[] · requerido

Accounts involved in the transaction graph

Show child attributes

creationTime · string<date-time> · requerido

Graph creation timestamp

Ejemplo:

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

fundsRecoveryId · string · requerido

Funds recovery identifier

Ejemplo:

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

parameters · object · requerido

Parameters used for graph generation

Show child attributes

persons · object[] · requerido

Persons involved in the transaction graph

Show child attributes

rootTransactionId · string · requerido

Root transaction ID

Ejemplo:

"E12345678202411241430ABCDEFGHIJK"

transactions · object[] · requerido

Transactions in the graph

Show child attributes