Add a device to a shop (Add Device To Shop)

This API links a TINGEEBOX device to a shop or a virtual account (VA). Once registered, the device can perform tasks such as showing QR codes, reading amounts aloud, or announcing transaction notifications.

POST

URLhttps://open-api.tingee.vn/v1/device/add-device-to-shop

Link a new TINGEEBOX device to the Merchant's management system.

Header Request

Header	Required	Description
`Content-Type`	✓	`application/json`
`x-client-id`	✓	Partner identifier issued by TINGEE.
`x-signature`	✓	HMAC SHA512 authentication signature. See How to generate the signature.
`x-request-timestamp`	✓	Time the request is sent (format: `yyyyMMddHHmmssSSS`, UTC+7)

Body Parameter

Field	Type	Required	Description
`merchantId`	number	~	Merchant ID (Required if you connect with a Master Merchant account).
`uuid`	string	✓	Unique device identifier (max 50 characters).
`securityCode`	string	✓	Device security code (max 100 characters). Call Read out security code so the device reads the code aloud, then pass the code the user heard.
`vaAccountNumbers`	string[]	~	List of VA account numbers; the device is linked to the shops that contain these accounts. Required if `shopIds` is not passed; ignored when `shopIds` is passed.
`shopIds`	number[]	~	List of shop IDs to link (Required if `vaAccountNumbers` is not passed).
`appType`	string	✓	Integration platform (per `AppTypeEnum`): `baas`, `ocb-web`, `ocb-app`, `bidv-web`, `bidv-app`, `stb-web`, `stb-app`, `vcb-web`, `vcb-app`, `tingee-web`, `tingee-app`, `tingee-merchant-app`, `TingeeMerchant`, `loa-hub`, `mini-app-mbb`, `mini-app-zalo`. The device type must be allowed on this platform in TINGEE's configuration. Open API partners usually pass `baas` (or the value TINGEE provides when issuing the account).

Code samples

cURL
NestJS
C#
Java
PHP

curl --location --request POST 'https://open-api.tingee.vn/v1/device/add-device-to-shop' \
--header 'accept: application/json' \
--header 'x-client-id: YOUR_CLIENT_ID' \
--header 'x-request-timestamp: 20240509154004003' \
--header 'x-signature: YOUR_SIGNATURE' \
--header 'Content-Type: application/json' \
--data '{
  "uuid": "DEVICE-001",
  "securityCode": "ABC123XYZ",
  "shopIds": [
    12
  ],
  "appType": "ocb-web",
  "vaAccountNumbers": [
    "123456789"
  ]
}'

import axios from "axios";
import { createHmac } from "crypto";

const CLIENT_ID = "YOUR_CLIENT_ID";
const SECRET_KEY = "YOUR_SECRET_KEY";

// Timestamp in UTC+7, format yyyyMMddHHmmssSSS
function getTimestamp() {
    return new Date(Date.now() + 7 * 60 * 60 * 1000)
        .toISOString()
        .replace(/[-:TZ.]/g, "")
        .slice(0, 17);
}

async function deviceAddDeviceToShop() {
    const body = {
        uuid: "DEVICE-001",
        securityCode: "ABC123XYZ",
        shopIds: [
            12,
        ],
        appType: "ocb-web",
        vaAccountNumbers: [
            "123456789",
        ],
    };

    const bodyJson = JSON.stringify(body);
    const timestamp = getTimestamp();
    const signature = createHmac("sha512", SECRET_KEY)
        .update(`${timestamp}:${bodyJson}`)
        .digest("hex");

    const res = await axios.request({
        method: "POST",
        url: "https://open-api.tingee.vn/v1/device/add-device-to-shop",
        data: bodyJson,
        headers: {
            accept: "application/json",
            "Content-Type": "application/json",
            "x-client-id": CLIENT_ID,
            "x-request-timestamp": timestamp,
            "x-signature": signature,
        },
    });

    console.log(res.data);
}

deviceAddDeviceToShop();

using System;
using System.Net.Http;
using System.Security.Cryptography;
using System.Text;
using System.Text.Encodings.Web;
using System.Text.Json;
using System.Threading.Tasks;

public class Program
{
    private const string ClientId = "YOUR_CLIENT_ID";
    private const string SecretKey = "YOUR_SECRET_KEY";
    private static readonly HttpClient Client = new HttpClient();

    public static async Task Main()
    {
        var body = new
        {
            uuid = "DEVICE-001",
            securityCode = "ABC123XYZ",
            shopIds = new object[]
            {
                12
            },
            appType = "ocb-web",
            vaAccountNumbers = new object[]
            {
                "123456789"
            }
        };

        // Do not escape non-ASCII / special characters so the JSON matches TINGEE's JSON.stringify
        var jsonOptions = new JsonSerializerOptions { Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping };
        var bodyJson = JsonSerializer.Serialize(body, jsonOptions);

        // Timestamp in UTC+7, format yyyyMMddHHmmssSSS
        var timestamp = DateTime.UtcNow.AddHours(7).ToString("yyyyMMddHHmmssfff");
        var signature = HmacSha512(SecretKey, $"{timestamp}:{bodyJson}");

        var request = new HttpRequestMessage(HttpMethod.Post, "https://open-api.tingee.vn/v1/device/add-device-to-shop");
        request.Headers.Add("accept", "application/json");
        request.Headers.Add("x-client-id", ClientId);
        request.Headers.Add("x-request-timestamp", timestamp);
        request.Headers.Add("x-signature", signature);
        request.Content = new StringContent(bodyJson, Encoding.UTF8, "application/json");

        var response = await Client.SendAsync(request);
        Console.WriteLine(await response.Content.ReadAsStringAsync());
    }

