Skip to main content

Apply for Loan by Tenant and Business

PATCH /api/v1/businesses/{businessId}/tenants/{tenantId}/loan/apply

Description​

Apply for a loan by tenant and business.

Path Parameters​

NameTypeDescription
businessIdstringThe business ID (path)
tenantIdstringThe tenant ID (path)

Request Body​

  • Content Type: application/json
{
  "productCategory": "Inventory Financing",
  "productType": "Agric Commodities",
  "customProductType": "string",
  "productList": "string",
  "loanType": "Domestic",
  "productUnit": "Barrels",
  "productQuantity": 0,
  "productUnitPurchasePrice": 0,
  "productUnitSellingPrice": 0,
  "logisticsCostPerTruck": 0,
  "logisticsNumberOfTrucks": 0,
  "loanAmount": 0,
  "paymentTenorInDays": 0,
  "requestId": "string",
  "offTakerId": "string",
  "offTakerName": "string",
  "offTakerEmail": "string",
  "offTakerAddress": "string",
  "loanOriginator": "TRACE",
  "loanPurpose": "string",
  "invoiceIssuedDate": "string",
  "otherCostAmount": 0,
  "otherCostDescription": "string",
  "docLinks": [
    {
      "name": "string",
      "link": "string"
    }
  ]
}

Response Code: 200 - OK​

Description

Loan application submitted successfully.

Headers​

Content-TypeValue
apiKey{{apiKey}}

Body​

{
  "productCategory": "Inventory Financing",
  "productType": "Agric Commodities",
  "customProductType": "Custom Type",
  "productList": "Product List",
  "loanType": "Domestic",
  "productUnit": "Barrels",
  "productQuantity": 100,
  "productUnitPurchasePrice": 200,
  "productUnitSellingPrice": 250,
  "logisticsCostPerTruck": 300,
  "logisticsNumberOfTrucks": 4,
  "loanAmount": 50000,
  "paymentTenorInDays": 90,
  "requestId": "req123",
  "offTakerId": "off123",
  "offTakerName": "OffTaker Inc.",
  "offTakerEmail": "offtaker@example.com",
  "offTakerAddress": "123 OffTaker St.",
  "loanOriginator": "TRACE",
  "loanPurpose": "Purchase Inventory",
  "invoiceIssuedDate": "2023-07-09",
  "otherCostAmount": 1000,
  "otherCostDescription": "Storage Costs",
  "docLinks": [
    {
      "name": "Contract",
      "link": "http://example.com/contract"
    }
  ]
}

🔑 Authentication bearer​

ParamValueType
token{{accessCode}}string

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request PATCH \ 
 --url  /api/v1/businesses/{businessId}/tenants/{tenantId}/loan/apply \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!