HomeGuidesAPI Reference
API Reference

Ingest transaction batch

Ingests a batch of up to 1,000 transactions. Each transaction is validated against the workspace Transaction Definition for its type, linked to the relevant customer, persisted, and forwarded for transaction monitoring. Returns HTTP 200 regardless of per item outcome. Check the failed count and errors array in the response body.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
transactions
array of objects
required
length between 1 and 1000

The list of transactions to ingest. Must contain between 1 and 1,000 items.

transactions*

A single transaction in the batch. The three top level fields (type, transaction_id, transactionDate) are reserved by the platform. All other fields are validated dynamically against the Transaction Definition configured for the given type.

string
required
length ≥ 1

The transaction type. Must match the name of a Transaction Definition configured in your workspace.

string
length ≥ 1

Your stable identifier for this transaction. Used for upsert deduplication. If a transaction with this ID already exists it is updated rather than duplicated. If omitted, the platform generates a random UUID and the transaction cannot be idempotently resubmitted.

number

Unix timestamp in milliseconds representing when the transaction occurred. Used for ordered rolling history in aggregation rules.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json