Retrieve Funding Rule

Fetch a single funding rule's full configuration by its PCE id or your externalId.

Retrieve a funding rule to read back its complete configuration, including its method, association, condition, split actions, and current status. You can look up a rule by the PCE-assigned id or by the externalId you supplied when creating it.

Retrieve a funding rule

Make a GET request to /v1/fundingRule/id/{id} (or /v1/fundingRule/externalId/{externalId}):

GET /v1/fundingRule/id/{id}
GET /v1/fundingRule/externalId/{externalId}

Example

Response

{
    "resourceName": "fundingRule",
    "url": "v1/fundingRule/id/754",
    "id": 754,
    "externalId": "ET23353323",
    "name": "rule3",
    "method": [
        "ACH"
    ],
    "transactionComponent": "TOTAL_AMOUNT",
    "isOverridable": true,
    "ownership": "SELF",
    "association": [
        {
            "key": "CUSTOMER_ENROLLED_STATE",
            "value": [
                "AL",
                "AK"
            ],
            "operator": "in"
        },
        {
            "key": "PROGRAM_AFFILIATE_ID",
            "value": [
                "718"
            ],
            "operator": "in"
        },
        {
            "key": "CUSTOMER_TYPE",
            "value": [
                "BUSINESS"
            ],
            "operator": "in"
        }
    ],
    "condition": [],
    "action": [
        {
            "account": {
                "tag": "fee"
            },
            "percentage": "20.00",
            "order": 1,
            "transferTo": "PROGRAM_MANAGER"
        },
        {
            "account": {
                "tag": "Trust"
            },
            "percentage": "60.00",
            "order": 2,
            "transferTo": "PROGRAM_MANAGER"
        }
    ],
    "status": "ACTIVE",
    "statusDate": "02/18/2026",
    "isRecoupable": false,
    "createdOn": "02/18/2026 09:35:59",
    "createdBy": {
        "username": "[email protected]",
        "status": "ACTIVE",
        "userType": "API_USER"
    },
    "lastUpdatedBy": {
        "username": "[email protected]",
        "status": "ACTIVE",
        "userType": "API_USER"
    },
    "lastUpdatedOn": "02/18/2026 09:35:59"
}

Response

200 OK

See also

Funding Rules overview: concept, attributes, statuses, and business validations
List Funding Rules: find rules by criteria instead of a single ID
Create Funding Rule: define a new rule
Error Codes and Messages: reason and return codes when a retrieve fails

Updated about 4 hours ago

Did this page help you?