Appearance
Payment integration endpoints
Send sandbox requests to https://sandbox-api.keshless.com with sandbox credentials. Existing integrations retain their current URLs and credentials. Live activation is separate from sandbox testing.
| Method | Endpoint | Purpose | Authentication |
|---|---|---|---|
| POST | /api/auth/vendor/login | Merchant login | Credentials |
| POST | /api/auth/vendor/refresh-token | Refresh merchant token | Refresh token |
| GET | /api/integrations | List keys | Vendor JWT |
| POST | /api/integrations | Create key | Vendor owner JWT |
| GET | /api/integrations/{id} | Key details | Vendor JWT |
| DELETE | /api/integrations/{id} | Revoke key | Vendor owner JWT |
| POST | /api/integrations/{id}/rotate | Rotate key; preserve webhook settings | Vendor owner JWT |
| POST | /api/integration/payment | Payment; required Idempotency-Key | Integration API key |
| GET | /api/integration/balance | Merchant balance | Integration API key |
| GET | /api/integration/transactions | History with exact offset | Integration API key |
| POST | /api/integration/sms | Capture simulated SMS in the merchant inbox | Sandbox integration API key |
| GET | /api/integration/payments/{reference} | Payment or refund status | Integration API key |
| GET | /api/integration/payments/by-key/{key} | Payment status by saved retry key | Integration API key |
| POST | /api/integration/payments/{reference}/refund | Full-principal refund; required Idempotency-Key | Integration API key |
| GET | /api/integration/webhook | Read webhook settings | Integration API key |
| PUT | /api/integration/webhook | Configure URL; return new signing secret once | Integration API key |
| DELETE | /api/integration/webhook | Stop new events | Integration API key |
| GET | /api/integration/webhook/events | Delivery status and failures | Integration API key |
| POST | /api/integration/webhook/events/{id}/retry | Retry failed delivery | Integration API key |
| POST | /api/integration/sandbox/fixtures | Isolated test customers and receiver | Integration API key |
| POST | /api/integration/sandbox/migration-rehearsal | Credential and replay-history portability check | Integration API key |
| POST | /api/integration/sandbox/funds | Refill simulated funds; required Idempotency-Key | Sandbox integration API key |
| GET | /api/integration/sandbox/messages | Read your captured SMS inbox | Sandbox integration API key |
Key management requires vendorId as described in payments and keys. Payment and refund POSTs require a saved Idempotency-Key. Consult the request schema and quick start before testing.