    private static string HmacSha512(string key, string message)
    {
        using var hmac = new HMACSHA512(Encoding.UTF8.GetBytes(key));
        var hash = hmac.ComputeHash(Encoding.UTF8.GetBytes(message));
        return Convert.ToHexString(hash).ToLower();
    }
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;
import java.time.ZoneId;
import java.time.ZonedDateTime;
import java.time.format.DateTimeFormatter;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;

public class Main {
    private static final String CLIENT_ID = "YOUR_CLIENT_ID";
    private static final String SECRET_KEY = "YOUR_SECRET_KEY";

    public static void main(String[] args) throws Exception {
        // Minified JSON, same as JSON.stringify()
        String bodyJson = "{\"uuid\":\"DEVICE-001\",\"securityCode\":\"ABC123XYZ\",\"shopIds\":[12],\"appType\":\"ocb-web\",\"vaAccountNumbers\":[\"123456789\"]}";

        // Timestamp in UTC+7, format yyyyMMddHHmmssSSS
        String timestamp = ZonedDateTime.now(ZoneId.of("Asia/Ho_Chi_Minh"))
                .format(DateTimeFormatter.ofPattern("yyyyMMddHHmmssSSS"));
        String signature = hmacSha512(SECRET_KEY, timestamp + ":" + bodyJson);

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://open-api.tingee.vn/v1/device/add-device-to-shop"))
                .header("accept", "application/json")
                .header("Content-Type", "application/json")
                .header("x-client-id", CLIENT_ID)
                .header("x-request-timestamp", timestamp)
                .header("x-signature", signature)
                .method("POST", HttpRequest.BodyPublishers.ofString(bodyJson, StandardCharsets.UTF_8))
                .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
                .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }

    private static String hmacSha512(String key, String data) throws Exception {
        Mac mac = Mac.getInstance("HmacSHA512");
        mac.init(new SecretKeySpec(key.getBytes(StandardCharsets.UTF_8), "HmacSHA512"));
        byte[] hash = mac.doFinal(data.getBytes(StandardCharsets.UTF_8));
        StringBuilder hex = new StringBuilder();
        for (byte b : hash) hex.append(String.format("%02x", b));
        return hex.toString();
    }
}

<?php
$clientId = "YOUR_CLIENT_ID";
$secretKey = "YOUR_SECRET_KEY";

$body = [
    "uuid" => "DEVICE-001",
    "securityCode" => "ABC123XYZ",
    "shopIds" => [
        12,
    ],
    "appType" => "ocb-web",
    "vaAccountNumbers" => [
        "123456789",
    ],
];

// Do not escape "/" or non-ASCII characters so the JSON matches TINGEE's JSON.stringify
$bodyJson = json_encode($body, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);

// Timestamp in UTC+7, format yyyyMMddHHmmssSSS
$now = new DateTime("now", new DateTimeZone("Asia/Ho_Chi_Minh"));
$timestamp = $now->format("YmdHisv");
$signature = hash_hmac("sha512", $timestamp . ":" . $bodyJson, $secretKey);

$ch = curl_init();
curl_setopt_array($ch, [
    CURLOPT_URL => "https://open-api.tingee.vn/v1/device/add-device-to-shop",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_POSTFIELDS => $bodyJson,
    CURLOPT_HTTPHEADER => [
        "Accept: application/json",
        "Content-Type: application/json",
        "x-client-id: " . $clientId,
        "x-request-timestamp: " . $timestamp,
        "x-signature: " . $signature,
    ],
]);

$response = curl_exec($ch);
if ($response === false) {
    echo "cURL Error: " . curl_error($ch);
} else {
    echo $response;
}
curl_close($ch);

Sample Response

{
  "code": "00",
  "message": "Success",
  "data": [
    {
      "type": "tingee-box-3ls",
      "uuid": "DEVICE-001"
    }
  ]
}

Field	Type	Description
`code`	string	Result code (`00` = success).
`message`	string	Response message.
`data`	array	TingeeBox devices currently linked to the shop (the last shop processed in the list), including the newly added device.
`data[].type`	string	Device type (e.g. `tingee-box-3ls`).
`data[].uuid`	string	Device UUID.

Common error codes

Code	Description	How to handle
`1078`	Incorrect device security code	Call Read out security code so the device reads a new code, then resend immediately; the code changes automatically after about 30 seconds.
`1055`	Device is already linked to another business/household business	Check `uuid`; ask the previous owner to unlink it or contact TINGEE to reset the device.
`1028`	Device not found	Check the device `uuid`.
`1047`	Virtual account number not found	Check that `vaAccountNumbers` belong to the calling Merchant.
`1070`	Shop does not exist or has been deleted	Check that `shopIds` belong to the Merchant and have not been deleted.
`1037`, `1038`	Device is locked to a different bank than the shop's existing devices/accounts	Only link devices locked to the same bank as the shop, or choose another shop.
`1095`, `1096`	Master Merchant `merchantId` error	Pass the `merchantId` of a sub-Merchant that belongs to the calling Master Merchant.
`90`, `91`, `92`, `97`	Request authentication error (timestamp, client-id, signature)	See System error codes.
`Others`	Other errors	See Error codes.

Header Request​

Body Parameter​

Code samples​

Sample Response​

Common error codes​

Header Request

Body Parameter

Code samples

Sample Response

Common error codes