BursaPay Logo
Knowledge Base
Ticket Sign In
Help Center > Developer Platform & Gateway API > OpenAPI Schema and Interactive API Documentation

OpenAPI Schema and Interactive API Documentation

Published 2026-08-24 5 min read
Who is this article for?
This guide is for Developers, Engineering Teams, Platform Operators seeking operational guidance on BursaPay workflows.

UI Navigation Path (Step-by-Step)

  1. Read the endpoint documentation.
  2. Confirm HTTP method, path, authentication and required fields.
  3. Test the example request in Test Mode.
  4. Generate or validate client code against the OpenAPI contract where appropriate.
Verified BursaPay workflow: Use the public API documentation and OpenAPI contract to build accurate integrations.

1. Overview & Purpose

BursaPay publishes API documentation for v1 endpoints and exposes an interactive documentation surface with schemas and request examples.

2. Requirements & Setup

Developers should build against the documented version and verify endpoint schemas before coding.

3. Step-by-Step Workflow

  1. Read the endpoint documentation.
  2. Confirm HTTP method, path, authentication and required fields.
  3. Test the example request in Test Mode.
  4. Generate or validate client code against the OpenAPI contract where appropriate.

4. Rules & Troubleshooting

Documentation examples are versioned product contracts; do not infer unsupported fields from unrelated payment providers.

5. Verification & Next Steps

Pin your integration to the documented API version and review the changelog before upgrades.

Was this article useful?

Related Articles

Developer Webhook Event Catalog Gateway API Changelog and Upgrade Discipline
Ask Bursa AI