API design
- Protocol — HTTPS only. All requests must be made over TLS.
- Format — JSON request and response bodies throughout. Set
Content-Type: application/jsonon all requests with a body. - Authentication — Bearer token via OAuth 2.0 Client Credentials. Include it on every request:
- IDs — All resource identifiers are UUIDs (e.g.
paymentId,provider.Id). - Timestamps — All timestamps are in ISO 8601 format (
2024-01-15T10:30:00Z).
Base URLs
| Environment | Base URL |
|---|---|
| Sandbox | https://api-sandbox.kashimi.tech |
| Production | https://api.kashimi.tech |
Versioning
The current API version isv1. The version is included in every endpoint path:
Rate limiting
If you exceed the allowed request rate, the API returns429 Too Many Requests. Implement exponential backoff and retry logic in your integration. Contact the Kashimi team if you need higher rate limits for your use case.
Ready to start building? Head to Start Here for prerequisites, credentials setup, and a step-by-step integration walkthrough.