Create a Deep Link

This API lets partners create a Deep Link that opens the banking app on a mobile device directly with the transaction details prefilled, shortening the user's steps and increasing the conversion rate.

POST

URLhttps://open-api.tingee.vn/v1/deep-link/generate

Create a Deep Link for opening a payment app, making a transfer or paying a bill.

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).
`type`	string	✓	Deep Link type (`qr-code`, `payment-with-bank-account`, `bill-payment`). Currently the system only processes `qr-code` and `payment-with-bank-account`; `bill-payment` is not supported yet.
`qrCode`	string	~	VietQR (EMVCo) data string to pay (Required if type is `qr-code`).
`redirectUrl`	string	~	URL to redirect to after the user finishes in the app. Required for all banks except MB Bank (`970422`).
`bankBin`	string	✓	BIN of the bank (app) used to pay. Supported banks: ACB (`970416`), Sacombank (`970403`), BIDV (`970418`), OCB (`970448`), MB Bank (`970422`), VPBank (`970432`).
`destinationBankBin`	string	~	Beneficiary bank BIN. See Supported banks. (Required if type is `payment-with-bank-account`).
`accountNumber`	string	~	Beneficiary account number. (Required if type is `payment-with-bank-account` or `bill-payment`).
`accountName`	string	~	Beneficiary account holder name. (Required if type is `bill-payment`).
`billNumber`	string	~	Bill number (Required if type is `bill-payment`).
`amount`	number	✕	Transaction amount (used when type is `payment-with-bank-account`).
`content`	string	✕	Transfer description (used when type is `payment-with-bank-account`).

Code samples

cURL
NestJS
C#
Java
PHP

curl --location --request POST 'https://open-api.tingee.vn/v1/deep-link/generate' \
--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 '{
  "type": "qr-code",
  "qrCode": "base64_data",
  "redirectUrl": "https://your-app.com/callback",
  "bankBin": "970422",
  "accountNumber": "0123456789",
  "amount": 50000,
  "content": "Thanh toan don hang"
}'

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 deepLinkGenerate() {
    const body = {
        type: "qr-code",
        qrCode: "base64_data",
        redirectUrl: "https://your-app.com/callback",
        bankBin: "970422",
        accountNumber: "0123456789",
        amount: 50000,
        content: "Thanh toan don hang",
    };

    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/deep-link/generate",
        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);
}

deepLinkGenerate();

using System;
using System.Collections.Generic;
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 Dictionary<string, object>
        {
            ["type"] = "qr-code",
            ["qrCode"] = "base64_data",
            ["redirectUrl"] = "https://your-app.com/callback",
            ["bankBin"] = "970422",
            ["accountNumber"] = "0123456789",
            ["amount"] = 50000,
            ["content"] = "Thanh toan don hang"
        };

        // 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/deep-link/generate");
        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 = "{\"type\":\"qr-code\",\"qrCode\":\"base64_data\",\"redirectUrl\":\"https://your-app.com/callback\",\"bankBin\":\"970422\",\"accountNumber\":\"0123456789\",\"amount\":50000,\"content\":\"Thanh toan don hang\"}";

        // 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/deep-link/generate"))
                .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 = [
    "type" => "qr-code",
    "qrCode" => "base64_data",
    "redirectUrl" => "https://your-app.com/callback",
    "bankBin" => "970422",
    "accountNumber" => "0123456789",
    "amount" => 50000,
    "content" => "Thanh toan don hang",
];

// 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/deep-link/generate",
    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": "mbbank://applink?targetPage=QRPay&source=HENO&qrContent=00020101021238..."
}

Field	Type	Description
`code`	string	Result code (`00` = success).
`message`	string	Response message.
`data`	string	Deep Link that opens the banking app matching `bankBin` (in each bank's own URL scheme format).

Common error codes

Code	Description	How to handle
`1063`	Bank does not support Deep Link yet	Use the `bankBin` of a supported bank: ACB, Sacombank, BIDV, OCB, MB, VPBank.
`1064`	Deep Link type is not supported yet	Set `type` to `qr-code` or `payment-with-bank-account`.
`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