OpenAPI & API Explorer

Payscribe publishes its API definition from the same application that serves the API. This avoids maintaining a second, stale specification inside the documentation site.

Interactive API Explorer

Use the explorer to inspect endpoint schemas, authentication requirements, request bodies, response envelopes, and the sandbox or live server URL.

• Open the sandbox API Explorer
• Open the live API Explorer

The explorer is powered by Scalar and reads the canonical OpenAPI file described below. Select Sandbox before testing an integration.

Download the machine-readable contract

Use this YAML file to generate a typed client, import a collection into an API client, or lint requests in CI:

• Download OpenAPI YAML

The sandbox and live explorers use the same public contract. Environment-specific credentials, webhook URLs, IP allowlists, and data remain separate.

Safe use

1. Start with the Sandbox environment.
2. Authenticate with a dashboard-issued ps_pk_test_... key.
3. For a state-changing endpoint, give every business action a unique ref and reconcile the final result.
4. Move to a ps_pk_live_... key only after completing the go-live checklist.

Contract changes

The OpenAPI specification describes the API version deployed at the time you retrieve it. Pin a reviewed copy in your own CI process when generating an SDK, and re-review it when upgrading your integration.