DeshConnect Developer Arena

Introduction

Welcome to the DeshConnect Partnership Connect API v1. Our RESTful API enables partner platforms (resellers, rewards systems, remittance services) to query active merchant gift voucher products and place instant voucher orders.

The Merchants API and Orders API are currently live and available for production integrations over HTTPS sending and receiving JSON payloads.

API Base URL

Endpoint Base URL

https://deshconnect.com/api/v1

Authentication

The DeshConnect Partner API uses a secure two-header authentication scheme:

X-Partner-Token: Your Partner API Token
X-Partner-Secret: Your Partner API Secret Key

You can generate and manage your API credentials directly in your Partner Portal under API Credentials.

Keep your API Secret confidential. Never expose secret keys in client-side code or public repositories.

AUTHENTICATION HEADERS

X-Partner-Token: your_api_access_token
X-Partner-Secret: your_api_secret_key
Accept: application/json

Merchants API

Available

GET /merchants

Retrieves the list of active merchant brands available in the DeshConnect network along with their active catalogue products (denominations) that currently have in-stock available vouchers.

Query Parameters

Parameter	Type	Description
search	string	Filter merchants by name (e.g. `Aarong`).
category	string	Filter merchants by category (e.g. `Fashion`).

curl -X GET "https://deshconnect.com/api/v1/merchants" \
  -H "X-Partner-Token: your_api_access_token" \
  -H "X-Partner-Secret: your_api_secret_key" \
  -H "Accept: application/json"

fetch("https://deshconnect.com/api/v1/merchants", {
  method: "GET",
  headers: {
    "X-Partner-Token": "your_api_access_token",
    "X-Partner-Secret": "your_api_secret_key",
    "Accept": "application/json"
  }
})
.then(response => response.json())
.then(data => console.log(data));

import requests

url = "https://deshconnect.com/api/v1/merchants"
headers = {
    "X-Partner-Token": "your_api_access_token",
    "X-Partner-Secret": "your_api_secret_key",
    "Accept": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())

Orders API

Available

The Orders API allows partner applications to place voucher orders and query order status. Orders deduct the order value from the partner's wallet balance and assign an in-stock digital voucher instantly.

1. Place Order

POST /orders

Places a single voucher order for a specified catalogue SKU. Currently allows 1 order per request.

Request Body Fields

Field	Type	Description
sku Required	string	Catalogue SKU (e.g. `AARONG-1000`).
recipient_name Required	string	Recipient's full name.
recipient_phone Required	string	Recipient's mobile number.
recipient_email	string	Optional recipient email address.
personal_message	string	Optional custom message for recipient.
external_reference	string	Optional partner transaction / order ID.

curl -X POST "https://deshconnect.com/api/v1/orders" \
  -H "X-Partner-Token: your_api_access_token" \
  -H "X-Partner-Secret: your_api_secret_key" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "sku": "AARONG-1000",
    "recipient_name": "Rahim Ahmed",
    "recipient_phone": "01711223344",
    "recipient_email": "rahim@example.com",
    "personal_message": "Happy Anniversary!",
    "external_reference": "EXT-ORD-9001"
  }'

fetch("https://deshconnect.com/api/v1/orders", {
  method: "POST",
  headers: {
    "X-Partner-Token": "your_api_access_token",
    "X-Partner-Secret": "your_api_secret_key",
    "Content-Type": "application/json",
    "Accept": "application/json"
  },
  body: JSON.stringify({
    sku: "AARONG-1000",
    recipient_name: "Rahim Ahmed",
    recipient_phone: "01711223344",
    recipient_email: "rahim@example.com",
    external_reference: "EXT-ORD-9001"
  })
})
.then(response => response.json())
.then(data => console.log(data));

import requests

url = "https://deshconnect.com/api/v1/orders"
headers = {
    "X-Partner-Token": "your_api_access_token",
    "X-Partner-Secret": "your_api_secret_key",
    "Content-Type": "application/json",
    "Accept": "application/json"
}
payload = {
    "sku": "AARONG-1000",
    "recipient_name": "Rahim Ahmed",
    "recipient_phone": "01711223344",
    "external_reference": "EXT-ORD-9001"
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())

2. List Partner Orders

GET /orders

Fetches a paginated list of all voucher orders placed by your partner account.

Query Parameters

Parameter	Type	Description
page	integer	Page number (default: 1).
per_page	integer	Items per page (default: 15).

cURL EXAMPLE

curl -X GET "https://deshconnect.com/api/v1/orders?page=1" \
  -H "X-Partner-Token: your_api_access_token" \
  -H "X-Partner-Secret: your_api_secret_key"

3. Get Order Details

GET /orders/{order_reference}

Retrieves full details of a specific order by reference or ID.

Path Parameters

Parameter	Type	Description
order_reference Required	string	Order reference (e.g. `GB-20260819-ABC123`).

cURL EXAMPLE

curl -X GET "https://deshconnect.com/api/v1/orders/GB-20260819-ABC123" \
  -H "X-Partner-Token: your_api_access_token" \
  -H "X-Partner-Secret: your_api_secret_key"

API Sandbox Console

Interact directly with the DeshConnect API. Input your API credentials (`X-Partner-Token` & `X-Partner-Secret`), select an API endpoint, test request parameters, and inspect live response outputs.

API Request Builder

Live API Console

API Access Token Header (X-Partner-Token)

API Secret Key Header (X-Partner-Secret)

API Endpoint Target

GET /merchants

API Response Output

Status: --- Time: 0ms

Click "Run Request" to send a sandbox request.