Skip to content

docs: add PSQ and subscription HMAC to README (#155509) - #27

Merged
ankitottu merged 1 commit into
mainfrom
task/155509
Jun 12, 2026
Merged

ankitottu merged 1 commit into
mainfrom
task/155509

Conversation

@ankitottu

Copy link
Copy Markdown
Contributor

Summary

  • Add #### Payment Status Query (PSQ) section under Operations (after Void) with session_id and order_id examples
  • Expand ### Webhook Verification with dual-scheme explanation (18-field standard + 26-field subscription fallback)
  • Add #### Subscription / Autopay Webhooks subsection documenting calculate_subscription_hmac_signature with a realistic nested payload example
  • Fix pre-existing typo: recieved → received in existing verify_signature example
  • Fix pre-existing doc bug in Cancel section: order_no → order_id (wrong parameter name in intro text)

Closes #155509 on Redmine (ottu-py project).

Test plan

  • Read through README PSQ section — examples match session.psq(session_id, order_id) signature
  • Read through Webhook Verification section — dual-scheme note is clear, typo is gone
  • Read through Subscription subsection — calculate_subscription_hmac_signature(payload, hmac_key) parameter names match source
  • Confirm 8 extra subscription fields listed at the bottom match _SUBSCRIPTION_SIGNED_FIELDS in src/ottu/utils/webhooks.py

- Add Payment Status Query (PSQ) section under Operations (after Void)
- Fix Cancel section intro: order_no → order_id (param name was wrong)
- Expand Webhook Verification intro with dual-scheme explanation
- Fix typo: recieved → received in existing verify_signature example
- Add Subscription / Autopay Webhooks subsection with
  calculate_subscription_hmac_signature usage and 26-field list
@ankitottu
ankitottu merged commit f8f9852 into main Jun 12, 2026
4 checks passed
@ankitottu
ankitottu deleted the task/155509 branch June 12, 2026 09:54
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