Skip to content

docs: add processing_failed to EmbedPaymentMethod ErrorCode in README#11825

Open
detail-app[bot] wants to merge 3 commits into
mainfrom
detail/fix-docs/docs-add-processing-failed-to-embedpaymentmethod-e-fd7bc9
Open

docs: add processing_failed to EmbedPaymentMethod ErrorCode in README#11825
detail-app[bot] wants to merge 3 commits into
mainfrom
detail/fix-docs/docs-add-processing-failed-to-embedpaymentmethod-e-fd7bc9

Conversation

@detail-app

@detail-app detail-app Bot commented May 21, 2026

Copy link
Copy Markdown
Contributor

Summary

The ErrorCode type in the checkout README was missing the 'processing_failed' variant
added to EmbedPaymentMethodErrorCode in source, and the onError description
incorrectly described the event as only firing on render-time failures.

What

  • Added 'processing_failed' to the ErrorCode union in the events table.
  • Broadened the onError prop 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 from
the docs. Their onError callback would silently receive an undocumented code.

Introduced by commit d3e5319 (@sebastianekstrom, #11739)

How

Updated two rows in clients/packages/checkout/README.md to match the source
definition in clients/packages/checkout/src/payment-method.ts.

Checklist

  • This PR addresses a single concern (one bug fix, one feature, one refactor)
  • The diff is reasonably sized and easy to review
  • New functionality is covered by tests
  • Linting and type checking pass (uv run task lint && uv run task lint_types)
  • No unrelated changes or drive-by fixes are included

Doc Drift PRs can be configured here.

@detail-app detail-app Bot requested a review from sebastianekstrom as a code owner May 21, 2026 16:53
@vercel

vercel Bot commented May 21, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
polar Ready Ready Preview, Comment May 28, 2026 6:37am
polar-sandbox Ready Ready Preview, Comment May 28, 2026 6:37am

Request Review

@github-actions

github-actions Bot commented May 21, 2026

Copy link
Copy Markdown
Contributor

Preview Environment
URL: https://polar-preview-vm.taildbff7b.ts.net/pr-11825
API: https://polar-preview-vm.taildbff7b.ts.net/pr-11825/v1/
Logs: backend
SHA: d1c43e7b0538cb38353347cb8e89b5716fa06bef

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.

0 participants