Create transaction definition

post

https://ingest.spektr.com/v1/transaction-definitions

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. An optional fieldRoles object names the path carrying each semantic role ("amount", "currency"), each of which must resolve to a declared leaf field of that role's required type.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

type

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)

link

array of objects

required

length between 1 and 16

How transactions of this type link to customers. At least one entry is required.

link*

type

string

required

Stable label that identifies this link type (e.g. "iban", "spektrId")

txPath

string

required

Dot-notation path into the transaction payload that resolves to a leaf field declared in "fields"

clientRecordPath

string

required

Declarative path on the client record this link matches (e.g. "data.iban", "_id")

mergeTxPath

string

Optional dot-notation path into the transaction payload carrying prior values of this link that have since merged into the current one. Unlike txPath, it must resolve to an "array" leaf field declared in "fields".

direction

string

enum

required

Which side of the transaction this link represents

Allowed:

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

fieldRoles

object

Optional mapping from a semantic role to the dot-notation path carrying it, so consumers can resolve a monetary value without knowing this definition's field names. Each path must resolve to a declared leaf field of the role's required type: "amount" requires a "number" leaf, "currency" a "string" leaf. Every role is optional; a consumer falls back to its own default when one is absent.

Responses

201

Transaction definition created successfully

400

Payload validation failed

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

500Transaction definition creation failed