Skip to content

Documentation: API.md does not document the sep7_uri field or SEP-0007 URI format #960

Description

@henrypeters

Category: Documentation - API Reference
Priority: Medium
Estimated Time: 1 hour

Description:
The sep7_uri field in PaymentRequestView (built in src/api/payment_requests.rs) is the SEP-0007 web+stellar:pay URI — the exact payload a frontend encodes into a QR code. This field is the core of the QR payment flow, yet API.md may not explain:

  1. The exact URI format: web+stellar:pay?destination=...&amount=...&memo=...&memo_type=MEMO_TEXT
  2. That sep7_uri is null for non-XLM assets (cNGN) with an explanation of why
  3. That the amount in the URI is in XLM decimal notation (not stroops)
  4. Which SEP-0007 fields are included and which optional ones are omitted

Tasks:

  • Add a dedicated section in API.md explaining the sep7_uri field with a concrete example
  • Document the null case for non-XLM assets
  • Add a note about QR code generation
  • Update openapi.yaml to document the nullable field with an example
  • Cross-reference the SEP-0007 spec

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programapidocumentationImprovements or additions to documentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions