Create / update a bank configuration

Use this API to create or update the bank connection configuration for a Merchant account. When you send the same bankBin, the system automatically creates a new configuration or overwrites the current one.

POST

URLhttps://open-api.tingee.vn/v1/merchant/create-or-update-config

Create or update the bank integration configuration for a Merchant.

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).
`bankBin`	string	✕	Bank BIN. Takes precedence over `bankName` if you pass both.
`bankName`	string	✕	Bank name (e.g. `ACB`, `BIDV`, `CTG`). Required if you do not pass `bankBin`.
`accountType`	string	✓	Account type: `business-account` (business) or `business-household-account` (household business).
`id`	number	✕	ID of the existing configuration (pass it to update, leave it empty to create).
`otpNumber`	string	✕	Confirmation OTP (required by some banks).
`confirmId`	string	✕	Confirmation code received after the ACB configuration registration step.
`bidvConfigDto`	object	~	Configuration for BIDV. Pass it when `bankBin` is BIDV.
`bidvConfigDto.accountNumber`	string	✓	BIDV bank account number.
`bidvConfigDto.accountName`	string	✓	BIDV account holder name.
`bidvConfigDto.vaPrefix`	string	✓	BIDV Virtual Account prefix.
`bidvConfigDto.bankPartnerId`	string	✓	Partner code issued by BIDV.
`ctgConfigDto`	object	~	Configuration for VietinBank (CTG). Pass it when `bankBin` is VietinBank.
`ctgConfigDto.accountNumber`	string	✓	VietinBank bank account number.
`ctgConfigDto.accountName`	string	✓	VietinBank account holder name.
`ctgConfigDto.vaPrefix`	string	✓	VietinBank Virtual Account prefix.
`acbConfigDto`	object	~	Configuration for ACB. Pass it when `bankBin` is ACB.
`acbConfigDto.accountNumber`	string	✓	ACB bank account number.
`acbConfigDto.accountName`	string	✓	ACB account holder name.
`acbConfigDto.vaPrefix`	string	✓	Virtual Account prefix.
`acbConfigDto.mobile`	string	✓	Phone number registered to receive OTPs.
`acbConfigDto.acbUserId`	string	✓	ACB Online / Biz login user ID.
`msbConfigDto`	object	~	Configuration for MSB. Pass it when `bankBin` is MSB.
`msbConfigDto.accountNumber`	string	✓	MSB bank account number.
`msbConfigDto.vaPrefix`	string	✓	Virtual Account prefix.
`msbConfigDto.mobile`	string	✓	Registered phone number.
`msbConfigDto.merchantId`	string	✓	Merchant code issued by MSB.
`msbConfigDto.terminalId`	string	✓	Terminal code issued by MSB.
`msbConfigDto.accessCode`	string	✓	Access code issued by MSB.
`msbConfigDto.referralCode`	string	✓	Referral code issued by MSB.
`baokimConfigDto`	object	~	Configuration for the BaoKim e-wallet. Pass it when `bankBin` is `BAOKIM`.
`baokimConfigDto.walletId`	string	✕	BaoKim wallet ID.
`baokimConfigDto.accountName`	string	✕	BaoKim wallet holder name.
`baokimConfigDto.mid`	string	✕	Merchant ID (MID) issued by BaoKim.
`baokimConfigDto.privateKey`	string	✕	Private key issued by BaoKim.

Code samples

cURL
NestJS
C#
Java
PHP

curl --location --request POST 'https://open-api.tingee.vn/v1/merchant/create-or-update-config' \
--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 '{
  "bankBin": "970418",
  "accountType": "business-account",
  "bidvConfigDto": {
    "accountNumber": "1234567890",
    "accountName": "CONG TY TNHH ABC",
    "vaPrefix": "TINGEE",
    "bankPartnerId": "PARTNER_001"
  }
}'

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 merchantCreateOrUpdateConfig() {
    const body = {
        bankBin: "970418",
        accountType: "business-account",
        bidvConfigDto: {
            accountNumber: "1234567890",
            accountName: "CONG TY TNHH ABC",
            vaPrefix: "TINGEE",
            bankPartnerId: "PARTNER_001",
        },
    };

    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/merchant/create-or-update-config",
        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);
}

merchantCreateOrUpdateConfig();

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
        {
            bankBin = "970418",
            accountType = "business-account",
            bidvConfigDto = new
            {
                accountNumber = "1234567890",
                accountName = "CONG TY TNHH ABC",
                vaPrefix = "TINGEE",
                bankPartnerId = "PARTNER_001"
            }
        };

        // 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/merchant/create-or-update-config");
        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 = "{\"bankBin\":\"970418\",\"accountType\":\"business-account\",\"bidvConfigDto\":{\"accountNumber\":\"1234567890\",\"accountName\":\"CONG TY TNHH ABC\",\"vaPrefix\":\"TINGEE\",\"bankPartnerId\":\"PARTNER_001\"}}";

        // 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/merchant/create-or-update-config"))
                .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 = [
    "bankBin" => "970418",
    "accountType" => "business-account",
    "bidvConfigDto" => [
        "accountNumber" => "1234567890",
        "accountName" => "CONG TY TNHH ABC",
        "vaPrefix" => "TINGEE",
        "bankPartnerId" => "PARTNER_001",
    ],
];

// 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/merchant/create-or-update-config",
    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": 125
}

Field	Type	Description
`code`	string	Result code (`00` = Success).
`message`	string	Response message.
`data`	number	ID of the configuration that was created or updated.

Common error codes

Code	Description	How to handle
`1065`	OTP has expired	A `confirmId` is only valid for about 4 minutes; call Register business account configuration again to get a new `confirmId` and confirm immediately.
`1080`	Incorrect ConfirmId	Use the exact `confirmId` returned for the same Merchant.
`1013`	Configuration does not exist	When updating, check the configuration `id` (from Configuration list); omit `id` to create a new one.
`1095`, `1096`	Master Merchant `merchantId` error	Pass the `merchantId` of a sub-Merchant that belongs to the Master Merchant calling the API.
`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