Typy udalostí

Vyberte zmeny platieb, refundácií, obchodníkov a onboardingu, ktoré vaša integrácia potrebuje.

Vyberte si z týchto 23 typov udalostí alebo zapnite odber všetkých typov. Každé oznámenie používa spoločnú obálku udalosti; táto stránka ukazuje, čo jednotlivé skupiny udalostí vkladajú do data.

Skupiny udalostí

Skupina	Udalosti	`data` obsahuje
Platby	7	`payment`
Refundácie	6	`payment` a `refund`
Obchodníci	2	`merchant`
Onboarding obchodníka	8	`onboarding`

Väčšina integrácií začína udalosťami payment.succeeded, payment.failed a payment.refund.succeeded. Platformy, ktoré zabezpečujú onboarding obchodníkov, pridávajú merchant.onboarding.approved a merchant.onboarding.action_required.

Platby

Tieto udalosti opisujú celú platbu naprieč podporovanými spracovateľmi platieb a kanálmi. Obsahujú data.payment vrátane polí status a statusId platby.

Udalosť	Kedy sa odosiela
`payment.created`	Platba sa uloží.
`payment.updated`	Jej stav sa zmení na `pending` alebo iný stav bez vyhradeného názvu udalosti. Nejde o oznámenie pri každej úprave poľa.
`payment.succeeded`	Jej stav sa zmení na `success`.
`payment.failed`	Celá platba prejde do stavu `failed`, nejde o zlyhanie jednotlivého pokusu o platbu.
`payment.canceled`	Jej stav sa zmení na `cancelled`.
`payment.refunded`	Tapaya označí platbu ako `refunded`.
`payment.action_required`	Jej stav sa zmení na `actionNeeded`.

Vytvorenie platby v inom než čakajúcom stave odošle payment.created aj zodpovedajúcu udalosť stavu, ak odoberáte obe. Opätovné uloženie rovnakého stavu neodošle novú udalosť stavu ani payment.updated.

Polia status a statusId nadobúdajú v snímkach platieb a refundácií tieto hodnoty:

`statusId`	`status`	Význam
`1`	`pending`	Spracovanie ešte nedosiahlo konečný výsledok.
`2`	`success`	Platba alebo refundácia bola úspešná.
`3`	`cancelled`	Platba alebo refundácia bola zrušená.
`4`	`refunded`	Tapaya označila platbu ako refundovanú.
`5`	`failed`	Platba alebo refundácia zlyhala.
`6`	`actionNeeded`	Je potrebný ďalší krok.

Neznáme budúce ID stavov používajú status: "unknown" a zachovávajú svoje číselné statusId. Názvy udalostí používajú succeeded a canceled; hodnoty stavov používajú success a cancelled.

Refundácie

Udalosti refundácií obsahujú data.payment aj data.refund. Refundácia má vlastné ID, token, stav a požadované a zúčtovacie sumy a meny. Pomocou ID refundácie ju sledujte nezávisle od nadradenej platby.

Udalosť	Kedy sa odosiela
`payment.refund.created`	Refundácia sa uloží.
`payment.refund.updated`	Jej stav sa zmení na `pending` alebo iný stav bez vyhradeného názvu udalosti.
`payment.refund.succeeded`	Jej stav sa zmení na `success`.
`payment.refund.failed`	Jej stav sa zmení na `failed`.
`payment.refund.canceled`	Jej stav sa zmení na `cancelled`.
`payment.refund.action_required`	Jej stav sa zmení na `actionNeeded`.

Vytvorenie refundácie v inom než čakajúcom stave môže odoslať aj zodpovedajúcu udalosť stavu. Úspešná refundácia sama osebe neopisuje konečný stav celej platby: skontrolujte data.payment.status a prípadné samostatné oznámenie payment.refunded.

Obchodníci

Udalosti obchodníkov obsahujú data.merchant s poľami id, token a snímkou uloženého stavu obchodníka.

Udalosť	Kedy sa odosiela
`merchant.created`	Vo vašej organizácii sa vytvorí obchodník.
`merchant.status_changed`	Zmení sa aktivácia, stav základného záznamu obchodníka, prítomnosť profilu alebo účet, podanie, schválenie či zamietnutie u spracovateľa.

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á to, že spracovateľ obchodníka schválil alebo že sú pripravené všetky platobné metódy.
Identifikátory účtov u spracovateľov ani ich súkromné správy o zamietnutí nie sú zahrnuté. ID spracovateľa vyššie je ilustračné.
Uloženie nezmenených hodnôt alebo úprava nesúvisiacich údajov obchodníka neodošle žiadnu udalosť. Udalosť merchant.updated ani udalosť odstránenia obchodníka neexistuje.

Onboarding obchodníka

Udalosti onboardingu obsahujú data.onboarding. Jeho status zodpovedá poslednej časti názvu udalosti a niektoré udalosti pridávajú polia uvedené nižšie.

Udalosť	Kedy sa odosiela
`merchant.onboarding.started`	Uloží sa prvý profil obchodníka a údaje onboardingu.
`merchant.onboarding.profile_completed`	Uloží sa prvý úplný profil obchodníka.
`merchant.onboarding.document_added`	Uloží sa nový dokument. Pridáva `documentId`, `documentTypeId`, `paymentProcessorId` a pri dočasne uloženom dokumente `source: "cache"`.
`merchant.onboarding.stakeholder_completed`	Údaje onboardingu zainteresovanej osoby sa dokončia. Pridáva `stakeholderId`.
`merchant.onboarding.submitted`	Onboarding je pripravený na podanie spracovateľovi. Pridáva `paymentProcessorId`.
`merchant.onboarding.approved`	Účet u spracovateľa je prvýkrát schválený. Pridáva `paymentProcessorId`.
`merchant.onboarding.rejected`	Tapaya po manuálnej kontrole zamietne onboarding. Pridáva `reason`, pričom `requiredAction` má hodnotu `null`.
`merchant.onboarding.action_required`	Tapaya si po manuálnej kontrole vyžiada ďalšie informácie. Pridáva `reason` a `requiredAction`.

data

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

Udalosti onboardingu a stavu obchodníka opisujú rôzne aspekty zmeny. Rovnaký uložený profil alebo schválenie spracovateľom môže vytvoriť oba druhy udalostí, ak odoberáte oba; nepredpokladajte ich poradie. Udalosti pre historickú aktivitu onboardingu sa spätne nedopĺňajú.

Diagnostické testy

Pomocou testovacej akcie v Platform odošlite webhook.test. Obsahuje test: true, merchantId: null a data.message, bez stavu platby alebo obchodníka. Nemožno ho vybrať ako odber udalostí.

V časti Overenie a testovanie nájdete postup, ako skontrolovať doručovanie bez vytvorenia platby.

Chýba vám niečo na tejto stránke?Navrhnite funkciu. Pripojíme túto stránku, aby tím videl súvislosti.