v1

latestOpenAPI 3.1.02026-07-2051132407.2 KB

Transaction rules

Update a transaction rule

Updates a transaction rule.

To update only the status of a transaction rule, send only the status parameter. All other parameters not provided in the request are left unchanged.
When updating any other parameter, you need to send all existing resource parameters. If you omit a parameter in the request, that parameter is removed from the resource.

patch/transactionRules/{transactionRuleId}

Path parameters

transactionRuleIdstring required

The unique identifier of the transaction rule.

Request body

balancePlatformIdstring

The unique identifier of the balance platform to which the rule applies.

countriesstring[]

List of countries to which the rule applies. For example: ["NL","US"].

descriptionstring required

Your description for the transaction rule.

endDatestring

The date when the rule will stop being evaluated, in ISO 8601 extended offset date-time format. For example, 2025-03-19T10:15:30+01:00.

If not provided, the rule will be evaluated until the rule status is set to inactive.

entryModesstring[]

List of point-of-sale entry modes to which the rule applies.

Possible values: manual, chip, magstripe, contactless, cof, token, server, barcode, ocr.

maxTransactionsinteger

The maximum number of transactions that a payment instrument can be used for in the period specified in the interval.type.

mccsstring[]

List of Merchant Category Codes (MCCs) to which the rule applies.

paymentInstrumentGroupIdstring

The unique identifier of the payment instrument group to which the rule applies.

paymentInstrumentIdstring

The unique identifier of the payment instrument to which the rule applies.

processingTypesstring[]

List of processing types to which the rule applies.

Possible values: atmWithdraw, pos, ecommerce, moto, recurring, balanceInquiry.

referencestring required

Your reference for the transaction rule.

startDatestring

The date when the rule will start to be evaluated, in ISO 8601 extended offset date-time format. For example, 2025-03-19T10:15:30+01:00.

If not provided when creating a transaction rule, the startDate is set to the date when the rule status is set to active.

status'active' | 'inactive'

The status of the transaction rule. If you provide a startDate in the request, the rule is automatically created with an active status.

Possible values: active, inactive.

type'allowList' | 'blockList' | 'maxUsage' | 'velocity' required

Type of conditions provided in the rule.

Possible values:

allowList: The rule provides categories (such as country and MCC) where payments must be allowed.
blockList: The rule provides categories (such as country and MCC) where payments must be blocked.
maxUsage: The rule sets limits for the maximum amount or maximum number of transactions for the lifetime of the payment instrument.
velocity: The rule sets limits for the maximum amount or maximum number of transactions for a given time interval.

Response

OK - the request has succeeded.