Skip to content

1-month or EMI Loan Apply

These APIs are used to apply 1-month and EMI loans.

UML Diagram of loan apply process

1. Process

URL /v4/1-month-or-emi/loan/process
METHOD POST
<br>

a. Customer opting to apply 1-month loan


Apply Loan-Dashboard Enter Loan Amount Invalid Loan Amount Entered Valid Loan Amount 1-Month Choosen Choosing a repayment date
Dashboard Enter Loan Amount Invalid Loan Amount Valid Loan Amount 1-Month Choosen Choosing Repayment Date


b. Customer opting to apply EMI loan with 3 month tenure


Apply Loan-Dashboard Enter Loan Amount Invalid Loan Amount Entered Valid Loan Amount 3-Month Choosen Choosing a repayment date
Dashboard Enter Loan Amount Invalid Loan Amount Valid Loan Amount 3-Month Choosen Choosing Repayment Date


Request body

{
  "bankCode": "SCB",
  "customerNumber": "000123",
  "accountNumber": "100023625"
}


Field Data Type Description
bankCode String Swift code representing the bank (e.g., SCB).
customerNumber String Unique identifier for the customer.
accountNumber String Customer's bank account number.


Response body <button>Copy</button>

{
  "status": "OK",
  "statusCode": 200,
  "series": "SUCCESSFUL",
  "code": 20,
  "phrase": "Successful",
  "message": "Customer can process a loan with following details.",
  "data": {
    "metadata": {
      "token": "token",
      "minAmount": 1000,
      "maxAmount": 200000,
      "unit": "NPR"
    },
    "appView": {
      "header": {
        "title": "Loan Details"
      },
      "body": {
        "sliderSection": {
          "type": "slider",
          "title": "Your available loan limit",
          "input": {
            "value": 100000
          }
        },
        "inputSection": {
          "type": "input_section",
          "title": "Your Loan Amount (in NPR)",
          "input": {
            "type": "number_input",
            "placeholder": "Enter loan amount"
          },
         "url": "/v4/payment/calculator"
        },
        "diceSection": {
          "type": "dice",
          "title": "You will pay the loan in : MONTH(S)",
           "order": "ASC",
          "tenures": [
            {
              "tenure": 1,
              "enabled": true,
              "minAmount": 1000,
              "maxAmount": 50000
            },
            {
              "tenure": 3,
              "enabled": true,
              "minAmount": 5000,
              "maxAmount": 100000
            },
            {
              "tenure": 6,
              "enabled": true,
              "minAmount": 5000,
              "maxAmount": 120000
            },
            {
              "tenure": 9,
              "enabled": true,
              "minAmount": 5000,
              "maxAmount": 150000
            },
            {
              "tenure": 12,
              "enabled": false
            }
          ]
        },
        "datePickerSection": {
          "input": 
                    {
                      "enableDateRangeOneMonth": true,
                      "enableDateRangeEmi": true,
                      "placeholder": "Select Payback Date",
                      "type": "date_picker",
                      "message": "Select your loan maturity date up to a maximum of 30 days from today.",
                      "maxSelectablePaymentDate": "2025-02-26"
                    },
                    "type": "input_section",
                    "title": "Your payback date will be"
            },
        "repaymentSection": {
          "type": "section",
          "title": "NPR 20,000",
          "items": [
            {
              "value": " ",
              "message": "Repayment amount changes with the change in the payback date."
            }
          ]
        },
        "buttonSection": {
          "type": "button",
          "label": "Lets Go",
          "action": {
            "type": "",
            "target": "review"
          }
        }
      }
    }
  },
  "timestamp": "08-08-2024 10:12:57 AM"
}
Field Data Type Description
enableDateRangeEmi Boolean Flag for enabling date range for EMI Loan
maxSelectablePaymentDate Date Max selectable date range for QR EMI
enableDateRangeOneMonth Boolean Flag for enabling date range for One Month Loan
tenures.orders String Order of lloan tenure list it can be either ASC or DESC asecnding order or descending order respectively

