Lending Programs

To offer lending products like Charge Cards, you'll need to get a Lending Program approved by the Bank.

Think of your Lending Program as a credit line set by the Bank. This size of the credit line determines the total amount you can lend to your customers through lending products connected to the particular Lending Program.

The total credit issued to customers cannot exceed your Lending Program's size. This ensures responsible lending practices.

The Bank may approve several Lending Programs, each tailored to specific lending products you offer to your customers.

Besides program limit size the Lending Program also includes other essential attributes, such as type, name, and date of creation.

Lending Program Types

Currently you can open several Lending Programs types with the Bank, depending on the type of the Lending products you plan to offer to your customers. Later other types of Lending Program Types will be introduced.

type	Description
BankSponsoredBusinessChargeCard	Business Charge Card with the capital for lending purposes is provided by the Bank
ClientSponsoredBusinessChargeCard	Business Charge Card with the capital for lending purposes is provided by the Client
ReceivablesRetention	Business Charge Card where the capital for lending purposes is provided by the Bank, and receivables are created and retained by the Bank to enable financial charges like interest and fees on the card

Lending Program Extended Information

At any point of time an extended information on the current status of the Lending Program can be extracted. It contains the data on utilized and available part of the Lending Program size.

Extra information for the lending program Lending Program Extra Information

Get by Id

Get a lending program resource by id.

Verb	GET
Url	https://api.s.unit.sh/lending-programs/{id}
Required Scope	lending-programs
Timeout (Seconds)	5

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	Lending Program	A lending-program resource.

curl -X GET 'https://api.s.unit.sh/lending-programs/1' \
-H "Authorization: Bearer ${TOKEN}"

Get Extended Information by Id

Get lending program extended information resource by id.

Verb	GET
Url	https://api.s.unit.sh/lending-programs/{id}/extended
Required Scope	lending-programs
Timeout (Seconds)	5

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	Lending Program Extended Information	A lending-program extended information resource.

curl -X GET 'https://api.s.unit.sh/lending-programs/1/extended' \
-H "Authorization: Bearer ${TOKEN}"

List

List lending program resources. Paging can be applied.

Verb	GET
Url	https://api.s.unit.sh/lending-programs
Required Scope	lending-programs
Timeout (Seconds)	5

Query Parameters

Name	Type	Default	Description
page[limit]	integer	100	Optional. Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
page[offset]	integer	0	Optional. Number of resources to skip. See Pagination.
filter[name]	string	(empty)	Optional. Filters the results by the specified program name.
filter[programType]	string	(empty)	Optional. Filters the results by the specified Lending Program Type.
filter[minProgramLimit]	string	(empty)	Optional. Filters the results by a minimum value of programSizeLimit.
filter[minProgramLimit]	string	(empty)	Optional. Filters the results by a maximum value of programSizeLimit.
filter[orgId]	string	(empty)	Optional. Filters the results by the specified org id.
filter[bankId]	string	(empty)	Optional. Filters the results by the specified bank id.

curl -X GET 'https://api.s.unit.sh/lending-programs?page[limit]=20&page[offset]=10' \
-H "Authorization: Bearer ${TOKEN}"

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	Array of Lending Programs	Array of lending-program resources.

Example Response:

{
  "data": [
    {
      "type": "bankSponsoredChargeCardProgram",
      "id": "12",
      "attributes": {
        "createdAt": "2024-02-16T16:32:11.741Z",
        "name": "Unit Finance Inc - MyBank BankSponsored Lending Program",
        "programSizeLimit": 10900000
      }
    },
    {
      "type": "bankSponsoredChargeCardProgram",
      "id": "13",
      "attributes": {
        "createdAt": "2024-02-16T16:32:12.307Z",
        "name": "Unit Finance Inc - MyBank Lending Program",
        "programSizeLimit": 10900000
      }
    },
    {
      "type": "clientSponsoredChargeCardProgram",
      "id": "15",
      "attributes": {
        "createdAt": "2024-02-16T20:29:46.920Z",
        "name": "Unit Finance Inc - MyBank ClientSponsored Lending Program",
        "programSizeLimit": 10900000
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 3,
      "limit": 100,
      "offset": 0
    }
  }
}