Overview

This document describes the key features and integration process for the OOZOO PAY API.

OOZOO PAY API Features

OOZOO PAY provides a REST API and JavaScript SDK for merchants to easily integrate cryptocurrency payments.

• Payment API: Process cryptocurrency payments through invoice creation and lookup
• Withdrawal API: Request and track withdrawals from project balance to external wallets
• Webhooks: Receive payment completion events in real-time
• SDK: Easily display payment UI on the frontend

API Integration

Item	Description
Protocol	HTTPS (TLS 1.2+)
Data Format	JSON (application/json; charset=utf-8)
Authentication	HMAC-SHA256 Signature

API Endpoints

Category	Function	Method	Path
Payment	Create Invoice	POST	/api/invoices
Payment	List Invoices	GET	/api/invoices
Payment	Get Invoice	GET	/api/invoices/{invoiceId}
Withdrawal	Create Withdrawal	POST	/api/invoices/withdrawals
Withdrawal	List Withdrawals	GET	/api/invoices/withdrawals
Withdrawal	Get Withdrawal	GET	/api/invoices/withdrawals/{withdrawalId}
Webhook	Get Webhook Logs	GET	/api/webhook-logs

Endpoint

https://api.oozoo.com

This is the Base URL for all API requests. The full request URL is constructed by combining the Base URL with the API path.

https://api.oozoo.com/api/invoices

API Key Issuance

To integrate with the API, you must obtain an API Key from the OOZOO PAY Merchant Dashboard.

1. Log in to the dashboard.
2. Select a project → Navigate to Developers → API Keys.
3. Click Create New API Key.
4. Securely store the issued Client Key (pk_) and Secret Key (sk_).

Secret Key Storage

The Secret Key is displayed only once at creation. If lost, you must issue a new one. Always use it server-side only and never expose it externally.

Test Environment

OOZOO PAY does not provide a separate sandbox environment. For testing, create a Test Mode Project on the dashboard to verify integration on blockchain testnets.

Mode	Blockchain Network	Note
Test	Testnet (Sepolia, etc.)	-
Live	Mainnet (Ethereum, etc.)	-

The API Key format is the same regardless of mode (pk_, sk_). The connected blockchain network changes based on the project's mode setting.

tip

Complete your integration testing in test mode before switching to a live mode project.

Integration Steps

The typical integration process is as follows:

1. Issue API Key — Create a project on the dashboard and obtain your API Key.
2. Implement Authentication — Refer to the Authentication guide to implement HMAC signature logic.
3. Payment Integration — Use the SDK or API to implement invoice creation and payment flow.
4. Webhook Setup — Refer to the Webhooks guide to receive payment completion events.
5. Testing — Verify the complete payment flow in test mode.
6. Go Live — Switch to a live mode project to start processing real payments.