2. Review

URL /v4/1-month-or-emi/loan/review
METHOD POST


a. Customer opting to apply 1-month loan


1-month Loan Details Loan Agreement View
1-month Loan Details Loan Agreement View


Request body

{
  "bankCode": "SCB",
  "customerNumber": "000123",
  "accountNumber": "100023625",
  "token": "token",
  "paymentDate": "1723454832000",
  "loanAmount": 30000.00,
  "loanTenure": 1
}
Field Data Type Description
bankCode String Swift code representing the bank (e.g., SCB).
customerNumber String Unique identifier for the customer.
accountNumber String Customer's bank account number.
token String transaction token i.e token sent in process response.
paymentDate Date Payment date in milliseconds since epoch.
loanAmount Double Amount of the loan applied for.
loanTenure Integer Loan tenure duration in months. i.e value sent in process response in field loanTenure


Response body

{
  "status": "OK",
  "statusCode": 200,
  "series": "SUCCESSFUL",
  "code": 20,
  "phrase": "Successful",
  "message": "Customer can book a loan with following details.",
  "data": {
    "metadata": {
      "token": "eligibilityToken"
    },
    "appView": {
      "header": {
        "title": "Loan Details"
      },
      "body": {
        "accountSection": {
          "type": "section",
          "title": "Sudin Shakya",
          "items": [
            {
              "key": "Account",
              "value": "123235678976"
            }
          ]
        },
        "loanSection": {
          "type": "section",
          "title": "Your Loan",
          "items": [
            {
              "key": "Your Loan Amount",
              "value": "NPR 40000.0"
            },
            {
              "key": "Interest rate per month",
              "value": "1.25%"
            },
            {
              "key": "For a period of",
              "value": "1 month(s)"
            }
          ]
        },
        "loanRepaymentSection": {
          "type": "section",
          "title": "Your loan repayment",
          "items": [
            {
              "key": "Total repayment amount",
              "value": "NPR 40509.59"
            },
            {
              "key": "Amount credited to your account on",
              "value": "12th Aug, 2024"
            },
            {
              "key": "Repayment on",
              "value": "11th Sep, 2024"
            }
          ]
        },
        "lateFeeSection": {
          "type": "section",
          "title": "Incase you miss the payment on time",
          "items": [
            {
              "key": "Late fees per month",
              "value": "NPR 300.00"
            },
            {
              "key": "On overdue outstanding principal per month",
              "value": "+0.17%"
            }
          ]
        },
        "adminFeeSection": {
          "type": "section",
          "title": "Loan Administration Fee",
          "items": [
            {
              "key": "Loan Administration fee",
              "value": "NPR 500.00"
            }
          ]
        },
        "loanAgreementSection": {
          "type": "agreement",
          "title": "I agree to the Terms of Loan Agreement",
          "checked": false,
          "value": "<h2 style=\"text-align:center;\"><span\nstyle=\"font-size:18px;\"><strong>1 Terms and Conditions </span></p>"
        },
        "buttonSection": {
          "type": "button",
          "label": "Proceed",
          "action": {
            "type": "",
            "target": "book"
          }
        }
      }
    },
    "timestamp": "08-08-2024 10:12:57 AM"
  }
}

b. Customer opting to apply EMI loan with 3 month tenure

3-month Loan Details Loan Agreement View Expanded Schedule
3-month Loan Details Loan Agreement View Expanded Schedule


Request Body

{
  "bankCode": "SCB",
  "customerNumber": "000123",
  "accountNumber": "100023625",
  "token": "token",
  "paymentDate": "1723454832000",
  "loanAmount": 30000.00,
  "loanTenure": 3
}
Field Data Type Description
bankCode String Swift code representing the bank (e.g., SCB).
customerNumber String Unique identifier for the customer.
accountNumber String Customer's bank account number.
token String transaction token i.e token sent in process response.
paymentDate Date Payment date in milliseconds since epoch.
loanAmount Double Amount of the loan applied for.
loanTenure Integer Loan tenure duration in months. i.e value sent in process response in field loanTenure

