API Products Working-Version¶
DLL’s Global APIs can be used for programs, and finance application management to calculate the financial quote, submit finance applications for credit approval, get details of a previously submitted application and retrieve a list of finance applications based on the filter criteria. This document is intended to provide an overview of the information necessary for the partner development team to understand the APIs and the various scenarios in which they can be used.
Concepts¶
Programs¶
(Financial) Program refers to the different types of financing options that will be configured to customers based on defined and negotiated terms in a program agreement. These may include leasing, allowable terms, end of contract options, among others.
Financial Products¶
Financial Products refer to the specific financing plans that customers can choose from, such as (fixed or variable rate) loans or (operating or financial) leases. The available Financial Products, the details of the corresponding finance structures and pre-configured rates can be obtained from the Program Search and Retrieval APIs.
Assets¶
Assets refer to the specific equipment that is being financed. Assets belong to a Brand, have a Model Number, and are categorized into Master Types and Types. This information can be obtained from the Program Asset Catalog APIs.
Finance Calculations¶
Before submitting a Finance Application, an consumer can perform Finance Calculations to generate price quotes based on various combinations of Assets and Financial Products and related application attributes. These quotes help in getting an estimate of the payment that is to be made based on the parameters provided, before an application is submitted. The quotes can be generated using the Pricing Information and Calculations APIs.
Finance Applications¶
Finance Applications allow consumers to apply for finance, be assessed for creditworthiness and obtain a finance agreement. Consumers are also able to retrieve the current state details for a previously submitted application and are also able to make changes to the application. The submission, retrieval and editing of Finance Applications can be done using the Finance Application APIs.
Scenarios and Flows¶
The following section describes the various scenarios the Global APIs can be used in and the corresponding API workflows.
Scenario: Authentication and Authorization¶
Before making any API calls, the consumer needs to be authorized. The client credentials will be provided by DLL along with the authorization endpoint. The following diagram illustrates the flow for getting authorized.
Upon successful authorization, a bearer token will be generated which needs to be retained and used in all subsequent API calls.
Scenario: Account and Program¶
This flow shows how to retrieve the relevant Accounts and Programs an user/client has access to.
Scenario: Asset Search¶
Scenario: Financial Products, Assets and Calculations¶
Scenario: Submit Finance Application¶
Assuming that consumer is authenticated and authorized, for submitting a finance application successfully, a valid program, finance product, quote calculation, and valid asset are needed. As shown in the flow below, once the consumer is authenticated and authorized –valid program details can be retrieved using finance programs API. And, financial quote calculation, assets and financial products can be retrieved using finance programs, quote API.
The following diagram illustrates the flow for submitting the Finance Application.
Note
Once the Finance Application is submitted successfully, a Finance Application Id will be returned to the consumer. This ID is required if, at a later point in time, the consumer wants to retrieve the state of the Application or other details regarding the same application.
Scenario: Retrieve Finance Application(s)¶
Assuming that consumer is authenticated and authorized, post the finance application is submitted, the consumer can get details regarding current state of the application, thereby being informed of the status and being in-sync if a change has been made internally at DLL.
There are two sub-scenarios.
Retrieve details of an application¶
Using this scenario – the assumption is that the consumer has already created a finance application and the Application Id is known. Using that Application Id, all the details of the given application can be retrieved.
Retrieve a list of finance applications¶
This scenario is when the consumer wants to list down all the finance applications that satisfy the filter, sort, and pagination criteria provided. This API might not return all the details but limits itself to the minimum details of the list of applications.
