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. The monitoring runs of these transactions send no process_run_start or process_run_end events. Returns HTTP 200 once the batch is accepted, even when individual items are rejected. Check the failed count and errors array in the response body. Returns HTTP 503 when the batch could not be accepted because a platform dependency was unavailable; retry the whole batch with the same transaction_id values. transaction_id is the idempotency key: always set it so a retry after a timeout or error is safe. A transaction sent without it is stored under a new random ID on every attempt, so a retry creates a duplicate. The idempotency-key header is ignored.

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

Your stable identifier for this transaction and the idempotency key of ingestion. Surrounding whitespace is trimmed, and a blank value counts as omitted. Always set it. Re-sending a transaction_id that already exists updates the stored transaction instead of creating a new one, so retries are safe. For a type with real-time fields, a re-send whose links, partitions, transactionDate or real-time field values differ is rejected with changed_resend; one that differs only in other fields updates it. If omitted, the platform generates a random UUID on every attempt, so retrying the same transaction creates a duplicate.

number

Unix timestamp in milliseconds representing when the transaction occurred. Used for ordered rolling history in aggregation rules. Required for a type with real-time fields.

Responses

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