API

{
  "api_token": "i64kjZkMwoE2nnR36b6FKRi64kH8TG3z"
}

Solaris Finance Calculator API v1

All endpoints require api_token. Server will return a 422 Error if incorrect value is provided.

Get details

Example Request

curl -X GET "https://solaris.finance/api/v1/details?api_token=i64kjZkMwoE2nnR36b6FKRi64kH8TG3z"

Example Response

{
   "chattel": {
      "min": 5500,
      "max": 150000,
      "min_repayment": {
         "24": 259,
         "36": 179,
         "48": 139,
         "60": 116,
         "72": 100,
         "84": 88
      },
      "max_repayment": {
         "24": 7547,
         "36": 5198,
         "48": 4027,
         "60": 3326,
         "72": 2940,
         "84": 2610
      }
   }
}

The endpoint provides details required to request a quote.

This endpoint is a pre-requisite for GET /quote.

Get details - HTTP request

GET https://solaris.finance/api/v1/details

Get details - Query parameters

Get quote

Example Request

curl -X GET "https://solaris.finance/api/v1/quote?api_token=i64kjZkMwoE2nnR36b6FKRi64kH8TG3z&new_bill=1000&old_bill=2000&system_cost=49000"

Example Response

{
  "data": {
    "24": {
      "repayment": 2510.32
    },
    "36": {
      "repayment": 1736.48
    },
    "48": {
      "repayment": 1350.69
    },
    "60": {
      "repayment": 1120.11
    },
    "72": {
      "repayment": 968.44
    },
    "84": {
      "repayment": 859.83
    }
  },
  "type": "chattel",
  "include_gst": "no",
  "system_cost": 53900,
  "system_cost_gst": {
    "excl_gst": 49000,
    "incl_gst": 53900
  },
  "doc_fee": 330,
  "show_graph": true,
  "applicable_date": "03/04/2018",
  "title": "Chattel Mortgage Quote",
  "legend": [
    "Term",
    "Repayment"
  ]
}

This endpoint retrieves quote details for specific system cost or repayment amount.

Get quote - HTTP request

GET https://solaris.finance/api/v1/quote

Get quote - Query parameters

Errors

Example Error

{
  "message": "Something went wrong! Please email contact@solarisfinance.com.au"
}

The API uses the following error codes:

Slugs

• "Slugs" are referral information that is attached to the direct URL to the application creation page, where end users can access and submit new applications with the desired information.

• Types of referral information that can be used as a slug are below:

  • Supplier code
  • Broker code
  • Referrer code

Creating a referrers code

• These codes are assigned to your account by the Solaris admin team, so if your account has a proper referral code activated, you can retrieve your assigned slug URL from the Solaris Finance portal homepage:

• The short link for a customer to start their own application is https://solaris.finance/apply
• Slugs can be added on to the end of this URL to track where the application came from

Slug types:

• Referrer

  • Format: /r_name
  • E.g. /r_abc123
  • A referrer does not manage the finance transactions, they simply hand the lead over to Solaris
  • URL example: https://solaris.finance/apply/r_abc123

• Broker

  • Format: /b_name
  • E.g. /b_xyz123
  • A broker is an employee/contractor of Solaris who writes deals on our behalf
  • URL example: https://solaris.finance/apply/b_xyz123

• Supplier

  • Format: /name
  • E.g. /company123
  • The supplier name DOES NOT have prefix a letter and underscore
  • URL example: https://solaris.finance/apply/company123

Furthermore, multiple slugs can be placed in the same URL. The order of the slugs does not matter

• https://solaris.finance/apply/r_abc123/company123
  • Referrer: abc123
  • Broker is empty
  • Supplier: company123
• https://solaris.finance/apply/b_xyz123/company123
  • Referrer is empty
  • Broker: xyz123
  • Supplier: company123
• https://solaris.finance/apply/company123/b_xyz123/r_abc123
  • Referrer: abc123
  • Broker: xyz123
  • Supplier: company123
• https://solaris.finance/apply/r_abc123/b_xyz123
  • Referrer: abc123
  • Broker: xyz123
  • Supplier is empty

Create the application through the referral URL

When a broker or referrer sends their business the referral URL and access to this URL, it will redirect to another URL to create an application. After creating application success, this application will display and track by the referrer.

• Get referrer URL The broker, referrer or supplier copy referrer URL and sends to business

• Create application

  • The business access to the referrer URL and will redirect to another URL to create an application
  • A page creates an application that will appear and let you define most of the information you need for your new application

• View application

  • You can view your new application. The supplier, broker or referrer can view this application, depending on which codes where placed in the link

• Application management permission

  • When users login to Solaris Finance, depending on their role they will see the applications they manage:
  • Broker: Can manage applications created by their code and their own applications
  • Referrer: View only applications created by their code and their own applications
  • Supplier: Can manage applications created by that supplier code

Technical Slug documentation

• Referral URL: https://solaris.finance/apply/:b_broker_code/:r_referrer_code/:supplier_code

Depending on the type of code it will have a difference in prefix:

• Supplier
  • Slug don't have prefix
  • Format : supplier_code
  • E.g. /company123
• Broker:
  • Slug have prefix is b_
  • Format: b_broker_code
  • E.g. /b_xyz123
• Referrer:
  • Slug have prefix is r_
  • Format: r_referrer_code
  • E.g. /r_abc123

The order of the slugs does not matter.

Examples:

• https://solaris.finance/apply/r_abc123
• https://solaris.finance/apply/b_xyz123
• https://solaris.finance/apply/company123
• https://solaris.finance/apply/r_abc123/company123
• https://solaris.finance/apply/b_xyz123 /company123
• https://solaris.finance/apply/company123/b_xyz123/r_abc123
• https://solaris.finance/apply/r_abc123/b_xyz123

Access to referral URL => redirect to view create the application

After creating application success, besides information input from the form, the referral code will be saved into the field referrals of the applications table. This application will display and manage by the referrer.