docs: add processing_failed to EmbedPaymentMethod ErrorCode in README#11825
Open
detail-app[bot] wants to merge 3 commits into
Open
docs: add processing_failed to EmbedPaymentMethod ErrorCode in README#11825detail-app[bot] wants to merge 3 commits into
detail-app[bot] wants to merge 3 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
Preview Environment |
8327c66 to
6f21f58
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The
ErrorCodetype in the checkout README was missing the'processing_failed'variantadded to
EmbedPaymentMethodErrorCodein source, and theonErrordescriptionincorrectly described the event as only firing on render-time failures.
What
'processing_failed'to theErrorCodeunion in the events table.onErrorprop description to cover payment-method flow failures,not just iframe render failures (token missing/expired).
Why
A developer implementing error handling against the documented type union would not
handle card declines or 3DS failures, since
'processing_failed'was absent fromthe docs. Their
onErrorcallback would silently receive an undocumented code.Introduced by commit d3e5319 (@sebastianekstrom, #11739)
How
Updated two rows in
clients/packages/checkout/README.mdto match the sourcedefinition in
clients/packages/checkout/src/payment-method.ts.Checklist
uv run task lint && uv run task lint_types)Doc Drift PRs can be configured here.