OpenAPI Specification

Download the OpenAPI specification (JSON)

The specification describes Ledyer’s public Checkout, Payments, Headless, Order Management, and Settlement APIs in Swagger/OpenAPI 2.0 format. Use it with compatible API clients, code generators, and AI tools.

The specification is refreshed from the API documentation on every site build and includes only public operations and the schemas they reference.

Environments and authentication

The specification defaults to the sandbox environment:

• API base URL: https://api.sandbox.ledyer.com
• OAuth token URL: https://auth.sandbox.ledyer.com/oauth/token

For live requests, configure your API client to use:

• API base URL: https://api.live.ledyer.com
• OAuth token URL: https://auth.live.ledyer.com/oauth/token

See Authentication for the OAuth 2.0 client credentials flow and Environments for environment details.

Use the integration guides alongside the specification for client-side SDKs, notifications, and payment flow guidance.

For ready-to-copy integration prompts for your coding assistant, see Build with AI.