TulipTulip Docs
Concepts

Règlements et paiements

Cycle de vie des remboursements, types de règlements et suivi des paiements.

Les règlements (settlements) représentent les transactions financières liées à un sinistre. Ils apparaissent dans le champ settlements de la réponse d'un sinistre.

Types de règlement

TypeDescription
refundRemboursement — paiement versé à l'assuré
returnedRetour — remboursement échoué (IBAN invalide, virement rejeté, etc.)

Cycle de vie

1. Remboursement approuvé
   └─► Settlement créé (type: "refund", paymentAt: null)

2. Virement traité
   └─► paymentAt mis à jour avec la date de paiement

3. Si le virement échoue
   └─► Nouveau settlement créé (type: "returned")
   └─► Nouveau settlement "refund" créé pour la nouvelle tentative

Exemple de réponse

{
  "settlements": [
    {
      "id": "stl_001",
      "type": "refund",
      "amount": 500.00,
      "paymentAt": "2024-02-15T14:30:00Z",
      "createdAt": "2024-02-10T10:00:00Z"
    },
    {
      "id": "stl_002",
      "type": "returned",
      "amount": 500.00,
      "paymentAt": null,
      "createdAt": "2024-02-20T09:00:00Z"
    }
  ]
}

Dans cet exemple :

  1. Un remboursement de 500 € a été effectué le 15/02
  2. Ce remboursement a été retourné le 20/02 (virement échoué)

Champs

ChampTypeDescription
idstringIdentifiant unique du règlement
typerefund | returnedType de transaction
amountnumberMontant en euros
paymentAtstring | nullDate de paiement effectif (null si en attente)
createdAtstringDate de création du règlement

Points d'attention

Paiement actif bloque l'abandon — Un sinistre avec un paiement en cours ne peut pas être abandonné (erreur 3007). Attendez que le paiement soit traité avant de tenter un abandon.

paymentAt null — Un règlement avec paymentAt: null signifie que le paiement est en cours de traitement. Il sera mis à jour automatiquement une fois le virement effectué.

Webhooks associés

ÉvénementDescription
v2.claim.settlement.createdNouveau règlement créé
v2.claim.settlement.paidPaiement effectué
v2.claim.settlement.returnedPaiement retourné (échoué)

Voir Webhooks pour l'intégration.

Que pensez-vous de cette page ?

Sur cette page