No momento, esta página não está disponível em português
Point-of-sale icon

Platform-generated webhooks

Receive platform-generated webhooks on your back-end system.

Webhooks generated on the plataforma de pagamentos da Adyen share a similar format and are delivered in the same way across sales channels. Platform-generated webhooks inform you asynchronously of transaction details and settings updates.

There are two types of platform-generated webhooks relevant for in-person payments:

Set up webhooks

To add standard or terminal management webhooks, follow our webhooks documentation to:

  • Set up standard webhooks and other platform-generated webhooks.
  • Verify the HMAC signature included in webhooks.
  • Acknowledge webhooks with a successful HTTP response status code, for example 202.
  • Understand the structure of webhooks.
  • Learn best practices for using webhooks.

Standard webhook

In a point-of-sale integration, standard webhooks may seem less important, because the terminal provides instant feedback: it immediately shows if a transaction is Approved or Declined. And even if you don't receive the Terminal API response with the transaction details, you can get the details through a transaction status request.

However, there are point-of-sale use cases that rely on standard webhooks:

Standard webhooks include a few details by default, as well as configurable additional data. Depending on your use case, you need to and select identifiers that you want to receive in the additional data of webhooks.

To configure the structure, when setting up a standard webhook:

  1. Select the event codes that trigger sending the webhook.
  2. Select the additional settings you want to receive. For example:

    Identifier Additional setting to select
    Card alias Include Alias Info
    Funding source Include Funding Source
    Issuer country/region Include Issuer Country/Region
    PAR Add Payment Account Reference
    Must be enabled under Developers > Additional data.
    Recurring detail reference
    Can't be enabled in the webhook settings. Must be enabled under Developers > Additional data.
    Shopper email, shopper reference Include Shopper Details
    Token variant Include tokenTxVariant
    Must be enabled under Developers > Additional data.
    BIN Include Card Bin
    POIID Include POS TerminalInfo
    Store name Include Store
    Tender reference, POIID Include POS Details

    When you enable identifiers under Developers > Additional data you also receive these identifiers in your API responses.

The following example shows the standard webhook for an in-person payment. The identifiers are in the additionalData object.

Terminal management webhooks

Adyen sends terminal management webhooks to inform your system about the status of payment terminals orders, assignment, or settings update.

Terminal management webhooks have a different structure from standard webhooks and do not require additional setup apart from the server and security configuration in your Customer Area.

Webhook type Description
Terminal assignment completed Receive a webhook event when a scheduled assignment of a payment terminal has been completed. Refer to Assign terminals.
Terminal order updated Receive a webhook event about updates to your sales, return, or replacement order for payment terminals. Refer to Order terminals.
Terminal settings updated Receive a webhook event when the terminal settings are updated. Refer to Configure terminals.

See also