Skip to main content
POST
Preview a rule against transactions (dry-run)

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
rule
object
required

Inline rule definition (required when rule_id is absent)

transaction_ids
string[]
required

The IDs of the transactions to preview the rule against. The transactions must belong to the authenticated user. Maximum 25 per request.

Required array length: 1 - 25 elements
rule_id
integer | null

The ID of an existing rule to preview. Omit to provide an inline rule definition instead.

Response

results
object[]
required
missing_transaction_ids
any[]
required