Retrieve Products

Retrieve all Products

GET /products

Error

A valid request URL is required to generate request examples

200

{
  "Data": [
    {
      "LFIId": "<string>",
      "LFIBrandId": "<string>",
      "Products": [
        {
          "ProductId": "<string>",
          "ProductName": "Savings Account",
          "Description": "<string>",
          "EffectiveFromDateTime": "2023-11-07T05:31:56Z",
          "EffectiveToDateTime": "2023-11-07T05:31:56Z",
          "LastUpdatedDateTime": "2023-11-07T05:31:56Z",
          "IsShariaCompliant": true,
          "ShariaInformation": "<string>",
          "IsSalaryTransferRequired": true,
          "Links": {
            "ApplicationUri": "<string>",
            "KfsUri": "<string>",
            "OverviewUri": "<string>",
            "TermsUri": "<string>",
            "FeesAndPricingUri": "<string>",
            "ScheduleOfChargesUri": "<string>",
            "EligibilityUri": "<string>",
            "CardImageUri": "<string>"
          },
          "Eligibility": {
            "ResidenceStatus": [
              {
                "Type": "UaeResident",
                "Description": "A person who is a resident of the United Arab Emirates."
              }
            ],
            "EmploymentStatus": [
              {
                "Description": "<string>"
              }
            ],
            "CustomerType": [
              {
                "Description": "<string>"
              }
            ],
            "AccountOwnership": [
              {
                "Description": "<string>"
              }
            ],
            "Age": [
              {
                "Description": "<string>",
                "Value": 123
              }
            ],
            "AdditionalEligibility": [
              {
                "Description": "<string>"
              }
            ]
          },
          "Channels": [
            {
              "Description": "<string>"
            }
          ],
          "Product": {
            "CurrentAccount": {
              "Description": "<string>",
              "IsOverdraftAvailable": true,
              "Documentation": [
                {
                  "Description": "<string>"
                }
              ],
              "Features": [
                {
                  "Description": "<string>"
                }
              ],
              "Fees": [
                {
                  "Name": "<string>",
                  "Description": "<string>",
                  "Amount": {
                    "Amount": "<string>",
                    "Currency": "AED"
                  },
                  "Percentage": 123,
                  "UnitValue": 123,
                  "MaximumUnitValue": 123
                }
              ],
              "Limits": [
                {
                  "Description": "<string>",
                  "Value": 123
                }
              ],
              "Benefits": [
                {
                  "Name": "<string>",
                  "Description": "<string>",
                  "Value": 123
                }
              ]
            },
            "SavingsAccount": {
              "Description": "<string>",
              "MinimumBalance": {
                "Amount": "<string>",
                "Currency": "AED"
              },
              "AnnualReturn": 123,
              "Documentation": [
                {
                  "Description": "<string>"
                }
              ],
              "Features": [
                {
                  "Description": "<string>"
                }
              ],
              "Fees": [
                {
                  "Name": "<string>",
                  "Description": "<string>",
                  "Amount": {
                    "Amount": "<string>",
                    "Currency": "AED"
                  },
                  "Percentage": 123,
                  "UnitValue": 123,
                  "MaximumUnitValue": 123
                }
              ],
              "Limits": [
                {
                  "Description": "<string>",
                  "Value": 123
                }
              ],
              "Benefits": [
                {
                  "Name": "<string>",
                  "Description": "<string>",
                  "Value": 123
                }
              ]
            },
            "CreditCard": {
              "Description": "<string>",
              "Rate": 123,
              "Documentation": [
                {
                  "Description": "<string>"
                }
              ],
              "Features": [
                {
                  "Description": "<string>"
                }
              ],
              "Fees": [
                {
                  "Name": "<string>",
                  "Description": "<string>",
                  "Amount": {
                    "Amount": "<string>",
                    "Currency": "AED"
                  },
                  "Percentage": 123,
                  "UnitValue": 123,
                  "MaximumUnitValue": 123
                }
              ],
              "Limits": [
                {
                  "Description": "<string>",
                  "Value": 123
                }
              ],
              "Benefits": [
                {
                  "Name": "<string>",
                  "Description": "<string>",
                  "Value": 123
                }
              ]
            },
            "PersonalLoan": {
              "Description": "<string>",
              "MinimumLoanAmount": {
                "Amount": "<string>",
                "Currency": "AED"
              },
              "MaximumLoanAmount": {
                "Amount": "<string>",
                "Currency": "AED"
              },
              "Tenure": {
                "MinimumLoanTenure": 123,
                "MaximumLoanTenure": 123
              },
              "Rate": {
                "Description": "<string>",
                "ReviewFrequency": "<string>",
                "IndicativeRate": {
                  "From": 123,
                  "To": 123
                },
                "ProfitRate": {
                  "From": 123,
                  "To": 123
                }
              },
              "AnnualPercentageRateRange": {
                "From": 123,
                "To": 123
              },
              "FixedRatePeriod": "<string>",
              "DebtBurdenRatio": "<string>",
              "Documentation": [
                {
                  "Description": "<string>"
                }
              ],
              "Features": [
                {
                  "Description": "<string>"
                }
              ],
              "Limits": [
                {
                  "Description": "<string>",
                  "Value": 123
                }
              ],
              "Fees": [
                {
                  "Name": "<string>",
                  "Description": "<string>",
                  "Amount": {
                    "Amount": "<string>",
                    "Currency": "AED"
                  },
                  "Percentage": 123,
                  "UnitValue": 123,
                  "MaximumUnitValue": 123
                }
              ],
              "Benefits": [
                {
                  "Type": "Other",
                  "Name": "<string>",
                  "Description": "<string>",
                  "Value": 123
                }
              ],
              "AdditionalInformation": [
                {
                  "Type": "Other",
                  "Description": "<string>"
                }
              ]
            },
            "Mortgage": {
              "Description": "<string>",
              "Structure": "<string>",
              "Rate": {
                "Description": "<string>",
                "ReviewFrequency": "<string>",
                "IndicativeRate": {
                  "From": 123,
                  "To": 123
                },
                "ProfitRate": {
                  "From": 123,
                  "To": 123
                }
              },
              "IndicativeAPR": {
                "From": 123,
                "To": 123
              },
              "FixedRatePeriod": "<string>",
              "MinimumLoanAmount": {
                "Amount": "<string>",
                "Currency": "AED"
              },
              "MaximumLoanAmount": {
                "Amount": "<string>",
                "Currency": "AED"
              },
              "MaximumLTV": 123,
              "DownPayment": {
                "Amount": "<string>",
                "Currency": "AED"
              },
              "RepaymentTenure": {
                "MinimumLoanTenure": 123,
                "MaximumLoanTenure": 123
              },
              "Documentation": [
                {
                  "Description": "<string>"
                }
              ],
              "Features": [
                {
                  "Description": "<string>"
                }
              ],
              "Fees": [
                {
                  "Name": "<string>",
                  "Description": "<string>",
                  "Amount": {
                    "Amount": "<string>",
                    "Currency": "AED"
                  },
                  "Percentage": 123,
                  "UnitValue": 123,
                  "MaximumUnitValue": 123
                }
              ],
              "Limits": [
                {
                  "Description": "<string>",
                  "Value": 123
                }
              ],
              "Benefits": [
                {
                  "Type": "Other",
                  "Name": "<string>",
                  "Description": "<string>",
                  "Value": 123
                }
              ]
            },
            "ProfitSharingRate": {
              "Name": "<string>",
              "Description": "<string>",
              "MinimumDepositAmount": {
                "Amount": "<string>",
                "Currency": "AED"
              },
              "AnnualReturn": 123,
              "AnnualReturnOptions": [
                {
                  "Name": "<string>",
                  "Description": "<string>"
                }
              ],
              "InvestmentPeriod": {
                "Name": "<string>",
                "Description": "<string>"
              },
              "AdditionalInformation": [
                {
                  "Type": "Other",
                  "Description": "<string>"
                }
              ]
            },
            "FinanceProfitRate": {
              "Name": "<string>",
              "Description": "<string>",
              "Rate": 123,
              "Frequency": "<string>",
              "Tiers": [
                {
                  "Type": "<string>",
                  "Description": "<string>",
                  "Name": "<string>",
                  "MinimumTierValue": {
                    "Amount": "<string>",
                    "Currency": "AED"
                  },
                  "MaximumTierValue": {
                    "Amount": "<string>",
                    "Currency": "AED"
                  },
                  "MinimumTierRate": 123,
                  "MaximumTierRate": 123,
                  "Condition": "<string>"
                }
              ],
              "AdditionalInformation": [
                {
                  "Type": "Other",
                  "Description": "<string>"
                }
              ]
            }
          }
        }
      ]
    }
  ]
}

Authorizations

Authorization · string · header · required

TPP confidential client authorization with the LFI to stage a consent. Please refer to OpenID FAPI Security Profile 1.0 -Part 2 Advanced - 5.2.2 point 14 - shall authenticate the confidential client using one of the following methods private_key_jwt and OpenID Connect Core 1.0 9. Client Authentication private_key_jwt

Headers

authorization · string · required

An authorization Token as per https://tools.ietf.org/html/rfc6750

Query Parameters

ProductCategory · enum<string>

Filter by product category

Available options: SavingsAccount, CurrentAccount, CreditCard, Loan, Mortgage

IsShariaCompliant · boolean

Filter by Sharia compliance

LastUpdatedDateTime · string<date-time>

Filter by last updated date time

PageNumber · integer · default: 1

Page number to retrieve (starts from 1)

Required range: x >= 1

PageSize · integer · default: 100

Number of records per page

Required range: 1 <= x <= 100

SortOrder · enum<string> · default: asc

Order of sorting the results

Available options: asc, desc

SortField · enum<string> · default: LastUpdatedDateTime

Field to sort the results by

Available options: LastUpdatedDateTime, ProductId

Response

200

application/json

The request has succeeded.

Product Response

Data · object[] · required

Products response

Show child attributes