Skip to main content

Offer Request

warning

Required Feature

Incoming call to lenders system. Lenders must be able to receive data (format and values will be agreed), and make a loan decision on the basis of this offer request. The preferred way is an immediate response returned, the three different responses are described below. If not possible with an immediate response it can also be made asynchronously, as a callback.

Please note that a response to the loan offer request is required, in one form or another. Avica Group needs to know whether the lender is interested in giving an offer, within a reasonable time in order to close the process and present any offers to the customer (or inform that no offers could be given). This means that a response (directly or via callback), with offer acceptance or rejection will have to be received within a short time span - preferably within 60 seconds.

Important here is that no CreditProvider Score check leaves a mark on the user at this stage.

Example Request​

All values collected in the form on https://myloan.co.za/ are available to send. Here is a simplified example of offer values that could be included in the offer request. Fields/values, format and structure can be customized to fit your system. Document with all fields will be shared later in the process. The CreditLimit is an optional info if you are willing to lend the customer even more than there we requested. Then we can display the option to the user and later in the flow the user should be able to choose the higher amount.

{
    "status": "REQUEST",
    "applicationId": "46817892",
    "amount": 150000,
    "creditLimit": 250000,
    "customer": {
        "firstname": "John",
        "lastname": "Doe",
        "email": "john.doe@example.com",
        "cellphone": "0711111111",
        "dateOfBirth": "1983-05-19",
        "gender": "male",
        "incomeNetMonthly": 3200,
        "said": "99999999999"
    },
    "meta": {
        "ip": "127.0.0.1",
        "time": "2023-12-31 12:22:30"
    }
}

Example Responses​

In case the decision is communicated via callbacks, a simple HTTP 200 is good enough as response to the loan offer request. If however a decision is returned directly in the request call response, the default expected data are as follows:

Pending​

In case no immediate decision is available, and offer status is available at a later stage, this is the status that needs to be returned for the offer request. This can be in case the offer request needs to be handled manually, or if the preferred way of returning the offer details is to make the callback asynchronously - calling with either REJECTED or ACCEPTED in separate call to Avica Groups system.

{
    "status": "PENDING",
    "applicationId": "46817892"
}

Rejected​

Customer loan data did not live up to the desired criteria for granting a preliminary loan offer. Lender refused to give an offer, and nothing more will happen with this customer's application.

{
		"status": "REJECTED",
		"applicationId": "46817892"
}

Approved​

Lender wants to grant a loan offer to the customer on the basis of the data in the loan offer request. The actual approved offer can either be returned directly in the response or in a later callback.

{
    "status": "APPROVED",
    "applicationId": "46817892"
}

If the loan details are not delivered in a callback later, then all of the offer data needs to be included in this response.