API Reference Latest 6 min read

API Overview and Architecture

admin

Base URLs

All API requests use HTTPS. There are two environments:

Environment Base URL Purpose
Sandbox https://sandbox-api.aelix.digitalapi.ai Development and testing — no real transactions
Production https://api.aelix.digitalapi.ai Live environment — real data and transactions

Request Conventions

  • Content-Type: application/json for all request bodies
  • Accept: application/json
  • Encoding: UTF-8
  • Date/time: ISO 8601 with timezone (2025-04-15T14:30:00Z)
  • Currency amounts: Minor units (pence/cents) as integers — 2550 = £25.50
  • IDs: Opaque strings prefixed by resource type — acc_, pay_, txn_

Response Envelope

All responses wrap data in a consistent structure:

{
"data": { ... }, // Resource object or array
"meta": { // Additional metadata
"request_id": "req_abc123",
"api_version": "2025-04-01"
},
"links": { // Hypermedia links (collection responses)
"self": "...",
"next": "..."
}
}

Supported Protocols

  • REST — JSON over HTTPS (primary)
  • AsyncAPI / Webhooks — Event-driven push notifications
  • GraphQL — Available on selected data APIs (beta)