Create a Funding Rule

post

https://sandbox-api.prioritycommerce.com/v1/passport/v1/fundingRule

Create a funding rule to specify how incoming funds should be split among multiple recipients or accounts. Rules can be applied to ACH, CHECK, WIRE, MONEYGRAM, or CARD transactions and support percentage-based or fixed amount splits. For CARD transactions, you can also specify surcharge routing rules.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Funding rule details including name, method, transaction component, associations, conditions, and actions.

Request body for creating a funding rule.

externalId

string

length ≤ 45

Reference ID assigned by the program manager. Must be unique.

name

string

required

Display name of the funding rule.

method

array of strings

required

Transaction methods to which the rule applies.

method*

Allowed:

transactionComponent

string

enum

required

Transaction component on which the rule is applied. TOTAL_AMOUNT applies to the full transaction amount, SURCHARGE applies specifically to surcharge fees.

Allowed:

transactionType

string

enum

Type of transaction the rule applies to. Required for CARD method.

Allowed:

cardType

string

enum

Card type the rule applies to. Required for CARD method.

Allowed:

isOverridable

boolean

Defaults to false

Allow the rule to be overridden at a lower level by customers or partners.

isRecoupable

boolean

Defaults to false

Enable recoupment of funds in case of chargebacks, refunds, or returns.

association

array of objects

Associate the rule with specific customer segments.

association

condition

array of objects

Conditions that must be met before applying the rule.

condition

action

array of objects

required

Actions defining how funds should be split.

action*

Headers

PromiseMode

string

enum

required

Controls response timing. Use NEVER for immediate synchronous response or ALWAYS for asynchronous processing with later response.

Allowed:

Responses

400

The request could not be processed. Check for missing required fields, invalid values, or incorrect data formats.

401

Authentication failed. Verify that the Authorization header contains a valid Bearer token.

403

The authenticated user does not have permission to perform this operation.

500

An unexpected error occurred on the server while processing the request.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The funding rule was created successfully.