Skip to main content

Wealth PMS/AIF Management Gateway API

Overview & Scope The PMS/AIF Wealth Management Gateway APIs from 1Silverbullet allow a distributor to embed PMS onboarding and investment journeys into their own channels, while the AMC/manufacturer retains control of product configuration, risk profiling, AML checks and document workflows.

This guide covers only the PMS/AIF APIs exposed under the Wealth - PMS/AIF - Wealth Management Gateway API, organized into the following domains:

• Application Health

• Manufacturer

• Product

• Customer (KYC, profile, banks)

• Account (PMS account + trade)

• Payment

• Orders

• Distributor

• Master (reference data)

• Building Block (config & journeys)

Scope & Actors (PMS Only)

Scope : This guide covers PMS/AIF Wealth – PMS Management Gateway APIs only, under:

• Application Health

• Manufacturer

• Product

• Customer

• Account

• Payment

• Orders

• Distributor

• Master

• Building Block

It is focused on:

• What each API does (business meaning)

• When to use it in the end-to-end PMS journey

• The standard sequence for new PMS onboarding + initial funding

Key systems

• Channel – Web / Mobile / RM portal (UI only)

• Distributor Backend / BFF – Orchestrates journeys, calls 1SB PMS APIs

• 1SB Wealth PMS Gateway – Normalizes PMS APIs across all manufacturers

• Manufacturer PMS System – Final account opening, allocation, servicing

• External Services – CKYC / KRA, AML, e-sign, payment gateway, etc.

Authentication

PMS uses the same Gateway Layer as FD; the Integration Guide specifies HTTP Basic Auth (API key + secret) for Wealth Gateway.

• Authorization: Basic <base64(API_KEY:API_SECRET)>

• Content-Type: application/json

• Accept: application/json

Use environment-specific base URLs as shared by 1SB.

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

PMS API Portfolio – What Each API Means & How To Use It

2.1 Application Health

• Health Check : Simple heartbeat to check PMS Gateway is up.

When to use:

• CI/CD & monitoring

• Pre-production and smoke tests

• Optional at journey start for go/no-go checks

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

2.2 Manufacturer APIs

• Get Manufacturer List : Returns manufacturers (AMCs) mapped to your distributor.

When to Use:

• Populate the AMC dropdown for PMS journeys

• Typically called once per session and cached.

• Get Manufacturer Profile : Returns a selected AMC’s profile plus PMS-specific details (Risk profiling setup, custodians, etc.).

When to Use:

• Display AMC details in UI (name, logos, contact hints).

• Fetch risk profiling configuration and any AMC-specific rules used later in onboarding.

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

2.3 Product APIs

• Product List Inquiry : List of PMS/AIF products offered by a manufacturer (with paging).

When to Use:

• Product discovery/search for a chosen AMC.

• Use to render product tiles/cards before user selects a specific PMS strategy.

• Product Details : Detailed configuration of a given product – min investment, tax eligibility, fee details, SIP/STP logic, and custom fields for onboarding.

When to Use:

• Validate amount, investor type, allowed tax statuses.

• Derive dynamic onboarding questions (customFieldDetails) instead of hard-coding forms.

• Drive downstream logic (e.g., SIP vs. lumpsum vs. top-up support).

2.4 Customer APIs

• Customer KYC : Pulls CKYC/KRA profile for a given PAN + DOB for specific manufacturer & product.

When to Use:

• First touch in onboarding after product selection.

• Autofill customer form; identify missing or stale data.

• Returns a sessionId used in Create Customer.

• Create Customer : Creates or updates a customer record in 1SB PMS for a manufacturer/distributor combination.

When to Use:

• Called after KYC screen is completed and validated.

• Produces customerId, the handle for all future PMS actions for that person.

• Get Customer : Fetches customer record for a manufacturer/product combo.

When to Use:

• Re-use existing PMS customers (repeat investments, top-ups).

• Pre-populate forms for existing clients.

• Update Customer : Updates an existing customer’s profile (address, contact, occupation, etc.) for a PAN + manufacturer + distributor.

When to Use:

• Profile maintenance, post-onboarding changes.

• Clean-up failed/partial onboarding records.

• Get Customer Banks : Lists funding/payout bank accounts registered for the customer.

When to Use:

• Pre-select default bank when creating PMS accounts.

• Add Customer Bank Detail : Adds a bank account (IFSC, account no, type, etc.) against a customer.

