invoice.expired

The invoice's unpaid payment window expired. This event does not credit or debit funds.

Versions and processing# #

Version 1 describes the crypto payment case. Version 2 can describe an unactivated fiat nomination and includes amount_basis. Accept the versioned contract your endpoint receives instead of assuming every expiry has a selected crypto network.

Close the unpaid order, but retain the invoice mapping: a later accepted payment can produce a late-payment event and, with automatic completion enabled, a paid/overpaid event.

Schema version 1# #

Fields are taken from the public OpenAPI contract. Required nullable fields must be present and may contain null.

• id · string · Required

  Stable event UUID for merchant-side idempotency. · Format: uuid

• event_seq · integer · Required

  Global event sequence. Gaps are possible; it does not establish delivery or processing order. · Format: int64

• type · "invoice.expired" · Required

  —

• schema_version · 1 · Required

  —

• environment · "live" | "test" · Required

  —

• merchant_id · string · Required

  Format: uuid

• subject_type · "invoice" · Required

  —

• subject_id · string · Required

  Format: uuid

• occurred_at · string · Required

  Canonical business occurrence timestamp. · Format: date-time

• data · object · Required

  Unknown properties are rejected

• data.invoice_id · string · Required

  Format: uuid

• data.external_id · string | null · Required

  —

• data.currency · string · Required

  —

• data.network · string · Required

  —

• data.environment · "live" | "test" · Required

  —

• data.amount_requested · string · Required

  Format: decimal · Pattern: ^\d+(.\d+)?$

• data.amount_paid · string · Required

  Format: decimal · Pattern: ^\d+(.\d+)?$

• data.status · "expired" · Required

  —

• data.expires_at · string · Required

  Format: date-time

Example — version 1# #

{
  "id": "00000000-0000-0000-0000-000000000001",
  "event_seq": 184203,
  "type": "invoice.expired",
  "schema_version": 1,
  "environment": "live",
  "merchant_id": "00000000-0000-0000-0000-000000000002",
  "subject_type": "invoice",
  "subject_id": "00000000-0000-0000-0000-000000000003",
  "occurred_at": "2026-09-14T10:00:00Z",
  "data": {
    "invoice_id": "00000000-0000-0000-0000-000000000003",
    "external_id": null,
    "currency": "USDC",
    "network": "ethereum",
    "environment": "live",
    "amount_requested": "25.00",
    "amount_paid": "0",
    "status": "expired",
    "expires_at": "2026-09-14T10:00:00Z"
  }
}

Schema version 2# #

Fields are taken from the public OpenAPI contract. Required nullable fields must be present and may contain null.

• id · string · Required

  Stable event UUID for merchant-side idempotency. · Format: uuid

• event_seq · integer · Required

  Global event sequence. Gaps are possible; it does not establish delivery or processing order. · Format: int64

• type · "invoice.expired" · Required

  —

• schema_version · 2 · Required

  —

• environment · "live" | "test" · Required

  —

• merchant_id · string · Required

  Format: uuid

• subject_type · "invoice" · Required

  —

• subject_id · string · Required

  Format: uuid

• occurred_at · string · Required

  Canonical business occurrence timestamp. · Format: date-time

• data · object · Required

  A fiat-nominated invoice expired without a payment gate being selected. · Unknown properties are rejected

• data.invoice_id · string · Required

  Format: uuid

• data.external_id · string | null · Required

  —

• data.currency · "USD" | "EUR" · Required

  —

• data.network · "" · Required

  —

• data.environment · "live" | "test" · Required

  —

• data.amount_requested · string · Required

  Format: decimal · Pattern: ^\d+(.\d+)?$

• data.amount_paid · "0" · Required

  —

• data.status · "expired" · Required

  —

• data.expires_at · string · Required

  Format: date-time

• data.amount_basis · "requested_fiat" · Required

  —

Example — version 2# #

{
  "id": "00000000-0000-0000-0000-000000000001",
  "event_seq": 184203,
  "type": "invoice.expired",
  "schema_version": 2,
  "environment": "test",
  "merchant_id": "00000000-0000-0000-0000-000000000002",
  "subject_type": "invoice",
  "subject_id": "00000000-0000-0000-0000-000000000003",
  "occurred_at": "2026-09-14T10:00:00Z",
  "data": {
    "invoice_id": "00000000-0000-0000-0000-000000000003",
    "external_id": null,
    "currency": "USD",
    "network": "",
    "environment": "test",
    "amount_requested": "25.00",
    "amount_paid": "0",
    "status": "expired",
    "expires_at": "2026-09-14T10:00:00Z",
    "amount_basis": "requested_fiat"
  }
}

See delivery and envelope, signature verification, and business processes.