Spliceforms Calculators API

openapi: 3.2.0
info:
  version: '1.0'
  title: Inquiry Services Calculators API
  summary: List of services to inquire customer data
  description: This API provides endpoints to retrive the information about existing customer of the bank. This information could be used by channel application forms to display on the screen or to make certain decisions during application form data capture.
  contact:
    name: akhilesh
    url: https://spliceforms.com/
    email: api@apibanking.com
  license:
    url: https://spliceforms.com/
    name: Commercial
servers:
- url: https://api.stitch.spliceforms.com/inquiry
tags:
- name: calculators
  description: Endpoints to fetch calculator results
paths:
  /v1/customer/fd-maturity:
    post:
      summary: Calculate FD Maturity
      description: Calculates the maturity amount and interest for a fixed deposit based on the provided principal amount and tenure.
      operationId: calculateFDMaturity
      requestBody:
        description: Shared Request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FDMaturityCalculationRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FDMaturity'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
              examples:
                Example 1:
                  value:
                    type: http://example.com
                    title: string
                    status: 400
                    detail: string
                    instance: http://example.com
                    validationErrors:
                    - message: string
                      properties:
                      - string
                      severity: ERROR
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
              examples:
                Example 1:
                  value:
                    type: http://example.com
                    title: string
                    status: 500
                    detail: string
                    instance: http://example.com
      servers:
      - url: http://localhost:3000
      x-stoplight:
        id: ys0z42ijhi5mu
      tags:
      - calculators
