Create Investment Order

  • Updated

Create Investment Order

Description

This web service creates an investment order given a loan Id, and returns the Loan Payment Transaction created.

Definition

GET  https://<domain>/services/apexrest/peer/v1/investmentOrders

Parameters 

The table given below provides details of the request parameters used by this web service:

Fields

Type

Description

loanId *

 String

This is used to identify the loan account. This should be specified in the url, e.g. /v1/investmentOrders/The field used to identify the loan account is the Loan_Account_Id_Field__c field in API Configuration custom setting. If a field is not mentioned the Salesforce ID is used.

status

 String

  • This is the comma separated string for desired statuses of investment orders.

  • If you pass null, all investment orders of the investor are considered.

loanStatus

 String

  • This is the comma separated string for desired loan statuses for which investment orders are to be returned.

  • If you pass null, all investment orders of the investor are considered.

Error messages

When you post a web service, you can receive the possible error messages as shown in the table below:

Error Code

Error Message

System.Label

Reason

HTTP Status Code





Sample request

The sample request to be sent is as shown below:

GET https://na11.salesforce.com/services/apexrest/peer/v1/investmentOrders?investorId=001G000001Phdoe&status=Active&loanStatus=Active - Good Standing

Sample response
The sample response that you will receive is as shown below:

 
          
        

      

 
      
 
      

        
          

        
        
      

 
    

  
    
    

      
      

                
In This Article