Skip to main content
POST

Authorizations

Authorization
string
header
required

Organization API key. Use a write-scoped key for event ingestion.

Body

application/json

Submit one event, a bare array of events, or the backward-compatible events wrapper.

entity_id
string
required

Target identifier. Its entity type is derived from the selected flow.

Minimum string length: 1
flow
enum<string>
required

Monitoring flow that defines the expected evidence sequence.

Available options:
payment_to_wallet,
payment_to_order,
wallet_to_wallet,
wallet_to_payout
reference
string
required

Stable local business reference supplied by the producer.

Minimum string length: 1
type
enum<string>
required

Lifecycle event type, such as payment.succeeded.

Available options:
order.fulfilled,
payment.failed,
payment.initiated,
payment.succeeded,
payout.failed,
payout.initiated,
payout.succeeded,
wallet.credited,
wallet.debited,
wallet.refunded
amount
string

Decimal amount in the event currency.

Pattern: ^(0|[1-9][0-9]*)(\.[0-9]+)?$
causation_id
string

Optional opaque identifier for the single earlier event that caused this event. It is not resolved at ingest.

Required string length: 1 - 200
Pattern: ^[\x21-\x7E]+$
correlation_id
string

Optional producer-supplied opaque identifier propagated across services. Do not include secrets or personal data.

Required string length: 1 - 200
Pattern: ^[\x21-\x7E]+$
currency
string

Three-letter uppercase ISO currency code.

Pattern: ^[A-Z]{3}$
data
object

Optional provider, failure, or retry context.

id
string

Optional stable ULID used to identify the event across retries.

Pattern: ^evt_[0-9A-Z]{26}$
metadata
object

Optional flat key-value context retained with the event.

occurred_at
string<date-time>

Time when the event occurred in the source system.

Response

Accepted

results
object[]
required

Results in the same order as the submitted events.