Skip to main content
POST
Create a settlement rule

Authorizations

Authorization
string
header
required

API key sent as Authorization: Bearer <api-key>.

Body

application/json
label
string
required

Operator-facing label (required, non-empty).

splits
object[]
required

Party splits; shares must sum to exactly "1".

description
string | null
targeting
object

Optional targeting block. If omitted, a targeting block is synthesised from the top-level substrate, appliesToScope, and currency fields.

substrate
string | null

Convenience — seeds targeting.substrates when targeting is omitted.

appliesToScope
string | null

Convenience — seeds targeting.appliesToScope when targeting is omitted.

currency
string
default:GBP

ISO 4217 currency (upper-cased). Defaults to GBP.

activeFrom
string<date-time>

Defaults to now. A future value yields SCHEDULED when activated on create.

activeUntil
string<date-time> | null
createdBy
string

Author attribution. Defaults to "developer".

activateOnCreate
boolean
default:false

When true, create the rule ACTIVE (or SCHEDULED if activeFrom is in the future).

Response

The created rule.

ok
boolean
required
data
object
required

Route-specific payload. Operation responses refine this.

contractVersion
string
required
Allowed value: "v1.0"