Update a payment categorization rule

put

https://api.instellix.io/v2/merchant-payment-accounts/{merchantPaymentAccountIdent}/payment-transaction-categorization-rules/{categorizationRuleIdent}

Update a payment categorization rule for a specific merchant payment account.

Path Params

merchantPaymentAccountIdent

string

required

Merchant payment account ident.

categorizationRuleIdent

string

required

Categorization rule ident.

Body Params

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

description

string | null

Description of the rule.

jsonataExpression

string

required

length between 1 and 512

^\S(.*\S)?$

JSONata rule. Must return a Boolean value when applied to a PaymentDto. If the result is TRUE this rule is applied.
Must not be null.
Size must be between 1 and 512.
Must match with the regular expression '^\S(.*\S)?$'.

priority

int32

required

≥ 1

Priority of application. Lower number will be processed earlier. First match will be applied.
Must not be null.
Must be greater than or equal to 1.

resultingPaymentCategoryName

string

required

length between 1 and 255

^\S(.*\S)?$

Name of an existing payment category. See payment categories endpoint.
Must not be null.
Size must be between 1 and 255.
Must match with the regular expression '^\S(.*\S)?$'.

Responses

200Standard response for successful HTTP requests.

4XXerror response for all http error codes in range 4XX

5XXerror response for all http error codes in range 5XX