API reference

Application root

The Kollect backend mounts routes at the application root (no global /api/v1-style prefix in the server entrypoint). All paths in this documentation are relative to your deployment host.

Example

Environment
Base URL

Sand box environment

https://kollect-backend-stage-qr574.ondigitalocean.app

Replace <your-kollect-backend-host> with the hostname your platform team provides.

Sandbox vs production

The codebase does not define separate “sandbox” and “production” base URLs by convention. Instead, environment separation is typically achieved through:

  • Different deployments (staging vs production hosts), and/or

  • Testnet token identifiers in invoiceCurrency and paymentCurrency (for example Sepolia variants).

See Testing & sandbox for allowed currency strings suitable for non-production testing.

Full URL examples

Resource
Example path

S2S create payment

POST SandBox-environment /sdk/server/create-payment

Profile webhook config (Firebase auth)

POST SandBox-environment

/profile/webhook

TLS

Production integrations should use HTTPS for all traffic. Webhook URLs must be reachable by Kollect’s outbound HTTP client over the public internet (or your agreed network path).

Last updated

Was this helpful?