components:
  schemas:
    FDMaturity:
      type: object
      x-stoplight:
        id: 0g86xjf2eivg1
      title: FDMaturity
      description: Information related to a Fixed Deposit (FD) at the time of maturity, including the maturity amount, interest earned, start date and maturity date.
      examples:
      - maturityAmount: 100000
        roi: 5.5
        startDate: '2025-01-30'
        maturityDate: '2025-01-30'
      required:
      - maturityAmount
      - interestRate
      - maturityDate
      properties:
        maturityAmount:
          type: number
          minimum: 1
          maximum: 100000000000
          examples:
          - 100000
          description: The total amount receivable at the end of an investment term, including the principal and accumulated interest, as per the agreed-upon rate and tenure.
          x-stoplight:
            id: fexwcwsspjcg2
        interestRate:
          type: number
          minimum: 0.1
          maximum: 10
          examples:
          - 5.5
          x-stoplight:
            id: 5a6za28ekdue2
          description: The percentage at which interest is to be earned on a deposit over the specified tenure.
        depositStartDate:
          type: string
          format: date
          pattern: ^\d{4}-\d{2}-\d{2}$
          minLength: 10
          maxLength: 10
          examples:
          - '2025-01-30'
          description: The date on which the Fixed Deposit (FD) is opened and the investment tenure begins.
          x-stoplight:
            id: tc2u1z55epwe5
        maturityDate:
          type: string
          format: date
          pattern: ^\d{4}-\d{2}-\d{2}$
          minLength: 10
          maxLength: 10
          examples:
          - '2025-01-30'
          description: The date on which the Fixed Deposit (FD) completes its tenure, and the principal along with the accrued interest becomes available for withdrawal or renewal.
          x-stoplight:
            id: vfafu4yop30eh
    FDMaturityCalculationRequest:
      title: FDMaturityCalculationRequest
      type: object
      x-examples:
        Example 1:
          mobileNo: '+919876543210'
          accountNo: '102001053892'
          amount:
            value: 5000
            currency: INR
          dob: '1998-01-12'
          productType: regular
          interestPaymentFrequency: reinvestment
          tenure:
            days: 1
            months: 6
            years: 1
          maturityInstruction: renewPrinciple
      required:
      - mobileNo
      - accountNo
      - amount
      - dob
      - productType
      - interestPayoutTreatment
      - tenure
      - maturityInstruction
      properties:
        mobileNo:
          description: Specifies the contact mobile number for an individual.
          x-unresolved-stoplight-ref: stoplight://resources/overrides/LT9qrA1aRC4
        accountNo:
          description: Specifies the bank account from which funds are debited.
          x-unresolved-stoplight-ref: stoplight://resources/overrides/swJoliwLU7s
        amount:
          description: The original deposit amount upon maturity or withdrawal.
          $ref: '#/components/schemas/AmountWithCurrency'
        dob:
          description: The exact date on which the individual was born, including the day, month, and year.
          x-unresolved-stoplight-ref: stoplight://resources/overrides/UEKAfGKnXtA
        productType:
          x-unresolved-stoplight-ref: stoplight://resources/overrides/eZOUNbW4Dy0
        interestPayoutTreatment:
          x-stoplight:
            id: 27bwffgdncfw6
          x-unresolved-stoplight-ref: stoplight://resources/overrides/GIH20YnXrJk
        tenure:
          $ref: '#/components/schemas/FDTenure'
        maturityInstruction:
          x-unresolved-stoplight-ref: stoplight://resources/overrides/hNcvI153XgU
    FDTenure:
      type: object
      title: FDTenure
      description: This indicates the duration for which the Fixed Deposit (FD) is held, expressed in days, months and years.
      x-stoplight:
        id: b8a8yencrf6fn
      required:
      - days
      - months
      - years
      properties:
        days:
          type: integer
          description: Tenure expressed in days
          format: int32
          minimum: 1
          maximum: 31
          example: 1
        months:
          type: integer
          description: Tenure expressed in months
          format: int32
          minimum: 6
          maximum: 11
          examples:
          - 6
        years:
          type: integer
          description: Tenure expressed in years
          format: int32
          minimum: 0
          maximum: 10
          examples:
          - 1
    ValidationError:
      type: object
      x-stoplight:
        id: i03w36ken44hv
      title: ValidationError
      description: Validation Error
      required:
      - message
      - severity
      properties:
        message:
          type: string
          description: Message for the validation error
          pattern: ^[A-Za-z0-9-_ ]+
          minLength: 2
          maxLength: 2048
          examples:
          - fields can not be empty
          x-stoplight:
            id: vfc11e0vv4ka0
        fields:
          type: array
          description: One or more properties on which the validation was performed.
          items:
            type: string
            description: Propertie on which the validation was performed.
            pattern: ^[A-Za-z0-9-_]+
            minLength: 2
            maxLength: 50
            examples:
            - '23212322'
            x-stoplight:
              id: 7ezn2bw6cptug
          x-stoplight:
            id: ngstgikrr1jga
        severity:
          type: string
          enum:
          - ERROR
          - WARNING
          description: Severity of the validation error.
          pattern: ^[A-Z]+(_[A-Z]+)*$
          minLength: 2
          maxLength: 50
          examples:
          - ERROR
          x-stoplight:
            id: kcvbyilxmlci5
    AmountWithCurrency:
      title: AmountWithCurrency
      x-stoplight:
        id: sbp1q7zyp9lec
      type: object
      description: Amount with currency code
      required:
      - amount
      - currency
      properties:
        amount:
          x-stoplight:
            id: zfs2glt3vns73
          x-unresolved-stoplight-ref: stoplight://resources/overrides/wbgPBBXK2qY
        currency:
          x-stoplight:
            id: trn7cym9swchs
          x-unresolved-stoplight-ref: stoplight://resources/overrides/euAvzUucCGw
    ProblemJson:
      type: object
      x-stoplight:
        id: oooamay5pgk0b
      title: ProblemJson
      description: Problem Error Json
      required:
      - title
      - status
      properties:
        title:
          type: string
          description: A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
          pattern: ^[A-Za-z0-9-_]+
          minLength: 2
          maxLength: 50
          examples:
          - Unauthorized
          x-stoplight:
            id: qp048dxgamcyv
        status:
          type: integer
          description: The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
          format: int32
          minimum: 1
          maximum: 1000
          examples:
          - 200
          x-stoplight:
            id: mppplj2ikgpo5
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem.
          pattern: ^[A-Za-z0-9-_ ]+
          minLength: 5
          maxLength: 2043
          examples:
          - api_key missing
          x-stoplight:
            id: 05ie4179zj1s5
        instance:
          type: string
          description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
          format: uri
          pattern: ^(https?|http):\/\/[^\s/$.?#].[^\s]*$
          minLength: 5
          maxLength: 2083
          examples:
          - https://example.com/resource
          x-stoplight:
            id: f0d9smdiysl1b
        validationErrors:
          type: array
          description: Validation Errors
          items:
            x-stoplight:
              id: 7vcjnrvdy7wos
            $ref: '#/components/schemas/ValidationError'
          x-stoplight:
            id: uxclbrhmspafm
x-stoplight:
  id: mrnq6rlv8lmce
x-source: https://github.com/spliceforms/stoplight-projects/blob/main/stitch-capture-services/inquiry-services-v1.0.yaml
x-bundled-from: openapi/_original/stitch-capture-services/inquiry-services-v1.0.yaml (./models refs inlined into components/schemas; stoplight:// platform overrides are not resolvable outside Stoplight and are kept as x-unresolved-stoplight-ref)