RetailerFinanceCalculator
| API | Description |
|---|---|
| GET api/Retailer/FinanceCalculator/InitialData |
Get the list of all available rate card products for the logged in retailer user |
| GET api/Retailer/FinanceCalculator/{rateCardProductId}/{price}/{deposit} |
Get finance calculator, based on a chosen by the user rate card product, price and deposit. It provides information about the monthly payment, monthly interest rate, total interest payable, APR, etc. which the user can use for launching a loan application. |
ApiDetails
| API | Description |
|---|---|
| GET api/Version |
Get the version of the API |
LoanApplication
| API | Description |
|---|---|
| PUT api/LoanApplication/Amend |
Amend loan application |
| GET api/LoanApplication/Amend/Eligibility/{loanApplicationId}/{price}/{deposit} |
Get eligible products, based on a chosen by the user loan application, price and deposit. |
| DELETE api/LoanApplication/Cancel |
Cancel loan application |
| PUT api/LoanApplication/Sign |
Sign the specified loan application with option to get the signed documents |
| GET api/LoanApplication/Sign/Url/{loanApplicationId}/{shouldSendSigningLink} |
Send email to the customer for signing documents |
| PUT api/LoanApplication/Customer/BankDetails |
Update the bank details of an existing customer, when invalid details were provided before |
| GET api/LoanApplication/Documents/{loanApplicationId}/{documentsFormat} |
Get all documents for a loan application |
| POST api/LoanApplication/Documents/Upload |
Upload documents for a Loan Application in Customer Action Required status |
| PUT api/LoanApplication/Retailer/Reference |
Update RetailersReference field of LoanApplication no matter of its status |
| GET api/LoanApplication/Details/{loanIdentifier} |
Get info for specific loan application |
CreditCheck
Main logic for processing credit checks
| API | Description |
|---|---|
| GET api/Retailer/CreditCheck/InitialData |
Get initial data for the logged in retailer |
| POST api/Retailer/CreditCheck |
Create a new credit check |
QuotationSearch
| API | Description |
|---|---|
| POST api/Retailer/QuotationSearch |
Create quotation search |
| POST api/Retailer/ShortQuotationSearch |
Create short quotation search |
Delegation
| API | Description |
|---|---|
| POST api/Delegation/Omni |
No documentation available. |
| POST api/Delegation/Quotation |
No documentation available. |
Invitation
| API | Description |
|---|---|
| POST api/Retailer/Invitation |
Generate new loan application invitation |
| POST api/Retailer/Invitation/Link?InstallationId={InstallationId}&ApiKey={ApiKey}&CustomerEmail={CustomerEmail}&RetailersReference={RetailersReference}&RateCardProductId={RateCardProductId}&Price={Price}&Deposit={Deposit}&DescriptionOfGoods={DescriptionOfGoods}&EmailInvitation={EmailInvitation} |
Generate new loan application invitation (Returns only raw URL in string format) |
EligibilityCheck
| API | Description |
|---|---|
| POST api/Retailer/EligibilityCheck |
Create a new eligibility check |
| POST api/Retailer/EligibilityCheck/CreditCheck |
Create a new credit check from eligibility check |
FinanceCalculator
| API | Description |
|---|---|
| GET api/Brokerage/FinanceCalculator/InitialData/{brokerageId} |
Retrieve the initial state for PL broker calculator. Available for PL broker users. Does not require authentication |
| GET api/Brokerage/FinanceCalculator/{brokerageId}/{term}/{price} |
Retrieve a list of finance products, based on provided term and price. Available for PL broker users. Does not require authentication. |
| POST api/Brokerage/FinanceCalculator/QuoteEmail |
Insert quote email in the database and send it to the specified email address |
AlternativeFinanceOffer
| API | Description |
|---|---|
| GET api/LoanApplication/AlternativeFinanceOffer/{loanApplicationId} |
Get alternative finance offer |
| POST api/LoanApplication/AlternativeFinanceOffer |
Complete alternative finance offer |
Introducer
| API | Description |
|---|---|
| GET api/Introducer/CreditCheck/InitialData |
Get initial data. Available for introducer users |
| POST api/Introducer/CreditCheck |
Create a new credit check |
LoanApplicationStatus
| API | Description |
|---|---|
| GET api/LoanApplication/Status/{id} |
Get the status of the loan application |
| PUT api/LoanApplication/Status |
Update the loan application status after the third-party application have received the loan application result. Third-party application can change the status to awaiting fulfilment or order fulfilled |
| PUT api/LoanApplication/Status/Complete |
Update the loan application status from retailer's "Order fulfilled" and broker's "Approved" to "Complete" |