API Reference

Use this page as a map of customer-facing API families. Exact access depends on your SenteRail account, onboarding status, commercial approval, and enabled products.

Public API Families

API family	Typical user	Purpose
Authentication	Merchant, plugin, partner	Obtain or use the credential required by your flow
Merchant checkout	MSMEs, merchants, plugins	Create payment sessions and track status
Merchant account tools	Approved merchants	Manage account-specific developer settings
Sandbox	External developers	Test success, failure, timeout, and webhook scenarios
Partner APIs	Approved partners	Use partner-specific enabled products
Webhooks	All integrators	Receive signed event updates

Internal SenteRail operator routes, service-key routes, and back-office settlement commands are not part of the public API reference.

OpenAPI Contract

The OpenAPI explorer is available at OpenAPI. Treat the explorer as endpoint-level detail and this page as the implementation map.

Availability

An endpoint appearing in documentation does not guarantee access for every account. Your account configuration controls which products, environments, and credentials are available.

Use the Go-live checklist before sending production traffic.

Common Integration Order

1. Choose the right path in Choose your integration path.
2. Confirm credentials in Authentication.
3. Build the first test case with Sandbox quickstart.
4. Add idempotency from Idempotency.
5. Verify events with Webhooks.
6. Confirm support, legal, and reconciliation ownership before launch.

Troubleshooting

• A 401 usually means the credential type, environment, or account access is wrong.
• A 403 usually means the credential is valid but the product or permission is not enabled.
• A 404 can mean the path family is wrong for your account or environment.
• A duplicate request should use the same idempotency key, not a new payment reference.

Read Errors for a customer-safe error-handling guide.