Funding Rules
Automatically split incoming funds across your own, your partner's, and your customers' Passport accounts using configurable rules.
A funding rule tells PCE how to split incoming funds from a single source, such as an inbound transaction, and distribute them across multiple recipients or accounts according to the percentages or amounts you define. Instead of receiving one lump credit and reconciling the split yourself, you configure the rule once and PCE applies it every time a matching payment arrives.
Funding rules operate on the money you collect. When an inbound ACH, wire, check, or MoneyGram payment lands, PCE evaluates the active rules for the receiving customer, and, if a rule matches, moves the configured share of the funds into the target accounts automatically.
Example
An incoming ACH transaction for an enrolled customer should have 20% routed to the Program Manager's fee account and 60% routed to a trust account, with the remainder settling to the customer's own account. A single funding rule expresses this split so it happens on every matching deposit, without manual intervention.
How funding rules work
-
You create a rule
A Program Manager defines a rule: which paymentmethodit applies to, which customers it targets (association), any extraconditionthat must be true, and theaction(the accounts, percentages or amounts, and order in which funds are split). -
The rule stays ACTIVE
Every rule is created inACTIVEstatus and begins applying to matching inbound funds immediately. -
Inbound funds are evaluated
When a payment arrives on a supported method, PCE checks the customer's active rules. If the payment matches a rule's association and condition, the rule is applied. -
Funds are split per the action
PCE moves the configuredpercentageoramountinto each target account in the definedorder, transferring to the Program Manager, a Program Affiliate, or the customer as specified. -
You deactivate when it's no longer needed
A Program Manager can call the Deactivate API to move a rule toINACTIVE. Inactive rules are no longer applied to incoming funds.
Funding rules vs. moving money
Move money is where you initiate a transaction (a payout, a collection, a transfer). Funding rules act on funds you've already collected: they decide how an inbound credit is divided across accounts once it arrives. Reach for funding rules when the split should be automatic and repeatable.
Inheritance and ownership
Funding rules can cascade down your program hierarchy:
- A Program Manager can create rules on the customers under them to split incoming funds among their own, their partner's, or any of their customers' Passport accounts.
- Customers can inherit funding rules from their Program Manager or a partner.
- An inherited rule can be overridden at a lower level only when the creator marks it as overridable (
isOverridable: true).
The ownership attribute records who owns a rule. A value of SELF means the rule was created by the user themselves.
Attributes
| Field | Sub-field | Type | Description |
|---|---|---|---|
resourceName | Enum | Name of the resource. Always fundingRule. | |
url | String | System-generated endpoint that can be used to fetch the rule's details. | |
externalId | String (max 45 chars) | Reference ID assigned to the funding rule by the Program Manager. | |
id | Long | Unique identifier assigned by PCE. | |
name | String | Display name of the funding rule. | |
method | Enum (list) | Methods the rule applies to. Possible values: ACH, CHECK, WIRE, MONEYGRAM. | |
transactionComponent | Enum | Transaction component the rule is applied to. Possible value: TOTAL_AMOUNT. | |
isOverridable | Boolean | Allow the rule to be overridden at a lower level by a customer or partner who inherited it. Default false. | |
isRecoupable | Boolean | Enable recoupment of split funds in the event of a chargeback, refund, or return. Recoup is only possible when funds are split to the same customer the rule applies to. Default false. | |
ownership | Enum | Owner of the rule. SELF indicates the rule was created by the user themselves. | |
association | Object (list) | Targets the rule at all customers, or a customized list. | |
key, value, operator | Enum & String | Customize the target list. key can be CUSTOMER_ENROLLED_STATE (2-digit state codes), PROGRAM_AFFILIATE_ID (a program affiliate's PCE ID), or CUSTOMER_TYPE (BUSINESS or INDIVIDUAL). value holds one or more values for the chosen key. operator currently supports only in. | |
condition | Object (list) | Condition PCE validates before applying the rule. | |
key, value, operator | Enum & String | By default the rule applies to all inbound funds on the given method. To narrow it, set key to tags.<name> (for example tags.trust) so the rule applies only when the transaction carries that tag. value holds the value for the key; operator currently supports only in. | |
action | Object (list) | How the matched funds are split. | |
transferTo, account.tag, percentage, amount, order | Enum & String | transferTo is the recipient user type: PROGRAM_MANAGER, PROGRAM_AFFILIATE, or CUSTOMER. account.tag identifies the account funds move into. percentage or amount sets the share. order defines the sequence in which actions execute. | |
status | String | Current status of the rule. See Statuses. | |
statusDate | Date | Date the status was last updated. UTC, mm/dd/yyyy hh:mm:ss. | |
createdOn | Timestamp | When the rule was created. UTC, mm/dd/yyyy hh:mm:ss. | |
createdBy | userType, username, status | Object | Details of the user who requested creation of the rule. |
lastUpdatedOn | Timestamp | When the rule was last updated. UTC, mm/dd/yyyy hh:mm:ss. | |
lastUpdatedBy | userType, username, status | Object | Details of the user who last updated the rule. |
Statuses
| Status | Set when |
|---|---|
ACTIVE (default) | Default status on creation. The rule is applied to matching inbound funds. |
INACTIVE | Set after a funding rule is deactivated. The rule is no longer applied. |
Business validations
- Program Managers can create funding rules on the customers under them to split incoming funds among their own, their partner's, or any of their customers' Passport accounts.
- A funding rule is always created in
ACTIVEstatus. - Program Managers can call the Deactivate Funding Rule API to mark a rule
INACTIVE. - Customers can inherit funding rules from their Program Manager or a partner. An inherited rule is overridable only when the creator allows it (
isOverridable: true).
Operations
Define a rule: the method, target customers, conditions, and how funds are split.
Fetch a single rule's full configuration by its PCE id or your externalId.
Move a rule to INACTIVE so it stops applying to incoming funds.
Search and page through rules by status, dates, and other criteria.
See also
- Move money: initiate payouts, collections, and transfers that funding rules act on
- Collect: pull inbound funds that a funding rule can split
- Account types: the Passport accounts funds are split into
- Error Codes and Messages: reason and return codes when an operation fails
Updated 1 day ago