Documentation


Welcome to Deko Docs! Here you'll find a comprehensive integration guide and API documentation to help you get up and running with Deko.


Get Started

Integration Profile

This area is intended for all things related to integrating Deko into your platform.

Read the 4 sections below for more details on the integration process:

Integration Profiles

Integration Profiles are detailed settings that can be applied to installations. Settings such as Return URLs from the application form, and the destination of the CSNs.

Integration Profiles page with 'Actions' menu

Integration Profiles page with 'Actions' menu

The actions menu on the right of each Integration Profile row will enable you to edit, assign installations or delete the Integration Profile. When editing or creating an Integration Profile, a pop-up box like this will appear:

Creating a integration profile

Creating a integration profile

To edit the 'Return URLs' or 'CSNs & Notifications' tab, click on the respective tabs. The following is a table for each of the fields with descriptions:

Section
Field
Description

Name

Name

The name of the Integration Profile.

Return URLs

Verified URL

The link back for a customer that has paid for their deposit.

Return URLs

Decline URL

The link back for a customer that has been declined.

Return URLs

Cancelled URL

The link back for a customer that has had their application cancelled.

Return URLs

Referred URL

The link back for a customer that has had their application referred.

CSNs & Notifications

CSN URL

Where the CSN HTTP Post gets sent.

CSNs & Notifications

CSN Notification Email

The email address where the CSN email gets sent to.

The URL that you specify in the return URL Verified box is where your customer will be redirected to when they complete their credit application. Deko will append to this URL query parameters that you can access to inform your analytics or provide more detail to your customer.

The query parameters are as follows:

token: a deposit token for the customers deposit.
statementref: The name that will appear on the customers bank statement for the deposit payment
retaileruniqueref: The internal reference set by yourself for the purpose of tracking the purchase.

An example query string is as follows:

?token=6980bf78cfaefbefb6beee70660fec95&statmentref=Finance+Company+Name&retaileruniqueref=02f10886-506e-0c40-1960-65cc0ff6d252

Assigning an Installation

Once you have created your Integration profile you will need to assign an installation. In order to activate it on the system, from the actions menu click "View & Assign Installations"

Navigating to "View & Assign Installation"

Navigating to "View & Assign Installation"

A pop up menu will appear with a dropdown menu containing all you installations for you account.

Popup menu of assigned installations

Popup menu of assigned installations

You will need to select the installations and add them, before confirming all the additions by clicking on the update button. This will assign your installations.

Assigned installation

Assigned installation

CSN Logs

The CSN log lists all CSN's sent to your server, along with your server's HTTP response code. This is intended to assist in the integration process, as well as to ensure your server is successfully receiving CSN's.

You can choose to resend a CSN with first circular arrow icon and view the application the CSN refers to with the link icon.

CSN Logs

CSN Logs

API Logs

These logs detail each of the requests you have made to the Deko API. It's possible to click one to see the data you send (Data Received) and the response the Deko API gave (Response).

API Keys

Currently this page displays your one and only 32 character long API Key, however in the future you will be able to create multiple API Keys for separate purposes.

API Key page

API Key page

Integration Profile


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.