Public API Endpoints

Getting started with the OZZOBiT Public API

The OZZOBiT Public API provides read-only endpoints for fetching reference data including supported countries, currencies, payment methods, exchange quotes, and order information. These endpoints use your public API key for authentication.

Base URL

texttext
// Production
https://OZZOBiT.com/api/api/v2

// Staging/Sandbox  
https://staging-OZZOBiT.com/api/api/v2

Authentication

Include your public API key as a query parameter:

texttext
GET /api/v2/countries?apiKey=YOUR_PUBLIC_API_KEY
ℹ️
Public vs Secret Key

The Public API uses your public API key (safe for client-side code). The Whitelabel API requires your secret key and access tokens (server-side only).

Available Endpoints

EndpointMethodDescription
/ordersGETList all orders for your partner account
/orders/:idGETGet details of a specific order
/crypto-currenciesGETList all supported cryptocurrencies
/fiat-currenciesGETList all supported fiat currencies
/countriesGETList all supported countries with features
/payment-methodsGETList available payment methods by country
/lookup/quotePOSTGet real-time exchange rate quote
/wallet/verifyPOSTVerify a wallet address format

Error Responses

All endpoints follow a consistent error format:

error-response.jsonjson
{
  "error": {
    "code": "INVALID_API_KEY",
    "message": "The provided API key is invalid or expired",
    "status": 401
  }
}
HTTP StatusError CodeDescription
400BAD_REQUESTInvalid or missing parameters
401UNAUTHORIZEDInvalid or missing API key
403FORBIDDENAccess denied - IP not whitelisted
404NOT_FOUNDResource not found
429RATE_LIMITEDToo many requests - slow down
500INTERNAL_ERRORServer error - try again later