This documentation is currently under development. Certain sections are not yet complete and will be added shortly.
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Receipt

Download receipt as PDF

get
/api/{tenantId}/receipts/{token}/pdf

Retrieves a transaction receipt in PDF format using a secure signed token.

Token-Based Security

The token is a JWT containing:

  • receiptProvider: Source system identifier (e.g., "cegid", "shopify")

  • receiptNumber: Transaction/receipt identifier

  • storeId: Optional store context

Receipt Providers

System supports multiple providers:

  • POS system integrations

  • E-commerce platforms

  • Custom receipt generators

Token Generation

Tokens must be generated server-side using the security token generator with appropriate claims.

Use Cases

  • Email receipt links

  • Customer portal receipt downloads

  • Embedded receipts in passes

  • Order history displays

Security

  • Tokens are time-limited and signed

  • Cannot be forged or tampered with

  • Single-use recommended for sensitive transactions

Path parameters
tokenstringRequired

JWT containing receiptProvider, receiptNumber, and optional storeId claims.

tenantIdstringRequired
Responses
200

Receipt PDF returned

string · binaryOptional
get/api/{tenantId}/receipts/{token}/pdf

Last updated