9. Buyer Rules for PlastiqPay

8.1 Overview

Rules: Users can add rules for CPX buyer. The rules can only be added if PlastiqPay is enabled for the buyer and the payments would be routed to plastiq if the payment matches any of the rules set for the buyer.

8.2 Attributes

Field	Sub-field	Type	Description	Additional Information
totalRecords		Integer	Total number of records available
totalType		String	Whether the records returned are an exact or in range
recordCount			Number of records fetched
records		Array of objects	Details of the records fetched
acl		Array	access control list for the rules fetched
entityId			Id of buyer for which rule is created
id			Id of the rule
ruleLevel			Rule is created for which level of entity
type		enum	Type of Rule being added PLASTIQ_ROUTING_RULE	Mandatory
criteria		Object array	Criteria to be used to filter payments to be used to plastiq	Mandatory
	ruleType	enum	Rule being added for Payment Type CHK ACH WIR	Mandatory
	supplierIds	array	List of supplier Ids associated with the criteria	Optional
	Condition	enum	between lessThanOrEqualsTo greaterThanOrEqualsTo	Mandatory
	amountFrom	string	Lower amount for which rule is applicable	Optional
	amountTo	string	Upper amount for which rule is applicable	Optional
	id	String	Id of the Criteria of the rule
created		string	Date and time of creation of the rule
creator	id	string	Id of user creating the rule
	username	string	Username of user creating the rule
modified		string	Date and time of last modification of rule
modifier	id	string	Id of user who has last modified the rule
	username	string	Username of user who has last modified the rule

8.3 Operations

8.3.1. Create Rule
8.3.2. Delete rule by id
8.3.3. Delete criteria by id
8.3.4. Update rule
8.3.5. Search Rule
8.3.6. Search Rule list