Skip to content

Update Adyen app docs #1739

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
witoszekdev merged 5 commits into from
Jan 27, 2026
+55 −17
Merged

Update Adyen app docs #1739

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
977926d
Update Adyen app docs
witoszekdev Jan 26, 2026
71f036e
Update configuration tip
witoszekdev Jan 26, 2026
39dcd60
Fix typo
witoszekdev Jan 26, 2026
c169cc6
Add more info about "Additional data"
witoszekdev Jan 26, 2026
9f1b707
Add more details in overview
witoszekdev Jan 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 18 additions & 15 deletions docs/developer/app-store/apps/adyen/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,20 +57,33 @@ Before you begin configuration, make sure that you have disabled the **Delayed C
:::

In the Adyen dashboard, first go to **Developers -> Additional data**. Click on the following checkboxes:
- `Card summary`
- `Expiry date`
- `Subvariant`
- `Variant`
- `Co-brand`
- `Bank summary`
- `Authorization amount`
- `Authorisation amount (dynamic zero authorisation)`
- `Recurring details`
- `Recurring contract information`
- `Merchant reference`

Your "Response preview" should look like this:

```json
{
"additionalData": {
"cardSummary": "1111",
"expiryDate": "8/2018",
"paymentMethodVariant": "visadebit",
"paymentMethod": "visa",
"coBrandedWith": "visa",
"bankSummary": "1111",
"authorisedAmountCurrency": "EUR",
"authorisedAmountValue": "1000",
"recurring.shopperReference": "testshopper",
"recurring.recurringDetailReference": "1111111111111111",
"recurring.contractTypes": "RECURRING,ONECLICK",
"recurring.recurringDetailReference": "111111",
"recurring.firstPspReference": "111111",
"merchantReference": "ref_1234"
}
}
Expand All @@ -84,6 +97,7 @@ Adyen webhook will set `TransactionItem` metadata based on fields received in `N
To configure additional fields that will be set when users make payments, go to `Developers > Additional data` and choose fields you want to have in your metadata. Read more about this on the [Architecture docs page](./architecture.mdx#transactionitem-metadata)
:::


#### Configuring the webhook

Then head over to **Developers -> Webhooks**. Click the **+ Webhook** button and choose **Standard webhook**. Provide a description for the webhook.
Expand All @@ -99,17 +113,13 @@ Do not select merchant accounts that are used for payments made outside of Adyen
In **Events**, make sure that you have selected the following events:

:::tip
By default you can just:
For quick configuration you can just follow these steps:
- deselect `ORDER_OPENNED` event
- select `EXPIRE` and `OFFER_CLOSED` events.

However, make sure that all the listed events are selected, in case Adyen has added new events or removed them as default.
:::

- `AUTHORISATION`
- `AUTHORISATION_ADJUSTMENT`
- `AUTORESCUE`
- `CANCEL_AUTORESCUE`
- `CANCEL_OR_REFUND`
- `CANCELLATION`
- `CAPTURE`
Expand All @@ -124,11 +134,6 @@ However, make sure that all the listed events are selected, in case Adyen has ad
- `NOTIFICATION_OF_FRAUD`
- `OFFER_CLOSED`
- `ORDER_CLOSED`
- `PAIDOUT_REVERSED`
- `PAYOUT_DECLINE`
- `PAYOUT_EXPIRE`
- `PAYOUT_THIRDPARTY`
- `PENDING`
- `POSTPONED_REFUND`
- `PREARBITRATION_LOST`
- `PREARBITRATION_WON`
Expand All @@ -137,10 +142,8 @@ However, make sure that all the listed events are selected, in case Adyen has ad
- `REFUND_FAILED`
- `REFUND_WITH_DATA`
- `REFUNDED_REVERSED`
- `REPORT_AVAILABLE`
- `REQUEST_FOR_INFORMATION`
- `SECOND_CHARGEBACK`
- `TECHNICAL_CANCEL`
- `VOID_PENDING_REFUND`

In **Additional settings -> Card** select:
Expand Down
4 changes: 4 additions & 0 deletions docs/developer/app-store/apps/adyen/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ App supports following notification events from Adyen:
- [`CaptureFailed`](https://docs.adyen.com/api-explorer/Webhooks/1/post/CAPTURE_FAILED)
- [`Expire`](https://docs.adyen.com/api-explorer/Webhooks/1/post/EXPIRE)
- [`OrderClosed`](https://docs.adyen.com/api-explorer/Webhooks/1/post/ORDER_CLOSED)
- [`OfferClosed`](https://docs.adyen.com/api-explorer/Webhooks/1/post/OFFER_CLOSED)
- [`Refund`](https://docs.adyen.com/api-explorer/Webhooks/1/post/REFUND)
- [`RefundFailed`](https://docs.adyen.com/api-explorer/Webhooks/1/post/REFUND_FAILED)
- [`RefundedReversed`](https://docs.adyen.com/api-explorer/Webhooks/1/post/REFUNDED_REVERSED)
Expand All @@ -78,6 +79,9 @@ Following events will be mapped to `INFO` event in Saleor, it will not change am
- [`ManualReviewAccept`](https://docs.adyen.com/api-explorer/Webhooks/1/post/MANUAL_REVIEW_ACCEPT)
- [`ManualReviewReject`](https://docs.adyen.com/api-explorer/Webhooks/1/post/MANUAL_REVIEW_REJECT)

These events are currently ignored by the app, left for future implementation:
- [`RecurringContract`](https://docs.adyen.com/api-explorer/Webhooks/1/post/RECURRING_CONTRACT)

## Assumptions

- If Adyen doesn't respond to app request for [initialize transaction session](/developer/extending/webhooks/synchronous-events/transaction#initialize-transaction-session) or [process transaction session](/developer/extending/webhooks/synchronous-events/transaction#process-transaction-session) with `pspReference`:
Expand Down