Response body

{
  "status": "OK",
  "statusCode": 200,
  "series": "SUCCESSFUL",
  "code": 20,
  "phrase": "Successful",
  "message": "Customer can book a loan with following details.",
  "data": {
    "metadata": {
      "token": "eligibilityToken"
    },
    "appView": {
      "header": {
        "title": "Loan Details"
      },
      "body": {
        "accountSection": {
          "type": "section",
          "title": "Sudin Shakya",
          "items": [
            {
              "key": "Account",
              "value": "123235678976"
            }
          ]
        },
        "loanSection": {
          "type": "section",
          "title": "Your Loan",
          "items": [
            {
              "key": "Your Loan Amount",
              "value": "NPR 30000.0"
            },
            {
              "key": "Interest rate per month",
              "value": "1.33%"
            },
            {
              "key": "For a period of",
              "value": "3 month(s)"
            }
          ]
        },
        "loanRepaymentSection": {
          "type": "section",
          "title": "Your loan repayment",
          "items": [
            {
              "key": "Monthly Installments",
              "value": "NPR 10267.84"
            },
            {
              "key": "Total repayment amount",
              "value": "NPR 30,803.50"
            },
            {
              "key": "Amount credited to your account on",
              "value": "23rd Aug, 2024"
            },
            {
              "key": "Your 1st installment",
              "value": "24th Sep, 2024"
            }
          ]
        },
        "lateFeeSection": {
          "type": "section",
          "title": "Incase you miss the payment on time",
          "items": [
            {
              "key": "Late fees per month",
              "value": "NPR 300.00"
            },
            {
              "key": "On overdue outstanding principal per month",
              "value": "+0.17%"
            }
          ]
        },
        "adminFeeSection": {
          "type": "section",
          "title": "Loan Administration Fee",
          "items": [
            {
              "key": "Loan Administration fee",
              "value": "NPR 500.00"
            }
          ]
        },
        "emiMonthlyBreakDownSection": {
          "type": "collapisible_section",
          "title": "View your loan scedule with a monthly breakdown of EMI",
          "collapsed": true,
          "table": {
            "rows": [
              {
                "id": 1,
                "data": [
                  {
                    "key": "Installment No",
                    "value": "1"
                  },
                  {
                    "key": "Payment Date",
                    "value": "Sep 24, 2024"
                  },
                  {
                    "key": "EMI",
                    "value": "NPR 10,267.84"
                  }
                ]
              },
              {
                "id": 2,
                "data": [
                  {
                    "key": "Installment No",
                    "value": "2"
                  },
                  {
                    "key": "Payment Date",
                    "value": "Oct 24, 2024"
                  },
                  {
                    "key": "EMI",
                    "value": "NPR 10,267.84"
                  }
                ]
              },
              {
                "id": 3,
                "data": [
                  {
                    "key": "Installment No",
                    "value": "3"
                  },
                  {
                    "key": "Payment Date",
                    "value": "Nov 24, 2024"
                  },
                  {
                    "key": "EMI",
                    "value": "NPR 10,267.84"
                  }
                ]
              }
            ]
          }
        },
        "loanAgreementSection": {
          "type": "agreement",
          "title": "I agree to the Terms of Loan Agreement",
          "isChecked": false,
          "value": "<h2 style=\"text-align:center;\"><span\nstyle=\"font-size:18px;\"><strong>1 Terms and Conditions </span></p>"
        },
        "buttonSection": {
          "type": "button",
          "label": "Proceed",
          "action": {
            "type": "",
            "target": "book"
          }
        }
      }
    }
  },
  "timestamp": "08-08-2024 10:12:57 AM"
}

3. Book

URL /v4/1-month-or-emi/loan/book
METHOD POST


a. Book api for both 1-month and EMI Loans


