HomeGuidesAPI Reference
API Reference

Create transaction definition

Create a new transaction definition with a nested field schema, customer link declarations, and optional non-client-scoped partitions. Leaf field values must be one of: "string", "number", "ipAddress", "date", "array", "country". Array fields accept only primitive elements (string, number, boolean, null). "country" values must be ISO 3166-1 alpha-2 codes. Each link txPath and partition txPath must resolve to a declared leaf field (link and partition paths may not target array fields). A link may declare an optional mergeTxPath, which must resolve to an "array" leaf field. Partition types must not collide with link types.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
string
required

Unique transaction type identifier

fields
object
required

Nested structure where leaf values are "string", "number", "ipAddress", "date", "array", or "country" (array elements must be primitives: string, number, boolean, or null; "country" values must be ISO 3166-1 alpha-2 codes)

partitions
array of objects
length ≤ 16

Optional non-client-scoped aggregation partitions (e.g. device, IP). Each partition type must be distinct from every link type.

partitions
realTimeFields
array of strings

Optional whitelist of dot-notation paths into "fields". When present, only these fields are available for transaction monitoring rules. When absent, all declared fields are available.

realTimeFields
Responses
201

Transaction definition created successfully

400

Payload validation failed

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