FundamentalsSandbox
Sandbox
Base URL, headers, and expectations for building and testing Conomy flows before production.
Sandbox is the environment for testing authentication, resource creation, payment payloads, lifecycle transitions, and webhook handling before production traffic.
| Item | Value |
|---|---|
| Base URL | https://api.conomyhq.com/sandbox |
| Auth endpoint | POST /auth |
| Version header | conomyhq-api-version: 24-04-2025 |
| Payload format | JSON |
Use sandbox to validate request shape and lifecycle handling. Do not treat sandbox processing times as production settlement guarantees.
Credentials
Section titled “Credentials”Your sandbox credentials — clientId, clientSecret, and x-api-key — are available in the Sandbox Dashboard. Log in, navigate to Settings → API Keys to retrieve them.
Use clientId and clientSecret in POST /auth to obtain an access token. Include x-api-key as a header on every subsequent request.
What to test
Section titled “What to test”- Authentication and token refresh.
- Identity, account, and customer creation.
- Available products for the country and currency pair.
- Payment creation and capture.
- Webhook delivery and idempotency.
- Error handling and retry behavior.
Simulating payment receipt
Section titled “Simulating payment receipt”Payments in sandbox stay in CAPTURED indefinitely because no real provider transfers funds. Use POST /simulate/payment to fire a synthetic webhook that advances the transaction to SETTLED — the same path a real payment takes.
See Simulate a payment for the full flow.
Recommended path
Section titled “Recommended path”Start with Recipes, then use Transaction builder when you need to create a valid payment payload for a specific business intent.