Confirmation Page
Confirmation Page where otp is enterd


Request body

{
  "bankCode": "SCB",
  "customerNumber": "000123",
  "accountNumber": "100023625",
  "token": "eligibilityToken",
  "termsAndConditionsAgreed": true
}
Field Data Type Description
bankCode String Swift Code representing the bank (e.g., SCB).
customerNumber String Unique identifier for the customer.
accountNumber String Customer's bank account number.
token String transaction token i.e token sent in review response.
termsAndConditionsAgreed Boolean Indicates if the customer agreed to terms and conditions.


Response body


{
  "status": "OK",
  "statusCode": 200,
  "series": "SUCCESSFUL",
  "code": 20,
  "phrase": "Successful",
  "message": "Customer can confirm a loan with following details.",
  "data": {
    "metadata": {
      "token": "eligibilityToken",
      "verificationExpiryInSec": 60
    },
    "appView": {
      "header": {
        "title": "Verification"
      },
      "body": {
        "imageSection": {
          "type": "image_section",
          "image_details": {
            "url": "",
            "tint": false
          },
          "message": "We have sent you a 4-digit verification code to your mobile number 9841XXXXXX. Please enter it below."
        },
        "otpSection": {
          "type": "input",
          "subtype": "otp",
          "length": 4
        },
        "resendOtpSection": {
          "type": "action_link",
          "label": "Resend OTP",
          "action": {
            "type": "",
            "target": "resendOTP"
          }
        },
        "loanDepositSection": {
          "type": "info",
          "message": "After confirming, NPR 30000.00 will be deposited to your account instantly."
        },
        "buttonSection": {
          "type": "button",
          "label": "Confirm Loan",
          "action": {
            "type": "",
            "target": "confirm"
          }
        }
      }
    }
  },
  "timestamp": "08-08-2024 10:12:57 AM"
}

4. Confirm

This api will perform a fund transfer to the customer account.

URL /v4/1-month-or-emi/loan/confirm
METHOD POST


a. Confirmation api for both 1-month and EMI Loans


Congrats Submit Other Purpose Share Loan Agreement
Congrats Submit Purpose Share Loan Agreement


Request body

{
  "bankCode": "SCB",
  "customerNumber": "000123",
  "accountNumber": "1111111111",
  "token": "eligibilityToken",
  "otp": "1234"
}
Field Data Type Description
bankCode String Swift Code representing the bank (e.g., SCB).
customerNumber String Unique identifier for the customer.
accountNumber String Customer's bank account number.
token String Transaction Token i.e sent in book api response.
otp String Card verification value for confirmation.


Response body


{
  "status": "OK",
  "statusCode": 200,
  "series": "SUCCESSFUL",
  "code": 20,
  "phrase": "Successful",
  "message": "Loan disbursed successfully.",
  "data": {
    "metadata": {
      "token": "eligibilityToken"
    },
    "appView": {
      "header": {
        "title": ""
      },
      "body": {
        "imageSection": {
          "type": "image_section",
          "image_details": {
            "url": "https://uat-minio-new.foneloan.com.np/customer-new-ui/congratulations-icon%201.svg",
            "tint": false
          },
          "message": "Your loan amount of NPR 40000.00 has been transferred to your bank account.",
          "items": [
            {
              "key": "A/C No",
              "value": "10963836027333473"
            },
            {
              "key": "A/C Name",
              "value": "Sudin Shakya"
            }
          ]
        },
        "purposeSection": {
          "type": "section",
          "title": "",
          "description": "Please let us know how you will be using this fund, so that we can improve our service.",
          "options": [
            {
              "label": "Payments",
              "url": "https://uat-minio-new.foneloan.com.np/customer-new-ui/payments.png",
              "tint": false,
              "type": "button"
            },
            {
              "label": "Rent",
              "icon": "https://uat-minio-new.foneloan.com.np/customer-new-ui/rent.png",
              "tint": false,
              "type": "button"
            },
            {
              "label": "Expenses",
              "icon": "https://uat-minio-new.foneloan.com.np/customer-new-ui/expenses.png",
              "tint": false,
              "type": "button"
            },
            {
              "label": "Others",
              "icon": "https://uat-minio-new.foneloan.com.np/customer-new-ui/others.png",
              "tint": false,
              "trigger_input": {
                "type": "input_section",
                "placeholder": "Enter purpose of loan"
              }
            }
          ]
        },
        "loanAgreementSection": {
          "type": "section",
          "title": "Loan Agreement",
          "url": "/loanAgreementDownload",
          "actions": [
            {
              "type": "action",
              "label": "Download",
              "action": {
                "type": "",
                "icon": "https://uat-minio-new.foneloan.com.np/customer-new-ui/Download.svg",
                "target": "download"
              }
            },
            {
              "type": "action",
              "label": "Share",
              "action": {
                "type": "",
                "icon": "https://uat-minio-new.foneloan.com.np/customer-new-ui/Share.svg",
                "target": "share"
              }
            }
          ]
        },
        "buttonSection": {
          "type": "button",
          "label": "Go to Dashboard",
          "action": {
            "type": "",
            "target": "dashboard"
          }
        }
      }
    }
  },
  "timestamp": "08-08-2024 10:12:57 AM"
}

