Skip to content

docs(UPIIS-47): UPI Issuance onboarding developer docs + OpenAPI refe…#445

Merged
Anindya-Pandey merged 1 commit into
stagingfrom
UPIIS-47-upi-issuance-docs
Jul 14, 2026
Merged

docs(UPIIS-47): UPI Issuance onboarding developer docs + OpenAPI refe…#445
Anindya-Pandey merged 1 commit into
stagingfrom
UPIIS-47-upi-issuance-docs

Conversation

@Anindya-Pandey

Copy link
Copy Markdown

UPI Issuance — onboarding developer docs + OpenAPI API reference

Adds the client-facing developer documentation for the UPI Issuance onboarding surface, plus the OpenAPI spec that powers its interactive API
reference.

Jira: UPIIS-47 (https://setu.atlassian.net/browse/UPIIS-47)

What's included

Guide pages (content/payments/upi-issuance/)

  • Overview, Quickstart, API envelope
  • Device binding, OTP verification, VPA management, Programs, Payee blocklist
  • Testing on the QA env, API reference

API reference (api-references/payments/upi-issuance/upi-issuance.json)

  • OpenAPI generated from the tpapapi goa DSL, with client-facing polish:
    • Human-readable operation summaries; sections ordered to match the docs (Device binding → OTP → VPA management → Programs → Payee blocklist)
    • Internal endpoints (/webhooks/vmn, /tpap-config) excluded from the reference
    • Per-operation error-code enums + examples (each status lists only the codes it can actually return)
    • Consistent conventions across docs and refs: deviceId, mobile (with country code), idempotencyKey (plain key), cursor/id as ULIDs, full-VPA
      (prefix@handle) params, use-case-framed otpRequired

Nav registration: content/endpoints.json, content/menuItems.json, content/redirects.json

@github-actions

github-actions Bot commented Jul 13, 2026

Copy link
Copy Markdown

Checklist to merge a PR 🚀

To merge this pull request, please take time to complete the checklist.

What action did you perform?

Review the corresponding checklist items for the action you performed and mark them done.

Edit an existing content (MDX) page

Checklist

  • Review changes using the MDX preview option
  • If the length of content >15000 chars, use the Content preview portal to view changes
  • If a redirect is needed to the existing page, add a key, value pair in redirects.json

Edit an existing API reference page

Checklist


Add a new content (MDX) page

Checklist

  • Create a .mdx file with the path as its name in the content folder
  • Add frontmatter with all the metadata
  • Review the order of items in Sidebar using the Sidebar preview option
  • Review changes using the MDX preview option
  • If the length of content >15000 chars, use the Content preview portal to view changes
  • Created a folder with the same name, if any children were to be added to the page
  • Once all changes are done, update the menu items by using the Menu Items option
  • Add a key, and value pair in redirects.json if you wish to have a redirect to the new page

Add a new API reference page

Checklist

  • Create a .json file with the product path as its name
  • Create an api-reference.mdx file in the respective product folder inside content folder
  • Add frontmatter with all the metadata
  • Review the order of items in Sidebar using the Sidebar preview option
  • Add API reference in JSON format (OpenAPI or Swagger) into created .json file.
  • Used the Content preview portal to view changes
  • Once all changes are done, update the menu items by using the Menu Items option

…rence

Client-facing developer documentation for the UPI Issuance onboarding surface,
published to the Setu docs site.

- Guide pages: overview, quickstart, API envelope, device binding, OTP
  verification, VPA management, programs, payee blocklist, QA-env testing.
- OpenAPI spec (api-references/payments/upi-issuance.json) driving the interactive
  API reference: human-readable operation summaries, doc-ordered sections, internal
  endpoints excluded, per-operation error-code enums + examples, and consistent
  deviceId / mobile / idempotencyKey / cursor / token / id conventions across docs
  and refs.
- Nav registration in endpoints.json, menuItems.json, redirects.json.

Spec/code counterparts land under UPIIS-33/34/35.

Closes UPIIS-47
@Anindya-Pandey
Anindya-Pandey force-pushed the UPIIS-47-upi-issuance-docs branch from 3186ac2 to a6221e3 Compare July 14, 2026 04:49
@Anindya-Pandey
Anindya-Pandey merged commit 0c450b2 into staging Jul 14, 2026
@Anindya-Pandey
Anindya-Pandey deleted the UPIIS-47-upi-issuance-docs branch July 14, 2026 08:18
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.

1 participant