Webhooks > Payment

Utilisez ceci lorsque votre système doit marquer a Facture comme payé dès que le client paie.

Pour trouver la facture qu'un paiement a réglée, lisez allocations[].ref . C'est le _id de la facture que Ajouter/Mettre à jour une Facture a renvoyé lors de la création de la facture. Conservez donc ce _id à côté de votre propre enregistrement.

When a payment on an invoice reaches a new status in the Hyfin application, the webhook will be called and the following data format will be POSTED to the provided webhook URL. Each status is sent once per payment, so a payment that is captured and later settled produces two calls, distinguished by the status field. Declined payments and failed refunds are not sent by default. To receive them, ask Hyfin to turn them on for your app.

Un remboursement est envoyé comme un paiement distinct, avec is_refund défini à true et orig_payment défini à l'_id du paiement qu'il a remboursé.

Les charges utiles des webhooks utilisent des clés en snake_case, contrairement au camelCase utilisé par l'API 4.0 elle-même. Les montants sont en cents entiers.

Cette structure 4.0 est envoyée uniquement aux sites dont la version du webhook est définie à 4.0, qui est la valeur par défaut pour les sites nouvellement créés. Un site resté sur une version antérieure du webhook continue de recevoir l'ancienne charge utile, où les montants sont en dollars décimaux.

			
{
  "action": "payment",
  "data": {
    "_id": "6385807aa90735097a811cf6",
    "display_name": "VISA **** 5123",
    "site": "6201825a0cf5e23261a08646",
    "customer": "649dc5bb468bd5b5d863c7d1",
    "type": "payment_card",
    "sub_type": "visa",
    "amount": 4964,
    "totals": {
      "subtotal": 3000,
      "taxes": 300,
      "total": 3300,
      "extra_fees": 1164,
      "tips": 500
    },
    "paid_on": "2026-05-13T19:29:28.000Z",
    "status": "captured",
    "is_refund": false,
    "allocations": [
      {
        "ref_type": "Invoice",
        "ref": "649dc5bb468bd5b5d863c7d2",
        "amount": 3300
      }
    ],
    "payment_transaction_events": [
      {
        "type": "sale",
        "amount": 4964,
        "successful": true,
        "created_at": "2026-05-13T19:29:28.000Z",
        "transaction_id": "32483237915423321"
      }
    ]
  }
}


		

Voir aussi