Skip to main content

Wealth FD Management Gateway API

1Silverbullet Wealth Management Gateway – FD API Integration Guide

*Version: 2.0

Last Updated: 14th Nov 2025*

-------------------------------------------------------------------------------------------

Purpose & Scope This document provides a formal integration guide for the 1Silverbullet Wealth Management Gateway – FD APIs, specifically for:

• Embedding FD journeys into distributor channels (web / mobile / RM portals).

• Implementing end-to-end flows for:

\ o FD product discovery and comparison

\ o New FD booking and tracking

\ o FD renewal

\ o FD premature withdrawal (where available)

It complements (but does not replace) the official 1SB Developer Portal API Docs, which should be used as the primary reference for request/response schemas and environment-specific details.

-------------------------------------------------------------------------------------------Audience

• Solution / Enterprise Architects

• Backend / Integration Engineers

• Digital Channel Product Teams

• QA & DevOps Engineers

-------------------------------------------------------------------------------------------

High-Level Capabilities

The FD APIs allow distributors to:

• View FD details offered by multiple issuers

• Compare FDs across issuers

• Simulate returns across tenures and FD types

• Book FD & RD

• Renew FD

• Prematurely withdraw FD (capability controlled by issuer; may be limited)

• View booked FDs

The APIs are grouped into four logical categories:

  • FD Details & Comparison : Products, Manufacturer, FD Calculator.
  • FD Booking & Tracking : Commit FD, Application, Payment, Application Status, OTP, Upload Documents, Communication.
  • Manage FD : Renewal (conceptually) and Premature Withdrawal.
  • Enablers: KYC, Validate Account, CKYC pull, and related helpers.

-------------------------------------------------------------------------------------------

Environments & Access Note: Environment-specific base URLs, IP whitelisting and sandbox configurations are intentionally not documented here. They must be obtained from your 1Silverbullet relationship manager.

Authentication

• Scheme: HTTP Basic Auth

• Security Type: http

• Authorization Scheme: basic

You must pass:

• API_KEY as username

• API_SECRET as password in the Authorization header:

Authorization: Basic <base64(API_KEY:API_SECRET)>

API key and secret are issued by 1Silverbullet and should be stored and rotated as per your internal security policy.

Common Technical Conventions

• Protocol: HTTPS only

• Content-Type: application/json (unless file upload)

• Character Set: UTF-8

• Timezone: Refer to issuer / 1SB environment documentation

Recommended common headers:

  • Content-Type: application/json
  • Accept: application/json
  • X-Client-Id: <your-system-identifier>
  • X-Correlation-Id: <UUID-per-request>

-------------------------------------------------------------------------------------------

System Actors & Responsibilities

  • Customer Channel (Web / Mobile / RM UI) : Collects and displays data; never calls 1SB directly.
  • Distributor Backend : Orchestrates journeys, calls 1SB APIs, integrates with your systems (KYC store, customer DB, etc.).
  • 1SB Wealth Management Gateway – FD : Normalizes FD APIs across issuers (manufacturers) and exposes standard endpoints for products, booking, KYC, account validation, payment, status, and document handling.
  • FD Manufacturer Systems : Actual FD booking engine (banks / NBFCs), hidden behind 1SB adapters.
  • KYC / Account Validation Services : Aadhaar, PAN, CKYC, penny drop, etc., invoked via 1SB KYC and Validate Account categories.
  • Payment Gateway : Payment initiation and status handled through the Payment category.

-------------------------------------------------------------------------------------------

API Overview

This section gives a logical view of key categories. For exact operations, see the API docs.

Application Health

  • Purpose: Health monitoring and smoke tests.

  • Key operation: Health Check (Application Health → Health Check).

Use this in monitoring dashboards and deployment pipelines.

-------------------------------------------------------------------------------------------

FD Details & Comparison

Products : Provides product catalogue for FD schemes.

Key endpoints include:

  • Get Product List – All standard FD products.

  • Get Product Detail – Detailed specification of a single FD product.

  • Compare Product – Compare multiple FD products.

  • Filter Product List – Server-side filtered view.

Manufacturer : Issuer / manufacturer metadata.

  • Get Manufacturers List
  • Get Manufacturer Profile
  • Get Manufacturer Artifacts (brochures, T&Cs, etc.)

FD Calculator : FD calculation utilities (amount, tenure, interest type, payout frequency). Use to compute potential returns and maturity values before booking.

-------------------------------------------------------------------------------------------

FD Booking & Tracking

Fixed Deposit Booking : Supports core booking operations.

  • Commit FD – Version 3

  • Commit FD Poll Request

Typical payload includes:

  • Customer information (KYC attributes)
  • Addresses
  • Nominee details
  • Investment details (product, amount, tenure, payout, instructions)
  • Declarations and consents

Payment : Payment creation and status tracking.

  • Payment – Initiate payment.
  • Payment Status – Fetch latest status.
  • Payment Status (Polling) – Poll until terminal state.

