Sub Limits APIs and Documentation

What is SubLimits?

Every credit line account has a principal allowedLimit which cannot be exceeded. Similarly, a credit line account may have sublimits configured whose value can range between 0 to allowedLimit.

Each sublimit cannot exceed its parent allowedLimit.

For e.g. if we have an account whose allowedLimit=50000, and payLaterSubLimit=30000, our total payout transactions cannot exceed 30000.

Currently we support two types of sublimits - payLaterLimit and emiConversionLimit

payLaterLimit is for all the payout transactions.

emiConversionLimit is for all the spend and convert and convert to emi transactions.

Configuring Sublimits:

We have is_sublimits_enabled configuration at product and account level to enable/disable sublimits.

To enable/disable sublimits at product level, set is_sublimits_enabled = 1 in the f_product_config_mapping table for that particular creditline product.

This configuration would automatically be copied to account level configuration by default.

If you want to enable/disable sublimits at account level, set is_sublimits_enabled = 1 in f_account_config_mapping table.

Creating SubLimits:

Via create and activate creditline API: just pass the sublimits payload with the request to add sublimits to creditline account.

e.g.

"sublimits": {
    "paylaterLimit": 20000,
    "emiConversionLimit": 30000
}

2. Via Add Sublimits API:

If the credit account is already created, we can use the add sublimits API to add it to account later:

API Documentation link : https://finflux-m2p.stoplight.io/docs/bnpl/5be7abc6ecb97-add-sub-limits-for-a-credit-line-account

Updating Sublimits:

We can update the sublimit’s limit via following APIs:

Via Update Limit API:

e.g. pass the payload in update limit API to update sublimits as well:

{
  "allowedLimit": 30000,
  "sublimits": {
    "paylaterLimit": 20000,
    "emiConversionLimit": 30000
  }
}

2. Via Update Sublimit API:

API Documentation Link: https://finflux-m2p.stoplight.io/docs/bnpl/0097ba77290cf-update-sub-limits-associated-with-credit-line-account

We have to pass the identity as a path variable for e.g. Paylater Limit and payload as follows:

{
  amount: 30000
}

This will update the sublimit amount for the respective identity.

Note:

A creditline account with zero sublimit means no transactions of that particular type would be allowed for the user.
A creditline account with no sublimits means a user can do those transactions without any restrictions.

Tables related to sublimit:

f_sublimit_details:

stores and updates the allowed limit and total limit for different identities for each account.

f_account_sublimit_mapping:

stores the mappings of account numbers with associated limit ids (each limit id has multiple sublimit identities like paylater limit and emiconversion limit associated with that acount)

f_limit:

stores the limit id information with description