Getting Started

Go from zero to your first API call in under 5 minutes.

Get your API credentials

Choose an environment:

Environment	Key prefix	Base URL
Sandbox	`exp_sand_`	`https://sandbox.expereon.com`
Production	`exp_prod_`	`https://api.expereon.com`

Save your secret immediately The API secret is shown only once at creation time. Store it securely - you cannot retrieve it later.

Make your first request

Test your credentials by listing your organization's invoices:

curl -X GET "https://sandbox.expereon.com/api/v1/invoices?page=0&limit=10" \
  -H "X-API-Key: exp_sand_xxxxxxxxxxxx" \
  -H "X-API-Secret: your-secret-key" \
  -H "Content-Type: application/json"

A successful response returns:

{
  "items": [
    {
      "id": "inv_abc123",
      "invoiceNumber": "INV-2024-001",
      "status": "SUBMITTED",
      "amount": "1500.00",
      "currency": "USD",
      "buyerOrganizationId": "org_buyer_1",
      "sellerOrganizationId": "org_seller_1",
      "dueDate": "2024-04-15",
      "createdAt": "2024-03-15T10:30:00Z"
    }
  ],
  "totalCount": 42,
  "totalPages": 5,
  "page": 0,
  "limit": 10
}

Create an invoice

Create a new invoice for a connected buyer:

curl -X POST "https://sandbox.expereon.com/api/v1/invoices" \
  -H "X-API-Key: exp_sand_xxxxxxxxxxxx" \
  -H "X-API-Secret: your-secret-key" \
  -H "Content-Type: application/json" \
  -d '{
    "connectionId": "conn_abc123",
    "invoiceNumber": "INV-2024-002",
    "amount": "2500.00",
    "currency": "USD",
    "dueDate": "2024-05-01",
    "description": "Consulting services - March 2024",
    "requestId": "unique-request-id-001"
  }'

Idempotency Always include a unique requestId. If a network error occurs, you can safely retry the same request without creating duplicate invoices.

Set up webhooks

Get notified in real-time when invoices are approved, payments settle, or other events occur. See the Webhooks guide for details.

curl -X POST "https://sandbox.expereon.com/api/v1/settings/webhooks" \
  -H "X-API-Key: exp_sand_xxxxxxxxxxxx" \
  -H "X-API-Secret: your-secret-key" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-app.com/webhooks/expereon",
    "events": ["invoice.created", "invoice.approved", "payment.settled"],
    "signingSecret": "whsec_your_signing_secret"
  }'

Core concepts

Organizations and connections

Expereon operates as a B2B network. Your organization (buyer or seller) connects with counterparties. Invoices and payments flow between connected organizations.

Before creating invoices for a buyer, you must have an active connection with their organization. Connections are established through the Expereon dashboard.

Invoice lifecycle

Status	Description	Available actions
`DRAFT`	Invoice created but not sent	Submit, Delete
`SUBMITTED`	Sent to buyer for review	Approve, Dispute, Cancel
`APPROVED`	Buyer accepted the invoice	Settle (pay)
`DISPUTED`	Buyer raised a dispute	Resolve via notes/adjustment
`SETTLED`	Payment completed	View confirmation
`CANCELLED`	Invoice voided	—

Authentication

Every request must include both the API key and secret in headers:

X-API-Key: exp_prod_xxxxxxxxxxxx
X-API-Secret: your-secret-key

Sandbox keys (exp_sand_) work only against sandbox.expereon.com. Production keys (exp_prod_) work only against api.expereon.com.

Pagination

All list endpoints accept page (0-based) and limit (max 100) query parameters.

GET /api/v1/invoices?page=0&limit=25&sortBy=createdAt&sortOrder=desc

Idempotency

All write operations accept an optional requestId field. If you send the same requestId twice, the API returns the original response without side effects. Use UUIDs or your own unique identifiers.

Next steps Explore the full API Reference for all available endpoints, set up Webhooks for event-driven integrations, and review the Error handling guide.