CollectPayment RulesPayment Rules

Get a Rule

Fetches a specific rule by its ID.

Path parameters

ruleIdstringRequiredformat: "uuid"
Identifier of the rule.

Response

Rule details.
idstring
Unique identifier for the rule.
namestring
Name of the rule.
merchantIdstringformat: "uuid"
Merchant identifier.
prioritydouble

Rule priority (higher precedence evaluated first).

isActiveboolean
Whether the rule is active.
conditionslist of objects
actionslist of objects
createdAtdatetime
Timestamp when the rule was created.
updatedAtdatetime
Timestamp when the rule was last updated.

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error