Skip to main content

Overview

Base URL: https://orders.balaipedia.com/v1. All requests and responses are JSON over HTTPS (plain HTTP is not available). Send Content-Type: application/json on requests with a body. Timestamps are ISO 8601 UTC. Amounts are in your account currency. Only GET and POST are used.
The API is for server-to-server use only. Never put your API key in browser or mobile app code.

Endpoints at a glance

Response conventions

  • Every response from the API is JSON, including errors, unknown URLs and wrong HTTP methods. Responses carry an X-Request-Id header (same value as request_id in error bodies). The only HTML page is the documentation.
  • Platform failures. In rare cases a failure can happen before your request reaches our application (for example a gateway or network outage). Such a 5xx response may not be JSON. Always check the HTTP status first and parse the body only if it is JSON. Treat any 5xx or network timeout as retryable (see Retries).
  • Success responses return the object directly (no wrapper). Error responses always return {"error":{"code","message","request_id"}} (see Errors); branch on code, never on message.
  • Fields documented as nullable are always present and are null when there is no value yet (for example completed_at on an order that is still processing). Fields are never omitted or undefined.
  • Responses contain only information about your own orders and account. No internal or third-party system details are ever included.
  • CORS is not enabled: call the API from your server, not from a browser.

Quickstart

Create your first order.

Authentication

Authenticate with your API key.

Webhooks

Receive order status changes.

Errors and limits

Error codes, rate limits and retries.