REST API Guide

This guide covers the request/response format and common rules for the OOZOO PAY REST API.

Endpoint

All API requests use the following Base URL.

https://api.oozoopay.com

The full request URL is constructed by combining the Base URL with the API path.

https://api.oozoopay.com/api/invoices

Test Environment

No separate sandbox environment is provided. For testing, create a Test Mode Project on the Merchant Dashboard to verify integration on blockchain testnets.

Request Format

Item	Value
Protocol	HTTPS (TLS 1.2+)
Content-Type	application/json; charset=utf-8
Encoding	UTF-8

All requests must include Authentication headers (X-Client-Key, X-Timestamp, X-Signature).

Response Format

All responses are wrapped in a standard envelope format.

Success Response

{
  "success": true,
  "data": {
    "invoiceId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

List Response

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "status": "CONFIRMED",
        "type": "DEPOSIT",
        "amount": "0.05",
        "price": "100.00",
        "unit": "usd"
      }
    ],
    "meta": {
      "total": 100,
      "page": 1,
      "limit": 20,
      "totalPages": 5,
      "hasNext": true,
      "hasPrev": false
    }
  }
}

Error Response

{
  "success": false,
  "code": "PROJECT_INVOICE_NOT_FOUND",
  "message": "Invoice not found"
}

Error responses include a code field that can be used to identify the error type. See the Error Codes documentation for a complete list.

HTTP Status Codes

Code	Description
200 OK	Request successful
201 Created	Resource created successfully
400 Bad Request	Invalid request (parameter error)
401 Unauthorized	Authentication failed (invalid signature, expired key)
404 Not Found	Resource not found
409 Conflict	Resource state conflict
500 Internal Server Error	Internal server error

Pagination

List APIs support page-based pagination. Use the following query parameters to specify the page.

Parameter	Type	Default	Description
page	number	1	Page number (starts from 1)
limit	number	20	Items per page (max 100)

The response meta object contains pagination information.

Field	Type	Description
total	number	Total number of items
page	number	Current page number
limit	number	Items per page
totalPages	number	Total number of pages
hasNext	boolean	Whether next page exists
hasPrev	boolean	Whether previous page exists