Skip to content

docs: integrate Commerce Payments Protocol into payment guides - #1970

Open
youssefea wants to merge 6 commits into
masterfrom
toshi/read-commerce-payments-protocol
Open

youssefea wants to merge 6 commits into
masterfrom
toshi/read-commerce-payments-protocol

Conversation

@youssefea

@youssefea youssefea commented Sep 15, 2026

Copy link
Copy Markdown
Contributor

What changed? Why?

Integrates Commerce Payments Protocol v1.1.0 into the established Accept Payments solution without changing its information architecture or guide format.

  • Preserves the existing Take a Payment, Confirm and Reconcile, Return and Pay Out, and Accept Agentic Payments groups.
  • Preserves every existing payment route and leaves the payout, split, and x402 guides in place.
  • Reworks request, authorize, capture, partial capture, void/reclaim, scheduled charge, refund, verify, watch, and reconcile around Commerce Payments Protocol.
  • Keeps the existing page pattern: interactive mock demo, implementation guidance, verified code snippet, checks, warnings, and related-guide cards.
  • Updates the PaymentsDemo flows to model PaymentInfo, collector approval, escrowed authorization, capture, protocol refund accounting, event verification, and reconciliation.
  • Adds synchronized, typechecked viem fixtures and a shared v1.1.0 escrow ABI/address module for the published snippets.

Notes to reviewers

The navigation and Base Std routing are byte-for-byte unchanged from master. The protocol content is based on base/commerce-payments main at commit b748fdd7 from September 3, 2026.

The docs call out the important implementation details without turning the Build on Base section into protocol reference docs: successful onchain authorization is the funds guarantee, captures use absolute fee amounts, void and payer reclaim return capturable funds, and refunds require new liquidity from a refund collector.

How has it been tested?

  • Targeted MDX lint for the complete Accept Payments directory and navigation titles
  • node scripts/verify-doc-samples.js — 69 synchronized samples
  • TypeScript sample typecheck
  • node scripts/validate-docs-structure.js
  • npm test — 85 passing
  • PaymentsDemo JSX compiled with esbuild
  • Every existing payment route and the Get Started page returns HTTP 200 locally
  • Final PR diff is whitespace-clean

Screenshots

Use the Mintlify preview below or the local preview at http://localhost:3000/get-started/accept-payments.

Co-authored-by: Codex <codex-noreply@coinbase.com>
@mintlify

mintlify Bot commented Sep 15, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
base 🟢 Ready View Preview Sep 16, 2026, 8:50 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@cb-heimdall

Copy link
Copy Markdown
Collaborator

🟡 Heimdall Review Status

Requirement Status More Info
Reviews 🟡 0/1
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
2 if repo is sensitive 0
From .codeflow.yml 1
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 0
Global minimum 0
Max 1
1
1 if commit is unverified 0
Sum 1

Co-authored-by: Codex <codex-noreply@coinbase.com>
@youssefea youssefea changed the title docs: add Commerce Payments Protocol guide docs: rebuild payments around Commerce Payments Protocol Sep 16, 2026
Co-authored-by: Codex <codex-noreply@coinbase.com>
youssefea and others added 2 commits September 16, 2026 18:33
Co-authored-by: Codex <codex-noreply@coinbase.com>
Co-authored-by: Codex <codex-noreply@coinbase.com>
@youssefea youssefea changed the title docs: rebuild payments around Commerce Payments Protocol docs: integrate Commerce Payments Protocol into payment guides Sep 16, 2026
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.

2 participants