List of Schemes

Introduction:

Sample cURL:

curl --location 'https://api-preproduction.signzy.app/api/v3/fd-booking/schemes' \
--header 'Authorization: <auth token>' \
--header 'Content-Type: application/json' \
--data '{
    "offset": 0,
    "limit": 10,
    "issuerId": "shriram",
    "schemeId": "8fc22147-c369-63ac-ef07-30c68a98bcee",
    "type": "cumulative",
    "category": "general",
    "status": "active",
    "womenSpecial": false
}'

Input Parameters:

Parameter	Type	Description	Mandatory/Optional
offset	Number	Number of records to skip. Default: 0	Optional
limit	Number	Maximum number of records to return Default: 10 Value: [1, 100]	Optional
issuerId	String	If specified, returns schemes of the specified issuer only, otherwise returns schemes of all issuers.	Optional
schemeId	String	If specified, returns the scheme with the specified ID only. If not specified, returns all schemes matching the specified criteria.	Optional
type	String	The type of scheme to return. If not specified, all schemes will be returned. Value: ["cumulative", "non_cumulative"]	Optional
category	String	Category of the scheme. If not specified, all schemes will be returned. Value: ["general", "senior_citizen"]	Optional
status	String	The status of the scheme. Default: ["active"] Value: ["active", "inactive"] active: The scheme is active and can be used for creating new applications inactive: The scheme is inactive and cannot be used for creating new applications	Optional
womenSpecial	Boolean	Women Special schemes. If not specified, include all schemes. true: women special schemes only false: exclude women special schemes	Optional

Output Parameters:

Key	Type	Description
total	Number	Total number of records matching the specified criteria.
limit	Number	Maximum number of records returned.
offset	Number	Number of records skipped.
schemes	Array of Objects	List of all schemes.
schemes.id	String	Unique identifier of scheme.
schemes.issuerId	String	Issuer of the scheme.
schemes.type	String	Scheme type. Value: ["cumulative", "non_cumulative"]
schemes.interestPayoutFrequency	String	Payout frequency. Value: ["monthly", "quarterly", "half_yearly", "yearly", "maturity"]
schemes.interestRate	Number	Interest rate. Value: [0, 100]
schemes.category	String	Category of the scheme. Value: ["general", "senior_citizen"]
schemes.womenSpecial	Boolean	Indicates whether the scheme is applicable to women.
schemes.minAmount	Number	Minimum amount that can be deposited.
schemes.maxAmount	Number	Maximum amount that can be deposited.
schemes.minTenure	Number	Minimum tenure in months. Value: [1, 120]
schemes.maxTenure	Number	Maximum tenure in months. Value: [1, 120]
schemes.minTenureDay	Number	Minimum tenure in days.
schemes.maxTenureDay	Number	Maximum tenure in days.
schemes.minTenureYear	Number	Minimum tenure in years.
schemes.maxTenureYear	Number	Maximum tenure in years.
schemes.lockInPeriod	Number	Lock-in period in months. Value: [1, 120]
schemes.minAge	Number	Minimum age of the depositor. Value: [1, 120]
schemes.status	String	The status of the scheme. Value: ["active", "inactive"]

Status Codes:

{
    "message": "Invalid authentication credentials"
}