Search Rule List

Overview

This route will search for all rules created for a buyer.

Resource Access

GET https://<hostname>/buyer/v1/buyer/<buyerID>/rule

Parameters

The requested criteria can be a combination of one or more of the following fields:

Keys	Values
filter	%7B%7D
search	<Item user wants to search>
size	10
sort	created%3Adesc

Example Request

🚧
GET https://<hostname>/buyer/v1/buyer/82787b9f-6a7a-5105-9786-33b6ec632812/rule

Example Response


{
   "totalRecords": 1,
   "totalType": "exact",
   "recordCount": 1,
   "records": [
       {
           "created": "2024-08-26T09:18:19.344Z",
           "creator": {
               "id": "404b861c-74df-5e29-b70c-5e9c13c09984",
               "username": "john.doe"
           },
           "modified": "2024-08-26T09:18:19.344Z",
           "modifier": {
               "id": "404b861c-74df-5e29-b70c-5e9c13c09984",
               "username": "john.doe"
           },
           "type": "PLASTIQ_ROUTING_RULE",
           "entityId": "82787b9f-6a7a-5105-9786-33b6ec632812",
           "ruleLevel": "buyer",
           "criteria": [
               {
                   "ruleType": "ACH",
                   "condition": "between",
                   "amountTo": 200,
                   "amountFrom": 100,
                   "supplierIds": [
                       "2109e8a2-6b8d-593c-a0e1-021f43852b8e"
                   ],
                   "id": "99dce675-fb23-5a46-94a7-a51c41b9cb2a"
               }
           ],
           "acl": [
               "pps:cpx-acquiring",
               "buyer:82787b9f-6a7a-5105-9786-33b6ec632812",
               "institution:0df2d073-64d5-58e2-96ee-4770201facb7",
               "network:45cf4f64-e4f2-5a7e-9344-fbd400d77133"
           ],
           "id": "01e65152-64b2-5818-9f8b-3be9acb7ffe6"
       }
   ]
}