Marquer la transaction pour effacement

L’API Mark Transaction for Erasure facilite la suppression d’une transaction. Les utilisateurs peuvent demander la suppression d’une ou de plusieurs transactions terminées ou incomplètes. Ils peuvent également spécifier l’heure à laquelle la transaction doit être supprimée.

Pendant le délai de grâce, c’est-à-dire le temps entre le marquage d’une transaction en vue de son effacement et son effacement effectif, les transactions peuvent être récupérées en les démarquant en vue de leur effacement. Pour plus d’informations, reportez-vous à la Unmark transaction for erasure.

Syntaxe

POST /api/transactions/mark-for-erasure

Exemples

Exemple de demande

POST /api/transactions/mark-for-erasure
Authorization: Bearer token
Content-Type: application/json
X-Tenant: dealflo
{
  "grace_period": 25,
  "transaction_ids": [
    "6cca2f64-2781-49fc-85de-f80361581968",
    "6cca2f64-2781-49fc-85de-f80361581969",
    "6cca2f64-2781-49fc-85de-f80361581970"
  ]
}

Exemple de réponse

{
message: "Some of the transactions could be marked for erasure others couldn't."
 
transactions: [
  {
    transaction_id: "xxxx-xxxxxx-xxxxxxx-xxxxxx",
    marking_event: "Transaction Erase Request - Accepted"
    message: "The transaction has been accepted to be marked for erasure, there could be a short period where the transaction is recoverable, it depends on the data retention policy (grace period)."
  },
 
  {
    transaction_id: "xxxx-xxxxxx-xxxxxxx-xxxxxx",
    marking_event: "Transaction Erase Request - ID field error"
    message: "This transaction doesn't exist, therefore cannot be marked for erasure."
  },
 
  {
    transaction_id: "xxxx-xxxxxx-xxxxxxx-xxxxxx",
    marking_event: "Transaction Erase Request - Transaction Not Found"
    message: "This transaction doesn't exist, therefore cannot be marked for erasure."
  },
 
  {
    transaction_id: "xxxx-xxxxxx-xxxxxxx-xxxxxx",
    marking_event: "Transaction Erase Request - Transaction currently active"
    message: "Failed to mark for erasure, the transaction was active (New or In Post Processing),  if it needs to be mark for erasure, it must first be cancelled."
  },
 
  {
    transaction_id: "xxxx-xxxxxx-xxxxxxx-xxxxxx",
    marking_event: "Transaction Erase Request - Fail" # Note that if this generic use case doesn't exist, don't create it.
    message: "Failed to mark for erasure. {descriptive_error_message}"
    message: "Failed to mark for erasure, the transaction was locked, please try again later."
  }
 
]
}

En-têtes

En-têtes de requête

Les en-têtes suivants sont inclus dans la demande :

• Autorisation : jeton OAuth/JWT à authentifier

• Type de contenu : application/json

• X-Tenant : l’ID du locataire (facultatif)

Codes d’état