projects.products

Overview

A lending product describes any sort of lending service that you want to offer to your users. The Lending Products API allows you to create and manage these service offerings which can be used across all your lending apps within a project. The core component of each product are the Lending Terms. These terms dictate how each lending contract is created.

JSON representation

"productId": string,
"productType": string,
"status": number,
"displayName": string,
"displayPriority": number,
"terms": object(LendingTerms),
"description": string | null,
"skuId": string | null,
"labels": object(Labels) | null

Fields

Field	Data Type	Description
productId	string	Required. Unique string that identifies the product. Read-only after creation
productType	string ( 'loan' )	Required. The product type. Read-only after creation
status	number	The product status. The values are enumerated below. 0: In beta testing 1: General availability/live 2: Deprecated 4: Suspended 8: Pending Deletion 9: Deleted Read-only
terms	object ( LendingTerms )	Required. Lending terms for the product. Read-only after creation
displayName	string	Required. The product's display name. Read-write
description	string | null	The product's description. Read-write
displayPriority	number	The product's priority on a view or user interface . Clients can use this to sort product listings. Can be any number from 1 to 999. Defaults to 999. Read-write
skuId	string | null	Product SKU. Usually this would come from an external system such as an ERP. Read-write
labels	object ( Labels ) | null	Custom product labels. Read-write

List

GET https://lending.wezaapis.com/v1/projects/{projectId}/products

Lists all lending products available for a project.

Path Parameters

Name	Type	Description
projectId	string	Project Id.

Query Parameters

Name	Type	Description
pageSize	integer	Requested size of the next page of data.
pageToken	string	Token specifying the start of the next page. It is returned by the previous response.

Headers

Name	Type	Description
Authorization	string	Bearer token.

200

{
    "products": [
        {
            "uid": "b3143625-5171-5c3d-8fbf-97e100bd4bd0",
            "name": "projects/random-chars-191382/products/30_day_loan_1_repayment",
            "status": 1,
            "createdAt": "2020-07-27T14:40:53.747Z",
            "productId": "30_day_loan_1_repayment",
            "productType": "loan",
            "displayName": "30 day loan (1 repayment)",
            "displayPriority": 999,
            "terms": {
                "period": "30 days",
                "interest": {
                    "type": "compound",
                    "termPeriod": "7 days",
                    "baseRate": 0.15,
                    "adjustment": {
                        "action": "add",
                        "target": "repayment",
                        "valueType": "absolute"
                    },
                    "maxEffectiveRate": 0.8,
                    "riskPremiumRate": 0
                },
                "repaymentInterval": "30 days"
            },
            "charges": [
                {
                    "name": "adjustments/lending.wezaapis.com/product/service_charge",
                    "kind": "lending.wezaapis.com/product/service_charge",
                    "action": "deduct",
                    "target": "principal",
                    "valueType": "relative",
                    "displayName": "administration fee",
                    "value": 0.02
                }
            ],
            "labels": null,
            "description": "30 day loan with 1 repayment."
        }
    ],
    "nextPageToken": null
}

Request Body

The request body should be empty.

Response Body

If successful, the response will contain data with the following structure.

JSON Representation

{
  "products": [
    {
      object(LendingProduct)
    }
  ],
  "nextPageToken": string,
}

Fields

Field	Data Type	Description
products[]	object(LendingProduct)	A list of product instances.
nextPageToken	string	Token to use to fetch the next page of data if any.

Authorization

Requires any one of the following OAuth scopes:

• platform

• platform.lending

• platform.lending:read

The authenticated user must have the lending.products.list permission.