API Reference
HSRC Pay REST API versions and navigation.
This section covers HTTP endpoint schemas, parameters, and example responses. For conceptual guides (lifecycle, 3DS, routing, dashboard), use Documentation.
How to read this section
- Hand-written pages: this index and the v1 index.
- Generated pages: files such as
v1/createPayment.mdxandv1/confirmPayment.mdxare produced from OpenAPI (apps/homepage/openapi/v1.json); do not edit them directly. Regenerate withscripts/generate-docs.tswhen the schema changes.
Getting started
- Choose the v1 group.
- Open the relevant operation page.
- Try it with sandbox credentials.
Important operation notes
| Topic | Detail |
|---|---|
| Confirm | POST /v1/payments/:id/confirm body: payment_method, routing_strategy, payer_identity |
| Confirm response | data.payment + data.confirmResult (paymentNextAction for 3DS) |
| Create payment | Initial status CREATED |
| Payment list/detail | include_charges, include_events, include_routing_plans, include_customer query flags |
| Charge detail | include_attempt_details (aligned with dashboard) |