SimpliFi

Get Rule Groups on Funding Account

GET

https://{{env}}-lb.simplifipay.com/v1/funding-source/{thirdPartyId}/rule-group

Funding Source

The 'Get Rule Group' endpoint fetches all existing groups on the Funding Account.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://uat-lb.simplifipay.com/v1/funding-source//rule-group' \
--header 'requestUuid;'

Response Example

202 - Example 1

[
    {
        "ruleGroup": {
            "uuid": "cceec464-eb26-4fbf-8e91-695f133ced0a",
            "name": "Rule Group 1",
            "description": "Rule Group 1 Description",
            "transactionRestrictions": {
                "merchantRules": {
                    "allow": "true",
                    "mcc": [
                        "string"
                    ],
                    "mccException": [
                        "string"
                    ]
                }
            },
            "loadRestrictions": {
                "minimumLoad": 1.5,
                "maximumLoad": 123.45,
                "loadCountDailyLimit": 3,
                "loadCountWeeklyLimit": 5,
                "loadCountMonthlyLimit": 10,
                "loadDailyLimit": 123.45,
                "loadWeeklyLimit": 523.45,
                "loadMonthlyLimit": 1023.45
            },
            "spendRestrictions": {
                "setLimitPerTxn": 123.45,
                "velocityDailyLimit": 3.45,
                "velocityWeeklyLimit": 23.45,
                "velocityMonthlyLimit": 123.45,
                "txnCountDaily": 3,
                "txnCountWeekly": 5,
                "txnCountMonthly": 10
            }
        },
        "enabled": "true"
    }
]

Request

Authorization

JWT

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

thirdPartyId

string

required

This is a unique identifier for the Account ID of funding source (wallet)

Header Params

requestUuid

string

required

A unique id is required to be passed as part of the header whenever a SimpliFi API is called from your
system. This would help us in debugging in case of a discrepancy in the expected behavior of the API.

Example:

00d366f2-a6e9-4714-b172-02c4e58c29d8

Responses

🟢202Accepted

application/json

Successful operation.

Body

array of:

ruleGroup

object (RuleGroupModel)

required

uuid

string

optional

This field contains the system generated unique identifier for the rule group
that was created using the Rule Group API.

Example:

cceec464-eb26-4fbf-8e91-695f133ced0a

name

string

required

Name of the rule group

Example:

Rule Group 1

description

string

optional

Description of the rule group

Example:

Rule Group 1 Description

transactionRestrictions

object (RuleGroupTransactionRestrictions)

optional

Details of transaction-related restrictions.

loadRestrictions

object (RuleGroupLoadRestrictions)

optional

Details of card load-related restrictions.

spendRestrictions

object (RuleGroupSpendRestrictions)

optional

Details of card spend-related restrictions.

enabled

boolean

required

This field tells whether the ruleGroup is enabled or not

Example:

true

🟠400Bad Request

🟠401Unauthorized

Modified at 2025-06-27 12:44:57

Delete Rule Group on Funding Account

Appply Rule Group on Funding Account