HomeDocumentationRecipesAPI ReferenceChangelog
Platform OverviewDemoContactImprintLog In
API Reference
Platform OverviewDemoContactImprint

Create a payment categorization rule

post
https://api.instellix.io/v2/merchant-payment-accounts//payment-transaction-categorization-rules

Create a new payment categorization rule for a specific merchant payment account

Path Params
string
required

Merchant payment account ident. Must not be null.

Body Params

Creates JSONata rules to map a Settlement to the correct transaction category used for automatic assignment.

string | null

Description of the rule.

string
required
length between 1 and 100

Unique identifier to identify the rule. Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

string
required
length between 1 and 512

JSONata rule. Must return a Boolean value when applied to a PaymentDto. If the result is TRUE this rule is applied. Must not be blank. Size must be between 1 and 512.

int32
required
> 0

Priority of application. Lower number will be processed earlier. First match will be applied. Must not be null. Must be greater than 0.

string
required
length ≥ 1

Name of an existing payment category. See payment categories endpoint. Must not be blank.

Responses

Updated 27 days ago

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Choose an example:
application/json

Updated 27 days ago