Skip to content

docs: clarify Upay is a downstream clearer, not a SUMIT brand #10

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
BenKalsky merged 1 commit into from
May 1, 2026
Merged

docs: clarify Upay is a downstream clearer, not a SUMIT brand #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ Guidance for AI assistants working in this repository.

## Project

`sumit-react` — React component (`<SumitCheckout />`), checkout state hook (`useSumitCheckout`), and Next.js route helpers (`createSumitChargeRoute`, `createSumitWebhookRoute`) for SUMIT / OfficeGuy / Upay payments.
`sumit-react` — React component (`<SumitCheckout />`), checkout state hook (`useSumitCheckout`), and Next.js route helpers (`createSumitChargeRoute`, `createSumitWebhookRoute`) for SUMIT (formerly OfficeGuy) payments.

SUMIT is the billing platform. It delegates card clearing to partner processors — Upay is one, others exist — so processor-level error codes (`Upay_*`) appear inside SUMIT response bodies and are scrubbed by `redactSumitPayload` from `sumit-api` before any event leaves a route handler.

Companion package: [`sumit-api`](https://github.com/Digitizers/sumit-api) (peer dependency).

Expand Down
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@
[![react](https://img.shields.io/badge/react-%E2%89%A518-61DAFB?logo=react&logoColor=white)](package.json)
[![next](https://img.shields.io/badge/next.js-app%20router-000000?logo=next.js&logoColor=white)](https://nextjs.org)

> React components and Next.js route helpers for [SUMIT / OfficeGuy / Upay](https://sumit.co.il) payments. The companion to [`sumit-api`](https://github.com/Digitizers/sumit-api).
> React components and Next.js route helpers for [SUMIT](https://sumit.co.il) (formerly **OfficeGuy**) payments. The companion to [`sumit-api`](https://github.com/Digitizers/sumit-api).
>
> SUMIT is the billing platform. The actual card clearing is performed by partner processors that SUMIT routes to — **Upay** is one such clearer, and SUMIT can integrate with others. From the perspective of this package, you talk to SUMIT; processor-level error codes (e.g. `Upay_*`) only show up inside SUMIT's response bodies.

Ship a working SUMIT checkout flow in a React or Next.js app with two files: a Client Component and a route handler.

Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "sumit-react",
"version": "0.1.1",
"description": "React components and Next.js route helpers for SUMIT/OfficeGuy/Upay payments.",
"description": "React components and Next.js route helpers for SUMIT (formerly OfficeGuy) payments.",
"license": "MIT",
"type": "module",
"sideEffects": false,
Expand Down
Loading