CollectPayment RulesPayment Rules

List Rules

Retrieves a list of rules configured for one or more merchants.

Query parameters

merchantIdsstringRequired

Comma-separated list of merchant IDs.

Response

A list of rules.
idstringOptional
Unique identifier for the rule.
namestringOptional
Name of the rule.
merchantIdstringOptionalformat: "uuid"
Merchant identifier.
prioritydoubleOptional

Rule priority (higher precedence evaluated first).

isActivebooleanOptional
Whether the rule is active.
conditionslist of objectsOptional
actionslist of objectsOptional
createdAtdatetimeOptional
Timestamp when the rule was created.
updatedAtdatetimeOptional
Timestamp when the rule was last updated.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error