Download OpenAPI / Postman

OpenAPI (Swagger) specifications

Import these URLs directly into Swagger UI, Postman, Insomnia, or any OpenAPI-compatible code generator.

Environment	OpenAPI JSON URL
Sandbox	https://api.test.devs.beadpay.io/apidocs/v1/api.json
Production	https://api.devs.beadpay.io/apidocs/v1/api.json

Quick-start

1. In your tool, choose Import from URL and paste the link for the environment you’re targeting.

2. Set the request base-URL to • https://api.test.devs.beadpay.io for sandbox • https://api.devs.beadpay.io for production

3. Add the header Authorization: Bearer <access_token> before sending any call.

Versioning

• The info.version field in every spec is currently "v1".

• Non-breaking additions (new endpoints or optional fields) are released under the same v1 tag.

• Breaking changes will trigger a new major version (v2) and will be announced in the changelog.

---

Postman collections

Coming soon – downloadable Postman collections for both environments will be published here.

In the meantime, you can import either JSON URL above into Postman’s API Importer to generate a collection automatically.