Get Orders

Retrieve all orders for your partner account

GET

texttext

/api/v2/orders

Retrieves a paginated list of all orders associated with your partner account.

Request Headers

apiKeystringrequired

Your public API key (query parameter or header)

Query Parameters

pageintegerDefault: 1

Page number for pagination

limitintegerDefault: 20

Number of results per page (max 100)

statusstring

Filter by order status (PROCESSING, COMPLETED, FAILED, CANCELLED)

sortBystringDefault: createdAt

Sort field (createdAt, updatedAt, fiatAmount)

orderstringDefault: desc

Sort order (asc or desc)

Response Schema

dataarray

Array of order objects

data[].idstring

Unique OZZOBiT order ID

data[].partnerOrderIdstring | null

Your reference ID for this order

data[].statusstring

Current order status

data[].fiatCurrencystring

Fiat currency code

data[].fiatAmountnumber

Fiat amount

data[].cryptoCurrencystring

Cryptocurrency code

data[].cryptoAmountnumber

Crypto amount

data[].networkstring

Blockchain network

data[].walletAddressstring

Destination wallet address

data[].fromWalletAddressstring | null

Source wallet (off-ramp only)

data[].createdAtstring

ISO 8601 timestamp of creation

data[].completedAtstring | null

ISO 8601 timestamp of completion

paginationobject

Pagination metadata (totalItems, totalPages, currentPage)

Example Request

request.shbash

curl -X GET "https://OZZOBiT.com/api/api/v2/orders?apiKey=YOUR_KEY&page=1&limit=10&status=COMPLETED"

Example Response

response.jsonjson

{
  "data": [
    {
      "id": "OZZOBiT-order-abc123",
      "partnerOrderId": "ORDER-1705312345",
      "status": "COMPLETED",
      "fiatCurrency": "USD",
      "fiatAmount": 100.00,
      "cryptoCurrency": "ETH",
      "cryptoAmount": 0.045231,
      "network": "ethereum",
      "walletAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f8bD21",
      "fromWalletAddress": null,
      "createdAt": "2024-01-15T10:30:00Z",
      "completedAt": "2024-01-15T10:32:15Z"
    }
  ],
  "pagination": {
    "totalItems": 42,
    "totalPages": 5,
    "currentPage": 1,
    "perPage": 10
  }
}