Skip to documentationDocumentation
On this page

invoice.detected

Deposit seen on chain, confirmations pending.

A payment was first observed on the network. It has not yet been accepted and can disappear before confirmation.

When to use it#

Use payment_id and tx_identity to correlate the observation, and amount_observed to display progress. Do not credit a customer or fulfill an order from this event. GET the invoice to read its associated payments and current status.

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.detected" · 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.payment_id · string · Required

    Format: uuid

  • data.currency · string · Required

    —

  • data.network · string · Required

    —

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

    —

  • data.amount_observed · string · Required

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

  • data.tx_identity · string · Required

    —

  • data.observed_at · string · Required

    Format: date-time

Example — version 1#

json example
{
  "id": "00000000-0000-0000-0000-000000000001",
  "event_seq": 184203,
  "type": "invoice.detected",
  "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",
    "payment_id": "00000000-0000-0000-0000-000000000005",
    "currency": "USDC",
    "network": "ethereum",
    "environment": "live",
    "amount_observed": "10.00",
    "tx_identity": "0x0000000000000000000000000000000000000000000000000000000000000001:0",
    "observed_at": "2026-09-14T10:00:00Z"
  }
}

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