Typy událostí

Vyberte změny plateb, vratek, obchodníků a onboardingu, které vaše integrace potřebuje.

Vyberte si z těchto 23 typů událostí nebo zapněte odběr všech typů. Každé oznámení používá společnou obálku události; tato stránka ukazuje, co každá skupina událostí vkládá do data.

Skupiny událostí

Skupina	Události	`data` obsahuje
Platby	7	`payment`
Vratky	6	`payment` a `refund`
Obchodníci	2	`merchant`
Onboarding obchodníka	8	`onboarding`

Většina integrací začíná událostmi payment.succeeded, payment.failed a payment.refund.succeeded. Platformy, které onboardují obchodníky, přidávají merchant.onboarding.approved a merchant.onboarding.action_required.

Platby

Tyto události popisují celou platbu napříč podporovanými zpracovateli a platebními kanály. Obsahují data.payment, včetně stavu platby status a statusId.

Událost	Kdy se odesílá
`payment.created`	Při uložení platby.
`payment.updated`	Při změně stavu na `pending` nebo jiný stav bez vlastního názvu události. Nejde o oznámení každé úpravy pole.
`payment.succeeded`	Při změně stavu na `success`.
`payment.failed`	Při změně celé platby na `failed`, nikoli při selhání jednotlivého pokusu o platbu.
`payment.canceled`	Při změně stavu na `cancelled`.
`payment.refunded`	Když Tapaya označí platbu jako `refunded`.
`payment.action_required`	Při změně stavu na `actionNeeded`.

Vytvoření platby v jiném než čekajícím stavu odešle payment.created i odpovídající stavovou událost, pokud odebíráte obě. Opětovné uložení stejného stavu neodešle novou stavovou událost ani payment.updated.

status a statusId nabývají ve snímcích plateb a vratek těchto hodnot:

`statusId`	`status`	Význam
`1`	`pending`	Zpracování zatím nemá konečný výsledek.
`2`	`success`	Platba nebo vratka byla úspěšná.
`3`	`cancelled`	Platba nebo vratka byla zrušena.
`4`	`refunded`	Tapaya označila platbu jako vrácenou.
`5`	`failed`	Platba nebo vratka selhala.
`6`	`actionNeeded`	Je potřeba další akce.

Neznámá budoucí ID stavů používají status: "unknown" a zachovávají číselné statusId. Názvy událostí používají succeeded a canceled; hodnoty stavu používají success a cancelled.

Vratky

Události vratek obsahují data.payment i data.refund. Vratka má vlastní ID, token, stav a požadované i zúčtované částky a měny. Pomocí ID vratky ji sledujte nezávisle na původní platbě.

Událost	Kdy se odesílá
`payment.refund.created`	Při uložení vratky.
`payment.refund.updated`	Při změně stavu na `pending` nebo jiný stav bez vlastního názvu události.
`payment.refund.succeeded`	Při změně stavu na `success`.
`payment.refund.failed`	Při změně stavu na `failed`.
`payment.refund.canceled`	Při změně stavu na `cancelled`.
`payment.refund.action_required`	Při změně stavu na `actionNeeded`.

Vytvoření vratky v jiném než čekajícím stavu může také odeslat odpovídající stavovou událost. Úspěšná vratka sama o sobě neurčuje konečný stav celé platby: zkontrolujte data.payment.status a případné samostatné oznámení payment.refunded.

Obchodníci

Události obchodníků obsahují data.merchant s id, token a snímkem uloženého stavu obchodníka.

Událost	Kdy se odesílá
`merchant.created`	Při vytvoření obchodníka ve vaší organizaci.
`merchant.status_changed`	Při změně aktivace, příznaku základního záznamu obchodníka, existence profilu nebo účtu, odeslání, schválení či zamítnutí u zpracovatele.

data

{
  "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 znamená, že existuje profil. Neznamená schválení obchodníka zpracovatelem ani připravenost všech platebních metod.
Identifikátory účtů u zpracovatele a neveřejné zprávy zpracovatele o zamítnutí nejsou zahrnuty. ID zpracovatele výše je ilustrativní.
Uložení nezměněných hodnot nebo úprava nesouvisejících údajů obchodníka žádnou událost neodešle. Událost merchant.updated ani událost smazání obchodníka neexistuje.

Onboarding obchodníka

Události onboardingu obsahují data.onboarding. Jeho status odpovídá poslední části názvu události a některé události přidávají pole uvedená níže.

Událost	Kdy se odesílá
`merchant.onboarding.started`	Při uložení prvního profilu obchodníka a dat onboardingu.
`merchant.onboarding.profile_completed`	Při uložení prvního kompletního profilu obchodníka.
`merchant.onboarding.document_added`	Při uložení nového dokumentu. Přidává `documentId`, `documentTypeId`, `paymentProcessorId` a u dočasně uloženého dokumentu `source: "cache"`.
`merchant.onboarding.stakeholder_completed`	Při dokončení onboardingových údajů účastníka. Přidává `stakeholderId`.
`merchant.onboarding.submitted`	Když je onboarding připraven k odeslání zpracovateli. Přidává `paymentProcessorId`.
`merchant.onboarding.approved`	Při prvním schválení účtu u zpracovatele. Přidává `paymentProcessorId`.
`merchant.onboarding.rejected`	Tapaya po ručním posouzení onboarding zamítne. Přidává `reason` a `requiredAction` s hodnotou `null`.
`merchant.onboarding.action_required`	Tapaya po ručním posouzení požádá o doplnění informací. Přidává `reason` a `requiredAction`.

data

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

Události onboardingu a stavu obchodníka popisují různé aspekty změny. Stejné uložení profilu nebo schválení zpracovatelem může vytvořit obě skupiny událostí, pokud odebíráte obě; nepředpokládejte jejich pořadí. Historické onboardingové aktivity se zpětně nedoplňují.

Diagnostické testy

Pomocí testovací akce v Platform odešlete webhook.test. Obsahuje test: true, merchantId: null a data.message, bez stavu platby či obchodníka. Nelze ho vybrat jako odběr událostí.

Doručení bez vytvoření platby ověřte podle stránky Ověření a testování.

Chybí vám něco na této stránce?Navrhněte funkci. Připojíme tuto stránku, aby tým viděl souvislosti.