Skip to content
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.

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

More details in Adyen app docs #1320

Open
wants to merge 17 commits into
base: main
Choose a base branch
from
Open

More details in Adyen app docs #1320

wants to merge 17 commits into from

Conversation

witoszekdev
Copy link
Member

@witoszekdev witoszekdev commented Sep 13, 2024

Extended Adyen app docs with notes about architecture (capture delay, metadata), configuration (new expected webhook settings), common pitfalls (e.g. the dreaded "delayed capture" setting), and how to resolve common issues with Adyen webhooks

Resolves:

  • SHOPX-1172
  • SHOPX-1345
  • SHOPX-1125
  • SHOPX-1365

Copy link

vercel bot commented Sep 13, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
saleor-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 18, 2024 4:56pm

@witoszekdev witoszekdev changed the title Add limitations and troubleshooting in Adyen App docs More details in Adyen app docs Sep 13, 2024
@witoszekdev witoszekdev marked this pull request as ready for review September 13, 2024 16:14
lkostrowski
lkostrowski previously approved these changes Sep 16, 2024
Copy link
Member

@lkostrowski lkostrowski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏

lkostrowski
lkostrowski previously approved these changes Sep 16, 2024
@witoszekdev
Copy link
Member Author

@Magdalena-Kobylanska Please take a look to do a proof-checking and leave any comments if something isn't clear enough ;)

lkostrowski
lkostrowski previously approved these changes Sep 17, 2024
Copy link

@Magdalena-Kobylanska Magdalena-Kobylanska left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestions left in comments

@@ -41,14 +41,14 @@ If such timeout happens, the created [`TransactionItem`](api-reference/payments/

### Granted refunds vs manual refunds

There are differences in how refunds are handled depending on wether an [`OrderGrantedRefund`](/api-reference/orders/objects/order-granted-refund.mdx) was created in Saleor and a refund via [`transactionRequestRefundForGrantedRefund`](api-reference/payments/mutations/transaction-request-refund-for-granted-refund.mdx) mutation was requested, or a "manual refund" sent via [`transactionRequestAction`](/api-reference/payments/mutations/transaction-request-action.mdx) mutation was requested. The differences is in how [`lineItems`](https://docs.adyen.com/api-explorer/Checkout/71/post/payments/_paymentPspReference_/refunds#request-lineItems.mdx) are reported to Adyen
There are differences in how refunds are handled depending on whether a [`OrderGrantedRefund`](/api-reference/orders/objects/order-granted-refund.mdx) was created in Saleor and a refund via [`transactionRequestRefundForGrantedRefund`](api-reference/payments/mutations/transaction-request-refund-for-granted-refund.mdx) mutation was requested, or a "manual refund" sent via [`transactionRequestAction`](/api-reference/payments/mutations/transaction-request-action.mdx) mutation was requested. The differences are in how [`lineItems`](https://docs.adyen.com/api-explorer/Checkout/71/post/payments/_paymentPspReference_/refunds#request-lineItems.mdx) are reported to Adyen

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we talk about general assumptions, we can skip 'an' and 'a'-s

@@ -41,14 +41,14 @@ If such timeout happens, the created [`TransactionItem`](api-reference/payments/

### Granted refunds vs manual refunds

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add box to explain API vs Dashboard refund names

@@ -57,3 +57,144 @@ If you want to self-host the Adyen app, reach out to [our team <Mail size={12}/>
- `AUTHORIZATION_ACTION_REQUIRED`
- `CHARGE_FAILURE`
- `AUTHORIZATION_FAILURE`
- [Webhook settings > Delayed Capture](#duplicated-chargedamount-in-saleor) is disabled in Adyen Dashboard
- Webhook in Adyen was created with all options (additional settings) described in [Saleor docs](./configuration.mdx#webhook-configuration)
- App supports following notification events from Adyen, other types of events will be ignored:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add this in a new sub-cathegory under 'assumptions' and move the "other types of events will be ignored:" part under the event list, in a caution! box

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants