Create a funding rule to define how PCE splits inbound funds across your own, your partner's, or your customers' Passport accounts. A new rule is created in ACTIVE status and begins applying to matching incoming funds immediately.

Create a funding rule

Make a POST request to /v1/fundingRule.

POST /v1/fundingRule

Arguments

Field	Mandatory / Optional
`name`	Mandatory
`method`	Mandatory
`transactionComponent`	Mandatory
`isRecoupable`	Optional — default `false`
`isOverridable`	Optional — default `false`
`association` (`key`, `value`, `operator`)	Optional — default: apply to all customers
`condition` (`key`, `value`, `operator`)	Optional — default: apply to all transactions
`action` (`transferTo`, `account.tag`, `percentage`, `amount`, `order`)	Mandatory

See Attributes for the full field reference and allowed values.

Example

Request

POST /v1/fundingRule

{
    "externalId": "ET23353323",
    "name": "rule3",
    "method": [
        "ACH"
    ],
    "transactionComponent": "TOTAL_AMOUNT",
    "isOverridable": true,
    "isRecoupable": false,
    "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"
        }
    ],
    "action": [
        {
            "account": {
                "tag": "fee"
            },
            "percentage": "20.00",
            "order": 1,
            "transferTo": "PROGRAM_MANAGER"
        },
        {
            "account": {
                "tag": "Trust"
            },
            "percentage": "60.00",
            "order": 2,
            "transferTo": "PROGRAM_MANAGER"
        }
    ]
}

On success the API returns 201 Created and the rule is active. In this example, for a matching inbound ACH transaction, 20% of the total amount is routed to the Program Manager's fee account first, then 60% to the Trust account.

Response

201 Created

Create Funding Rule

Create a funding rule

Arguments

Example

See also