Skip to content

docs(headless-sdk): information capture via collectData.schema (native) #103

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

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

docs(headless-sdk): information capture via collectData.schema (native) #103

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6fd1fb6
docs(headless-sdk): information capture — hosted URL (primary) + nati…
enesozturk Sep 2, 2026
d946b0e
docs(headless-sdk): IC hosted path is SDK-owned (openInfoCapture)
enesozturk Sep 2, 2026
0b0b454
docs(headless-sdk): scope IC to native collectData.schema (drop hoste…
enesozturk Sep 2, 2026
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
18 changes: 16 additions & 2 deletions payments/psps/headless-sdk/implementation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,8 +306,8 @@ switch (snapshot.state) {
return <Empty label="No payment options for this wallet." />

case 'InformationCapture':
// Render snapshot.collectData.fields, then:
return <KycForm fields={snapshot.collectData?.fields} onSubmit={submitInfoCapture} />
// Identity capture — render from collectData.schema (see "Information capture" below).
return <KycForm schema={snapshot.collectData?.schema} onSubmit={submitInfoCapture} />

case 'OptionSelected':
case 'RequiresApproval':
Expand Down Expand Up @@ -337,6 +337,20 @@ switch (snapshot.state) {

That's a full gateway. Connect → options → (optional KYC) → confirm → sign → settle, all driven by the runtime; you only render and call actions. Once a wallet is connected, `disconnectWallet(namespace?)` drops one namespace or all of them.

## Information capture

Some payments require identity details (name, date of birth, country, terms acceptance) before they can settle — usually for regulatory reasons, often only on a buyer's first payment. When the selected option needs it, the runtime enters the `InformationCapture` state and describes what to collect on `snapshot.collectData`.

Render the form from **`snapshot.collectData.schema`** — a JSON Schema (`properties`, `required`, `anyOf` for proof-of-birth / proof-of-residence, and a `tosConfirmed` checkbox) — and submit the collected values with `submitInfoCapture(data)`. The runtime sends them with the payment confirmation; the flow advances on its own.

```tsx
<KycForm schema={snapshot.collectData?.schema} onSubmit={submitInfoCapture} />
```

<Note>
`collectData.fields` (name + date of birth only) is **deprecated** — it under-collects. Drive your form from `collectData.schema`.
</Note>

## Environment variables

```bash .env.local
Expand Down