When to Use:

• During onboarding if customer doesn’t have a bank mapped.

• Get Customer Bank Details : Returns full details of a specific bank mapping.

When to Use:

• Show more info in UI (branch, bank name, account type) when user picks an account.

• Update Customer Bank Details : Edit an existing bank record (e.g., mark as primary, change status).

When to Use:

• Post-onboarding maintenance; reflect account changes.

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

2.5 Account APIs

• Get Account : Retrieves PMS account details (holders, nominees, SIP, etc.).

When to Use:

• Servicing dashboards, RM view, or refresh during top-up flows.

• Add Account : Creates a new PMS account for an existing customer and product; includes nominees, joint holders, demat, trade details, and sometimes SIP settings.

When to Use:

• Core PMS account opening step after KYC + customer creation + bank setup.

• Update Account : Updates an existing PMS account (e.g., some details before finalisation).

When to Use:

• Correct or enrich details before documents/e-sign, or in controlled servicing scenarios.

• Get Documentgenerationstatus : Retrieves document generation status for a PMS account (e.g., if docs ready/signed).

When to Use:

• Polling after triggering document creation and e-sign flows.

• Gate next steps (payment / order) on status “READY” / “SIGNED”.

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

2.6 Payment APIs

• Payment Status : Returns the current status of a payment link associated with a trade (sbTranId).

When to Use:

• Backend polling to determine success/failure after redirect from payment gateway.

• Cancel Payment Link : Cancels an existing payment link by paymentId.

When to Use:

• If the customer abandons or restarts the flow, or the order is modified before payment.

Note: The creation of the payment link is handled via Orders → Get Orders Payment Link, not in the Payment category itself.

2.7 Orders APIs

• Add Orders : Creates an order for a PMS transaction (funding, top-up, SIP, etc.) against an account/trade.

When to Use:

• After KYC, account creation, AML and document preparation, once customer confirms the investment.

• Get Orders : Search/list PMS orders (by customer, account, date, status, etc.).

When to Use:

• Portfolio / order history screens, backend reconciliation.

• Get Orders Detail : Detailed view of a specific PMS order (amount, type, status, allocations).

When to Use:

• RM / Ops dashboards; service requests.

• Update Orders : Update an existing order (e.g., change from draft to confirmed, or adjust before payment where allowed).

When to Use:

• Rectify or adjust orders before final payment or execution.

• Get Orders Payment Link : Generates/returns the payment link for a given orderId and transactionType (funding | TopUp | SIP).

When to Use:

• Primary way to initiate customer payment for PMS orders.

• Provides paymentLink + paymentId which are later used with Payment Status/Cancel APIs.

• Get Parent Orders Detail : Retrieves the “parent” order (e.g., original onboarding order) for linked child orders.

When to Use:

• Understand relationship between top-ups/SIPs and the original subscription; helpful for ops reporting.

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

2.8 Distributor APIs

• Get Distributor Settings : Returns distributor-level configuration (channel codes, limits, flags, etc.).

When to Use:

• Called at startup/session to know what features are enabled (e.g., allowed transaction types, risk rules).

• Helps hide unsupported flows (like SIP/top-up) in UI.

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

2.9 Master APIs

• Get Pincode : Returns city/state (and/or matching pincodes) for a given pincode or returns entire pincode master.

When to Use:

• Auto-fill address fields; reduce input errors.

• Get Bank Detail : Returns bank details for an IFSC code.

When to Use:

• Validate and display bank name/branch when capturing bank accounts.

• Valid Values : Returns allowed values for many PMS master fields (e.g., Product Group, Tax Status, Mode of Operation, Fee Type, Occupation, Source of Wealth, etc.).

When to Use:

• Populate dropdowns and enforce valid values client-side.

• Ensure your UI uses the same codes as 1SB/Manufacturer.

Entity Company Search / Entity Sector Search : Helpers to search companies and sectors (for portfolio, risk, or order tagging).

When to Use:

• Advanced flows where customer invests via company entities or sector-classified mandates.

2.10 Building Block APIs • Get Otp : Generates an OTP for given email/mobile.

When to Use:

• Second factor for critical steps (final confirmations, consent, high-value orders).

• Validate Otp : Verifies OTP against its transaction ID.

When to Use:

• Complete OTP challenge; record proof of consent.

