Concepts

Request Format

Overview

All Otonum API requests and responses use JSON format. The API follows standard REST conventions with predictable HTTP status codes.

Content-Type Header

Always set Content-Type on POST and PUT requests:

Code
Content-Type: application/json

Date Format

Dates are represented in ISO 8601 UTC format:

Code
2026-05-22T14:32:00Z

For date range filtering, use the same ISO 8601 format in query parameters.

Monetary Amounts

Monetary values are represented as decimal numbers with up to 2 fractional digits, using the currency configured for your tenant account:

Market	Currency
Canada	CAD
Cote d'Ivoire	XOF
France	EUR

Code
{
  "amount": 89.99,
  "redemptionAmount": 10.0
}

API Versioning

All endpoints are prefixed by API version. To avoid drift, use the API Reference for the canonical route of each operation.

When a new version is released, the previous version remains available during a deprecation period. See the Changelog for updates.

Error Response Format

All errors follow a consistent structure:

Code
{
  "error": "ERROR_CODE",
  "errorMessage": {
    "fr": "French description.",
    "en": "English description."
  },
  "httpStatus": "STATUS_CODE" 
}

See Error Codes for the complete list of codes and recommended handling.

See Also

• Authentication
• Best Practices
• Error Codes