MembershipFeature - Maintenance¶

Overview¶

MembershipFeature is an object containing the feature and its association with a Financial Institution (FI), including the status and effective status.

API's Invovled¶

POST/feature-management/features/membership-features
PUT/feature-management/membership-features/{id}
GET/feature-management/membership-features
GET/feature-management/membership-features/{id}

Steps¶

A specific Feature can be added for an existing FI with its status through the POST/feature-management/features/membership-features API call and simultaneously, the effective status will be calculated and updated.
To update the status of MembershipFeature, the PUT/feature-management/membership-features/{id} API call can be employed by passing the identity of the MembershipFeature.
To obtain the list of all existing MembershipFeatures in the system, the GET/feature-management/membership-features API call can be used.
To retrieve a specific MembershipFeatures by its identity, the GET/feature-management/membership-features/{id} API call can be used.

In these GET calls we will be able to see both the status & effective status of each feature

Note

The status of the MembershipFeatures is the membership level status.

FI-Onboarding¶

While onboarding for Financial Institution (FI), we will be using the MembershipFeature object to add feature against one FI.

We can specify the list of feature names along with their statuses.

If a MembershipFeature is onboarded for a FI and its status is subsequently updated, the change will be reflected, and the effective status will be recalculated.

     "MembershipFeature": [ 
        {
            "FeatureDefinitionName": "MNOValidation",
            "Status": "Disabled"
        },

        {
            "FeatureDefinitionName": "InboundLimits",
            "Status": "Enabled"
        }
    ]

The payload snippet above is an example of MembershipFeature node in the FI-Onboarding Endpoint

Note

A Financial Institution (FI) can possess multiple MembershipFeature nodes, but each feature definitiona name in every MembershipFeature node must be unique, valid and not duplicated.

Normally the FI-Onboarding can be done even without having the MembershipFeature object as its optional.

The below provided payload snippet exemplifies the response of a GET- Organizations, displaying the calculated effective status of each feature. This finalized status is obtained through orchestration for validation purposes.

"membershipFeatures": [
                {
                    "membershipFeatureId": 200,
                    "featureDefinitionId": 1,
                    "featureDefinitionName": "MNOValidation",
                    "effectiveStatus": "Enabled"
                },

                {
                    "membershipFeatureId": 201,
                    "featureDefinitionId": 2,
                    "featureDefinitionName": "InboundLimits",
                    "effectiveStatus": "Disabled"
                }
            ]