There are different types of interactions that can be created. Such interactions, along with their request payload, are mentioned below:

`LOAN_APPLICATION` for connected user

{
    "intent": "LOAN_APPLICATION",
    "config": {
        "assetType": "MUTUALFUND", // OR "STOCKS"
        "userId": "646f5a65a4ae4db366623638",
        "opaqueId": "123" 
    }
}

Note for reapplication (after closing loan)

For a user, who has closed an existing loan, and wants to continue with a new loan i.e wants to reapply for a loan, for such users, an interactionId can be created again as mentioned in the above payload.

A new loan journey will be created for the user, and the new loan application identifier (loan application Id aka LID), will be shared in the response of the create interaction API

{
    "code": 0,
    "data": {
        "createdAt": 1686253244,
        "expireAt": 1686253544,
        "guest": false,
        "intent": "LOAN_APPLICATION",
        "interactionId": "INT64822ebcb406ec46428efac0",
        "lid": "646f5a65a4ae4db366623639",
        "lender": "bajaj_finserv",
        "partner": "gatewaydemo-dev",
        "status": "CREATED",
        "userId": "646f5a65a4ae4db366623638"
    },
    "message": "SUCCESS"
}

`LOAN_APPLICATION` for guest user

For a user with an existing loan application, referral re-attribution will take place only if the user's journey status is before Sign Agreement.

{
    "intent": "LOAN_APPLICATION",
    "config": {
      "lender": "bajaj_finserv",
      "referrer":"gatewaydemo"
    }
}

`LOAN_APPLICATION:TOP_UP` for connected user

For a user with an active loan application, user might want to increase their current loan limit or might want to withdraw more amount by additionally pledging more funds. For such user, a top-up journey can be initiated by creating an interactionId with LOAN_APPLICATION:TOP_UP intent

On initiating a top-up journey, user can perform -

fetch additional holdings and confirm their top-up amount.
Perform KYC (conditionally skipped)
setup mandate for the revised loan amount, followed by pledging of the additional funds
signing of the agreement with the revised loan amount
trigger topup disbursement post lodgement of additional funds is done

{
    "intent": "LOAN_APPLICATION:TOP_UP",
    "config": {
        "assetType": "MUTUALFUND", // OR "STOCKS"
        "userId": "646f5a65a4ae4db366623638",
        "opaqueId": "123" 
    }
}

`LOAN_APPLICATION:RENEWAL` for connected user

For renewing an existing loan which is about to expire, a renewal journey can be initiated for the user by launching the journey with an interactionId of LOAN_APPLICATION:RENEWAL intent

{
    "intent": "LOAN_APPLICATION:RENEWAL",
    "config": {
      "assetType": "MUTUALFUND", // OR "STOCKS"
      "userId": "646f5a65a4ae4db366623638",
      "opaqueId": "123" ,      
      "isAutoDisbursal": false 
    }
}

On initiating a renewal journey,

User would land on the loan card screen, where user can confirm the loan amount and setup new mandate
Next, user can proceed to sign the agreement
Once tenure is extended, the servicing dashboard would now refer to the new application (i.e the loan application ID aka. LID for the renewal loan). Previous LID would be marked as CLOSED

`WITHDRAW` with connected user

{
    "intent": "WITHDRAW",
    "config": {
        "amount": "8901.01",
        "assetType": "MUTUALFUND", // OR "STOCKS"
        "opaqueId": "Sdfjhksljhf53798234",
        "userId": "6481d77b1bd11a820a13e0cf",
        "lid": "16481d77b1bd11a820a13e0c"
    }
}

`PAYMENT` with connected user

Additionally, this intent mandates config.type. Following values are accepted in the field:

"bounced_interest"
"principal"
"shortfall"
"loan_closure"

{
    "intent": "PAYMENT",
    "config": {
        "type": "principal",
        "lid": "648acdf8da1ae7fbbfaa713f",
        "assetType": "MUTUALFUND", // OR "STOCKS"
        "opaqueId": "Sdfjhksljhf53798234",
        "userId": "648ace0076fd318b1bfdeb40"
    }
}

`SERVICE` with connected user

{
    "intent": "SERVICE",
    "config": {
        "assetType": "MUTUALFUND", // OR "STOCKS"
        "userId": "64c780130e047d6851c67fe9",
        "opaqueId": ""
    }
}

200200

400400

Next steps

Next steps