5. Purpose

This api is used to collect the information about the purpose of loan.

URL /v4/1-month-or-emi/loan/purpose
METHOD POST


a. Purpose api for both 1-month and EMI Loans


Save Purpose
Save Purpose


Request body

{
  "bankCode": "SCB",
  "customerNumber": "000123",
  "accountNumber": "1111111111"
}
Field Data Type Description
bankCode String Swift Code representing the bank (e.g., SCB).
customerNumber String Unique identifier for the customer.
accountNumber String Customer's bank account number.


Response body

{
  "status": "OK",
  "statusCode": 200,
  "series": "SUCCESSFUL",
  "code": 20,
  "phrase": "Successful",
  "message": "Purpose received successfully.",
  "data": {
    "appView": {
      "header": {
        "title": "Congratulations"
      },
      "body": {
        "thankYouSection": {
          "type": "section",
          "message": "Thank you! for sharing your loan purpose."
        },
        "loanAgreementSection": {
          "type": "section",
          "title": "Loan Agreement",
          "url": "/loanAgreementDownload",
          "actions": [
            {
              "type": "action",
              "label": "Download",
              "action": {
                "type": "",
                "icon": "https://uat-minio-new.foneloan.com.np/customer-new-ui/Download.svg",
                "target": "download"
              }
            },
            {
              "type": "action",
              "label": "Share",
              "action": {
                "type": "",
                "icon": "https://uat-minio-new.foneloan.com.np/customer-new-ui/Share.svg",
                "target": "share"
              }
            }
          ]
        },
        "buttonSection": {
          "type": "button",
          "label": "Go to Dashboard",
          "action": {
            "type": "",
            "target": "dashboard"
          }
        }
      }
    }
  },
  "timestamp": "08-08-2024 10:12:57 AM"
}

6. Resend OTP

This api is used to resend otp to customer mobile number.

URL /v4/resend/otp
METHOD POST


Request body

{
  "bankCode": "SCB",
  "customerNumber": "000123",
  "accountNumber": "1111111111",
  "token": "token"
}
Field Data Type Description
bankCode String Swift Code representing the bank (e.g., SCB).
customerNumber String Unique identifier for the customer.
accountNumber String Customer's bank account number.
token String Transaction token i.e send in book api.


Response body


{
  "status": "OK",
  "statusCode": 200,
  "series": "SUCCESSFUL",
  "code": 20,
  "phrase": "Successful",
  "message": "Customer can confirm a loan using a new OTP sent to mobile number.",
  "data": {
    "metadata": {
      "verificationExpiryInSec": 5
    }
  },
  "timestamp": "08-08-2024 10:12:57 AM"
}