OutpayDocs
Getting started

Environments

Separate test and live credentials, and configure your deployment's base URL.

The public API route prefix is /api/v1. Outpay does not publish a canonical hosted API hostname — configure the origin of your own Outpay deployment rather than copying a placeholder host into a production integration.

OUTPAY_API_BASE_URL=https://your-outpay-host.example
OUTPAY_API_KEY=ck_test_...

Test and live keys

API keys carry test or live in both their token format and their database record. Keep each environment's key, webhook secret, database, and merchant wallet configuration separate.

EnvironmentUseStatus
test keyControlled integration testingAvailable in the key model; a separate sandbox network is not implemented
live keyProduction-style merchant configurationAvailable in the key model; production readiness is not independently verified

No sandbox network

Both test and live keys authenticate against the same Base-mainnet payment matcher. A test key changes which credential is in play — it is not evidence of a separate test blockchain. Do not send real funds while validating an integration unless you intend for them to settle.

Server configuration

The application resolves its database connection in this order: DATABASE_URL, then DATABASE_PUBLIC_URL, then the individual PostgreSQL component variables. Worker deployments additionally require Redis and blockchain-provider configuration. See environment variables for the full operator inventory.

On this page