List Funding Rules
Search funding rules by criteria: filter, sort, and page through matching rules instead of retrieving them one ID at a time.
When you need more than a single rule, retrieve every funding rule that matches a set of criteria with the List Funding Rules API. It's a filtered, paginated search: you pass filter conditions (for example, only ACTIVE rules, or rules created in a date range) and PCE returns the matching rules.
Use it to build an operational view of your rules, audit which rules are active, or reconcile rules by your own externalId, without polling each rule by ID.
List funding rules
Make a POST request to /v1/fundingRule/list.
Request
POST /v1/fundingRule/list
{
"pageNumber": 1,
"pageSize": 25,
"sortOptions": {
"sortBy": "lastUpdatedOn",
"sortOrder": "desc"
},
"criteria": {
"filters": [
{
"operator": "eq",
"key": "status",
"values": [
"ACTIVE"
]
}
]
}
}Response
{
"totalCount": 9,
"returnedCount": 2,
"pageNumber": 1,
"offset": 717,
"hasMore": "false",
"resources": [
{
"resourceName": "fundingRule",
"url": "/v1/fundingRule/id/730",
"id": 730,
"name": "NBM",
"status": "ACTIVE",
"statusDate": "02/18/2026",
"method": [
"MONEYGRAM"
],
"transactionComponent": "TOTAL_AMOUNT",
"ownership": "SELF",
"isOverridable": true,
"createdOn": "02/18/2026 09:34:01",
"createdBy": {
"username": "DEFAULT_USER",
"status": "ACTIVE",
"userType": "INTERNAL"
},
"lastUpdatedBy": {
"username": "DEFAULT_USER",
"status": "ACTIVE",
"userType": "INTERNAL"
},
"lastUpdatedOn": "02/18/2026 09:34:01"
},
{
"resourceName": "fundingRule",
"url": "/v1/fundingRule/id/736",
"id": 736,
"name": "ACHbus",
"status": "ACTIVE",
"statusDate": "02/18/2026",
"method": [
"WIRE"
],
"transactionComponent": "TOTAL_AMOUNT",
"ownership": "SELF",
"isOverridable": true,
"createdOn": "02/18/2026 09:33:07",
"createdBy": {
"username": "DEFAULT_USER",
"status": "ACTIVE",
"userType": "INTERNAL"
},
"lastUpdatedBy": {
"username": "DEFAULT_USER",
"status": "ACTIVE",
"userType": "INTERNAL"
},
"lastUpdatedOn": "02/18/2026 09:33:07"
}
]
}Filters
Pass one or more filter conditions in criteria.filters[]. Each condition is a key, an operator, and one or more values.
| Filter | Supported operators |
|---|---|
id | eq, ne, in, gt, gte, lt, lte |
externalId | eq, ne, in |
statusDate | eq, gt, gte, lt, lte |
status | eq, in |
createdOn | eq, gt, gte, lt, lte |
createdBy | eq |
lastUpdatedOn | eq, gt, gte, lt, lte |
lastUpdatedBy | eq |
Sorting & pagination
You can sort the result set using the following fields:
idcreatedOnlastUpdatedOn
Set sortOptions.sortOrder to asc or desc. The response echoes totalCount, returnedCount, pageNumber, offset (the ID of the last record returned), and hasMore so you can request the next page.
See also
- Funding Rules overview: concept, attributes, statuses, and business validations
- Retrieve Funding Rule: read a single rule's full configuration
- Deactivate Funding Rule: retire rules you find here
- Error Codes and Messages: reason and return codes when a list fails
Updated about 6 hours ago