Skip to content

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.

MethodEndpointPurposeAuthentication
POST/api/auth/vendor/loginMerchant loginCredentials
POST/api/auth/vendor/refresh-tokenRefresh merchant tokenRefresh token
GET/api/integrationsList keysVendor JWT
POST/api/integrationsCreate keyVendor owner JWT
GET/api/integrations/{id}Key detailsVendor JWT
DELETE/api/integrations/{id}Revoke keyVendor owner JWT
POST/api/integrations/{id}/rotateRotate key; preserve webhook settingsVendor owner JWT
POST/api/integration/paymentPayment; required Idempotency-KeyIntegration API key
GET/api/integration/balanceMerchant balanceIntegration API key
GET/api/integration/transactionsHistory with exact offsetIntegration API key
POST/api/integration/smsCapture simulated SMS in the merchant inboxSandbox integration API key
GET/api/integration/payments/{reference}Payment or refund statusIntegration API key
GET/api/integration/payments/by-key/{key}Payment status by saved retry keyIntegration API key
POST/api/integration/payments/{reference}/refundFull-principal refund; required Idempotency-KeyIntegration API key
GET/api/integration/webhookRead webhook settingsIntegration API key
PUT/api/integration/webhookConfigure URL; return new signing secret onceIntegration API key
DELETE/api/integration/webhookStop new eventsIntegration API key
GET/api/integration/webhook/eventsDelivery status and failuresIntegration API key
POST/api/integration/webhook/events/{id}/retryRetry failed deliveryIntegration API key
POST/api/integration/sandbox/fixturesIsolated test customers and receiverIntegration API key
POST/api/integration/sandbox/migration-rehearsalCredential and replay-history portability checkIntegration API key
POST/api/integration/sandbox/fundsRefill simulated funds; required Idempotency-KeySandbox integration API key
GET/api/integration/sandbox/messagesRead your captured SMS inboxSandbox 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.

Sandbox Swagger · Sandbox OpenAPI

Keshless payment integration documentation