Application Status : Track booking state with issuer.

  • Application Status Version-3 – For v3 booking flows.
  • Application Status Poll – Asynchronous polling for application status.

OTP Verification : OTP utilities, typically used to secure critical journey steps.

  • Generate OTP
  • Verify OTP

-------------------------------------------------------------------------------------------

Manage FD

Renewal (Under Development) : Renewal is logically covered under FD Booking & Tracking and Manage FD; the introduction explicitly lists renew FD as a key capability. Typical renewal is implemented via:

  • Fetching existing FD details.
  • Presenting renewal options via Products + FD Calculator.
  • Re-using Commit FD v3 with renewal flags / references

Premature Withdrawal : Exposed as a separate category.

  • FD Premature Withdrawal Inquiry – Compute penalty, payable interest, and net payout.
  • FD Premature Withdrawal Closer – Execute closure post customer confirmation.
  • Issuers may selectively enable or restrict this capability.

-------------------------------------------------------------------------------------------

Enablers

KYC : KYC APIs used heavily during onboarding and booking.

  • Verify Pan
  • Validate Customer
  • Initiate Aadhar Verification
  • Validate Aadhar Information
  • Initiate VKYC
  • Validate VKYC
  • VKYC Status
  • Validate Customer

Validate Account : Bank account validation utilities.

  • Validate Account – Validate customer’s bank account (often after penny-drop / external validation).

Other lookup utilities (e.g. IFSC / pincode resolution) are available under adjacent categories in the portal.

-------------------------------------------------------------------------------------------

End-to-End FD Booking Flow : This section describes the canonical new FD booking flow, mapped to API categories.

Pre-Requisites

  • Obtain API Key & Secret.
  • Configure environments and IP whitelisting with 1Silverbullet.
  • Configure issuer mappings, channels, and products in your platform.

Step-by-Step Journey

Step 1 – Health Validation

  1. Distributor backend calls Application Health → Health Check.
  2. Use this for runtime monitoring and go/no-go checks.

Step 2 – Product Discovery & Comparison

  1. Call Products → Get Product List to fetch available schemes.
  2. Optionally use: o Filter Product List for server-side filtering o Get Product Detail for full details o Compare Product for backend-driven comparison o FD Calculator to compute maturity values for selected options.
  3. Display ranked and filtered products in the channel UI.

Step 3 – Capture Customer & Investment Details

  1. UI collects: o Customer profile (name, DOB, PAN, contact details) o Investment details (amount, tenure, payout, product, issuer) o Nominee data o Declarations / consents
  2. Backend builds an internal FD Application Draft aligned to the Commit FD – Version 3 request schema.

Step 4 – KYC Checks

  1. PAN validation via Verify Pan.
  2. Aadhaar validation (Aadhar Verification, Validate Aadhar Info) if required.
  3. Dedupe & existing customer profile via Validate Customer.
  4. VKYC (if mandated) via Initiate VKYC and VKYC Status. The results are persisted against your application record.

Step 5 – Bank Account Validation

  1. Collect funding and payout account details.
  2. Validate account via Validate Account (often post external penny-drop).

Step 6 – OTP & Consent

  1. Generate OTP via OTP Verification → Generate OTP and send to customer.
  2. Verify OTP via Verify OTP.
  3. Record acceptance of terms, declarations, and consents in your application model.

Step 7 – Commit FD

  1. Call Fixed Deposit Booking → Commit FD – Version 3 with complete payload.
  2. Receive: o 1SB request identifier o Issuer application number o Initial status (e.g. pending payment)
  3. Optionally poll booking status using Commit FD Poll Request until ready-for-payment.

Step 8 – Payment

  1. Initiate payment using Payment → Payment with reference to the FD application number.
  2. Redirect user to payment URL / open SDK based on response.
  3. Use: o gateway callbacks to your backend, and o Payment Status / Payment Status (Polling) to converge on terminal payment status.

Step 9 – Confirm Booking

  1. After successful payment, use Application Status → Application Status Version-3 to fetch booking state.
  2. If not terminal, use Application Status Poll until the FD is booked by the issuer.
  3. Persist the FD number / certificate details and mark application as “Booked”. Step 10 – Documents & Notifications
  4. Upload cheque / OVD as needed using Upload Documents (Upload Cheque, Upload OVD Image).
  5. Trigger confirmation messages using Communication → Email/SMS Notification.

-------------------------------------------------------------------------------------------

FD Premature Withdrawal Flow

  • Customer selects an FD and requests early closure.
  • Call Premature Withdrawal → FD Premature Withdrawal Inquiry to compute penalty and net payout.
  • Display details (penalty, reduced interest, net payable) to customer.
  • If customer confirms: o Optionally run OTP verification, o Call FD Premature Withdrawal Closer.
  • Track final status through Application Status or issuer-specific status endpoints and update your records.

-------------------------------------------------------------------------------------------