Special Offers API

❗️

Please contact our support team at [email protected] so that we can configure the special offers for your account.

Special Offers are different to the finance products and promotions provided by Deko as standard and displayed at checkout to your customers. Instead, special offers are those finance offers which you can optionally instruct us to display only for selected baskets.

You may choose to do this for specific products (for example where the manufacturer is offering to support the cost of finance), for specific customers, during specific periods, or in other circumstances where you wish to retain the logic to offer specially agreed rates.

Note that like all finance offers, any special offers must first be agreed with your account manager and enabled - but once done so, you retain control of whether to display them.

Display Special Offers using Verify your Basket

This information acts as a supplement to: https://docs.dekopay.com/v5/docs/quick-start

Currently having initialised the DekoWallet plugin on your website you are able to call a finance calculator to retrieve finance products and promotions. When starting checkout you can then submit to Deko an applicable basket using the verify-basket service.

Special Offers can be added to the checkout for a given basket by simply appending the relevant offer IDs to this request. These are added in the basket object, in a new array.

Note that your account manager will provide you the relevant IDs for your special offers. Excerpt from existing verify-basket request (showing basket object only):

"basket": {
   "currency": "GBP",
   "total": 134523,
   "items": [
     {
       "description": "A shiny gold watch",
       "quantity": 1,
       "price": 134523,
       "type": "sku",
       "imageUri": "https://www.merchant.website/product/image/uri.jpg",
       "itemUri": "https://www.merchant.website/product1.html"
} ]
}

New verify-basket / basket API: https://docs.dekopay.com/v5/reference#checkout

Revised API request with instruction to display special offer (basket object only):

"basket": {
   "specialOffers": [
     {
       "id": "a6edc906-2f9f-5fb2-a373-efac406f0ef2"
} ],
   "currency": "GBP",
   "total": 134523,
   "items": [
     {
       "description": "A shiny gold watch",
       "quantity": 1,
       "price": 134523,
       "type": "sku",
       "imageUri": "https://www.merchant.website/product/image/uri.jpg",
       "itemUri": "https://www.merchant.website/product1.html"
} ]
}

If the special offer ID (or IDs) provided is valid then the relevant offer/s will be displayed at checkout for this basket. These will appear at the top of the available finance offers.

17081708

Signposting of Special Offers

As special offers are shown only at checkout following your request to verify-basket there will be no opportunity for Deko to provide customers with information about these offers prior to checkout or during our eligibility check process should you implement this.

To maximise performance, you are encouraged to display your own guidance explaining these promotional offers and the conditions in which they will be available at checkout.


Did this page help you?