• Upload File / Download File : Upload/download files to/from an S3 bucket (KYC docs, signatures, etc.).

When to Use:

• Support scanned docs, cheques, or proof uploads within PMS journeys.

• AML Check : Triggers/checks AML status for a given PMS account (accountId) and returns AML status flags.

When to Use:

• Post account creation, pre-documentation or pre-order approval checkpoints.

• Liveness Check : Performs a liveness check (usually for video-based verification).

When to Use:

• Advanced flows where video KYC / liveness proof is needed.

• Document E Sign : Initiates e-sign/e-stamp/e-stamp+e-sign process for PMS documents with associated file paths and sub-document IDs.

When to Use:

• After documents are generated, before marking the account/order as ready for funding.

• OCRcheck : OCR over an uploaded document (e.g., to read fields).

When to Use:

• Automate extraction (PAN/name/address) from scanned images where needed.

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

PMS API Sequence – For New Onboarding & Initial Funding

This is the standard sequence of APIs for a new PMS investor (DIY / RM-assisted). Adjust for your specific flow, but this is the canonical order.

Step 0 – Environment & Master Setup (one-time / periodic) Used by your backend, not per customer:

  1. Health Check (Application Health → Health Check)
  2. Get Distributor Settings (Distributor) – what’s enabled for this partner.
  3. Validate Values (Master) – cache master lists (tax status, mode of holding, etc.).
  4. Optional: Get Pincode, Get Bank Detail, Entity Company/Sector Search as needed.

Step 1 – Manufacturer & Product Selection Per user journey:

  1. Get Manufacturer List – show AMCs mapped to your distributor.
  2. Get Manufacturer Profile – once AMC is selected; pull profile & risk rules.
  3. Product List Inquiry – list PMS strategies for that AMC.
  4. Product Details – when a product is selected; fetch min amount, fees, risk profile, and custom fields to build the onboarding form.

Step 2 – KYC & Customer Creation

  1. Customer Kyc – PAN + DOB + manufacturer + product. Pre-fill from CKYC/KRA.
  2. UI lets user confirm/complete details (address, contact, occupation).
  3. Create Customer – create/update PMS customer → get customerId.
  4. Optional: o Get Customer – to verify saved data o Update Customer – for minor fixes if required.

Phase 3 – Bank Details

  1. Get Customer Banks – see if customer already has a bank mapped.
  2. If not, Add Customer Bank Detail – add new bank (using Get Bank Detail for IFSC validation).
  3. Optional: Get Customer Bank Details / Update Customer Bank Details for changes.

Step 4 – Account Creation & AML Check

  1. Add Account – create PMS account for chosen product:

    • Link customerId, productId, bank, nominees, joint holders, demat, SIP details, initial investment amount.

  2. AL Check – run AML check on the newly created accountId.

  3. Optional: Get Account – confirm full account snapshot.

Step 5 – Generate Documents & E-Sign

  1. Generate PDFs (issuer-specific templates, often done by 1SB/Manufacturer once account is created).
  2. Upload File – if any additional docs must be uploaded by channel (signed forms, POA scans).
  3. Document E Sign – send docs for e-sign/e-stamp:

• Pass productId, accountId, filePath, subDocumentId, requestType (eSign | eStamp | eStamp-eSign). 6. Get Documentgenerationstatus – poll until status is SIGNED / equivalent.

Step 6 – OTP & Consent (optional but recommended)

  1. Get Otp – send OTP to customer’s mobile/email at final confirmation step.
  2. Validate Otp – verify entered OTP and log consent.

Step 7 – Order Creation & Payment

  1. Add Orders – create order for PMS onboarding (usually funding type) against that accountId.

  2. Get Orders Payment Link – for that orderId with transactionType=funding.

    • Use data.paymentLink to redirect/open payment page.

  3. Customer completes payment on PG.

  4. Payment Status – poll payment status using sbTranId and/or paymentId until terminal (SUCCESS/FAILED).

  5. If payment needs to be invalidated (expired, changed order): Use Cancel Payment Link.

Phase 8 – Order Confirmation & Post-Booking

  1. Get Orders Detail – confirm final order status (EXECUTED/PENDING, etc.).
  2. Get Orders (list) – show order history in portfolio view.
  3. Get Parent Orders Detail – if you need to tie top-ups/SIPs to original order.
  4. Get Account – refresh account state in your system.