1 of 1

Create loan offer

Create loan offer for a person

Use case

In this example, we will review how to create a loan offer for a person:

Use case data

API parameters with values

The loan offer is created for a person with ID-3392.

...persons/ID-3392/offers

The borrower requested 20000 GBP.

The borrower has requested a loan for 12 months.

The loan offer is created under a BALLOON_LOAN product.

The borrower has to repay the loan on the first day of the month.

The corresponding loan product was created on the MB tenant.

The loan payment channel code.

The borrower has to make a repayment of 117.16 GBP monthly.

The loan offer country. Note: the loan offer country should match the country settings of the corresponding loan product.

The amount that is offered to the loan borrower.

Sample API call

To create a new loan offer, call the following endpoint:

Sample request

Below is an example request of the API call for creating a loan offer.

{
  "requestedMoney": {
    "amount": "20000",
    "currencyCode": "GBP"
  },
  "loanPeriod": 12,
  "loanTypeCode": "BALLOON_LOAN",
  "paymentDay": 1,
  "tenantCode": "MB",
  "paymentChannelCode": "TRUSTLY",
  "monthlyRepaymentMoney": {
    "amount": "117.16",
    "currencyCode": "GBP"
  },
  "countryCode": "GB",
  "offeredMoney": {
    "amount": "20000",
    "currencyCode": "GBP"
  }
}

curl --location 'https://loan-api.sandbox.tuumplatform.com/api/v3/persons/ID-3392/offers' \
--header 'x-channel-code: SYSTEM' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHBpcnlEVGltZSI6IjIwMjQtMDktMDJUMTU6Mjg6MDMiLCJleHAiOjE3MjUyOTA4ODMsInJvbGVzIjpbIkFETUlOIl19.ZmKWmFy9oQ0vsKUILoQaZooxWS_OisXeqjf63ukmJS4' \
--header 'Content-Type: application/json' \
--data '{
  "requestedMoney": {
    "amount": "20000",
    "currencyCode": "GBP"
  },
  "loanPeriod": 12,
  "loanTypeCode": "BALLOON_LOAN",
  "paymentDay": 1,
  "tenantCode": "MB",
  "paymentChannelCode": "TRUSTLY",
  "monthlyRepaymentMoney": {
    "amount": "117.16",
    "currencyCode": "GBP"
  },
  "countryCode": "GB",
  "offeredMoney": {
    "amount": "20000",
    "currencyCode": "GBP"
  }
}'

Sample response

Below you find an example response body to the API call above.

Response

{
    "errors": null,
    "validationErrors": null,
    "data": {
        "offerId": "ID-1664282485",
        "applicationId": null,
        "personId": "ID-3392",
        "interestRate": 5,
        "loanToValue": null,
        "requestedMoney": {
            "amount": 20000.00,
            "currencyCode": "GBP"
        },
        "offeredMoney": {
            "amount": 20000.00,
            "currencyCode": "GBP"
        },
        "grossMoney": {
            "amount": 20000.00,
            "currencyCode": "GBP"
        },
        "netMoney": {
            "amount": 20000.00,
            "currencyCode": "GBP"
        },
        "loanPeriod": 12,
        "statusCode": "PREPARING",
        "offerDate": "2023-07-03",
        "statusDate": "2023-07-03",
        "statusComment": null,
        "loanTypeCode": "BALLOON_LOAN",
        "invoiceDay": null,
        "paymentDay": 1,
        "servicingAccountId": null,
        "apr": null,
        "scheduleTypeCode": "BALLOON",
        "purpose": null,
        "monthlyRepaymentMoney": {
            "amount": 117.16,
            "currencyCode": "GBP"
        },
        "monthlyRepaymentRate": null,
        "tenantCode": "MB",
        "statusCodeReason": "NEW_OFFER",
        "minimalWithdrawalTypeCode": null,
        "minimalWithdrawalMoney": null,
        "maxPeriod": 120,
        "maxMoney": {
            "amount": 100000.00,
            "currencyCode": "GBP"
        },
        "applicationScore": null,
        "countryCode": "GB",
        "channelCode": "SYSTEM",
        "numberOfPayments": 12,
        "annuityMoney": null,
        "validityRange": {
            "startDate": "2023-07-03",
            "endDate": "2023-07-03"
        },
        "additionalData": null,
        "interestMarginRate": null,
        "interestBaseRate": null,
        "interestTypeCode": "FIX",
        "rateBaseCode": null,
        "paymentFreeMonths": null,
        "invoiceDeliveryMethod": null,
        "source": null,
        "repaymentChannelCode": "TRUSTLY",
        "campaignIds": [],
        "limitUsageDate": null,
        "contractEndDate": null,
        "amortisationPeriod": 300,
        "interestRateCapLevel": null,
        "interestRateCapCode": null,
        "interestRateCap": null,
        "maxInvoiceMoney": null,
        "minInvoiceMoney": null
    }
}

Result

The outcome of the API call is the complete set of loan offer data. Including the parameters generated by the Tuum system:

Parameter and value

Explanation

A new loan offer was created.

The loan offer date format is: YYYY-MM-DD.