Types d’événements

Sélectionnez parmi ces 23 types d’événements, ou activez un abonnement à tous les types. Chaque notification utilise l’enveloppe commune des événements ; cette page indique ce que chaque famille d’événements place dans data.

Familles d’événements

La plupart des intégrations commencent par payment.succeeded, payment.failed et payment.refund.succeeded. Les plateformes qui effectuent l’onboarding de commerçants ajoutent merchant.onboarding.approved et merchant.onboarding.action_required.

Paiements

Ces événements décrivent l’ensemble du paiement, quels que soient les processeurs de paiement et les canaux pris en charge. Ils contiennent data.payment, y compris les champs status et statusId du paiement.

La création d’un paiement dans un état autre qu’en attente envoie à la fois payment.created et l’événement de statut correspondant, si vous êtes abonné aux deux. Enregistrer à nouveau le même statut n’envoie ni nouvel événement de statut ni payment.updated.

status et statusId prennent ces valeurs dans les instantanés de paiement et de remboursement :

Les futurs identifiants de statut inconnus utilisent status: "unknown" et conservent leur statusId numérique. Les noms d’événements utilisent succeeded et canceled ; les valeurs de statut utilisent success et cancelled.

Remboursements

Les événements de remboursement contiennent à la fois data.payment et data.refund. Le remboursement a ses propres identifiant, jeton, statut, montants demandés et de règlement et devises correspondantes. Utilisez l’identifiant du remboursement pour le suivre indépendamment du paiement parent.

La création d’un remboursement dans un état autre qu’en attente peut aussi envoyer l’événement de statut correspondant. Un remboursement réussi ne décrit pas à lui seul le statut final de l’ensemble du paiement : vérifiez data.payment.status et toute notification distincte payment.refunded.

Commerçants

Les événements de commerçant contiennent data.merchant avec un id, un token et un instantané du statut enregistré du commerçant.

{
  "merchant": {
    "id": "019a0000-0000-7000-8000-000000000005",
    "token": "example_merchant_token",
    "status": {
      "isActive": true,
      "isShellMerchant": false,
      "profileOnboarded": true,
      "processors": [
        {
          "paymentProcessorId": 2,
          "hasAccount": true,
          "submitted": true,
          "approved": true,
          "rejected": false,
          "submittedAt": "2026-10-29T10:00:00+00:00",
          "approvedAt": "2026-10-30T12:00:00+00:00",
          "rejectedAt": null
        }
      ]
    }
  }
}

• profileOnboarded signifie qu’un profil existe. Cela ne signifie pas qu’un processeur a approuvé le commerçant ni que chaque moyen de paiement est prêt.
• Les identifiants de compte auprès du processeur et les messages de refus privés du processeur ne sont pas inclus. L’identifiant du processeur ci-dessus est illustratif.
• Mettre à jour des valeurs inchangées ou modifier des informations du commerçant sans rapport n’envoie aucun événement. Il n’existe ni événement merchant.updated ni événement de suppression de commerçant.

Onboarding des commerçants

Les événements d’onboarding contiennent data.onboarding. Son status correspond au dernier segment du nom de l’événement, et certains événements ajoutent les champs indiqués ci-dessous.

{
  "onboarding": {
    "status": "action_required",
    "reason": "The submitted company document is no longer valid.",
    "requiredAction": "Upload a current company registration document."
  }
}

Les événements d’onboarding et de statut du commerçant décrivent différents aspects d’un changement. Le même profil enregistré ou la même approbation par un processeur peut produire les deux familles d’événements si vous êtes abonné aux deux ; ne supposez aucun ordre entre elles. Les événements ne sont pas générés rétroactivement pour l’activité d’onboarding passée.

Tests de diagnostic

Utilisez l’action de test de la Platform pour envoyer webhook.test. Il inclut test: true, merchantId: null et data.message, sans état de paiement ni de commerçant. Il ne peut pas être sélectionné dans un abonnement aux événements.

Consultez Vérifier et tester pour vérifier la livraison sans créer de paiement.