Investor Onboarding

Delete Investors API

5min

This API allows you to delete a specific investor associated with a given customerId. For that, we need to have a hostname and protocol which are as defined in the Authentication﻿section.
Sending Requests
For sending requests the hostname and protocol will be the same as given in the Authentication﻿ section.
Send a post request to: /api/deletemerchants with data as below.
Headers
Property
Value
Content-type
application/json
Authorization
Authorisation header as per the login request
Request Body
JSON
{
    "customerId": "....customer Id.....",
    "merchantId": "....merchant to be deleted id...."
}
{
    "customerId": "....customer Id.....",
    "merchantId": "....merchant to be deleted id...."
}
﻿
The below table describes all the properties available in the request body:
Property
Accepted Values/Format
Description
customerId
String
Unique Id of customer
merchantId
String
Unique Id of Merchant to be deleted
﻿
Expected Delete Investor Response
JSON
{
    "customerId": "...customerId...",
    "merchantId": "...deleted merchant id...",
    "id": 1,
    "result": {
        "deleteReponse": "SUCCESS"
    }
}
{
    "customerId": "...customerId...",
    "merchantId": "...deleted merchant id...",
    "id": 1,
    "result": {
        "deleteReponse": "SUCCESS"
    }
}
﻿
The below table describes the properties that are returned in the request:
Property
Accepted Values/Format
Description
customerId
String
The unique ID of the customer associated with the merchant.
merchantId
String
The ID of the merchant that was deleted.
id
Number
A unique identifier for the response, used for tracking.
result
Object
Contains the result of the delete operation.
result.deleteReponse
String
The status of the delete operation (SUCCESS or FAILURE).
﻿

Property	Value
Content-type	application/json
Authorization	Authorisation header as per the login request

Property	Accepted Values/Format	Description
customerId	String	Unique Id of customer
merchantId	String	Unique Id of Merchant to be deleted

Property	Accepted Values/Format	Description
customerId	String	The unique ID of the customer associated with the merchant.
merchantId	String	The ID of the merchant that was deleted.
id	Number	A unique identifier for the response, used for tracking.
result	Object	Contains the result of the delete operation.
result.deleteReponse	String	The status of the delete operation (SUCCESS or FAILURE).

Investor Results Fetch by ID

CAMS Integration