Bank Link SDK

The Tingee Bank Link SDK lets partners easily embed Tingee's bank account linking screen directly into their website or mobile app.

Before you start

• Base URL: https://uat-open-api.tingee.vn (UAT) · https://open-api.tingee.vn (PROD)
• Authentication: Every request must include the x-client-id, x-request-timestamp headers and the x-signature signature (HMAC SHA512). See Get your API key & generate the signature.
• Result: The API always returns HTTP 200; check the code field (00 = success). See Error codes.

Once the customer successfully links a bank account through the SDK, that linked account is automatically linked to the Merchant's shop and supports later payment and reconciliation flows.

---

Integration Flow

1. Create a session: The partner's server (backend) calls the OpenAPI Create a link session to receive an SDK URL (containing a token and a secure signature s).
2. Embed and open the SDK: The partner embeds the tingee-bank-link.js library and calls the function that opens the SDK as a popup (modal) or inline container.
3. Link the account: The customer chooses a bank and completes the secure linking steps on Tingee's interface.
4. Receive the result:
   • Callback: The SDK passes the bank linking result (success, failure, cancellation) directly back to your client app via callbacks.
   • Redirect: If the session has a redirectUrl, the customer is redirected back to the partner's URL with the result in query parameters.
   • Webhook: At the same time, Tingee sends a Bank link webhook to your server so you can sync the linked account status in real time.

Bank linking flow via the SDK

← Swipe to see more →

---

Integration options

• Web (Frontend): Integrate as a popup (modal) or inline via the Web UI SDK.

---

Security & process rules

• Do not call the API from the frontend: Creating a bank link session (POST /v1/create-bank-link-session) must be done on the backend so that the secretToken (the secret used to sign requests) is never exposed.
• Do not build the SDK URL yourself: The frontend must never concatenate the token or signature s to build the SDK URL; use the data value from the successful OpenAPI response as is.
• API permissions: The API credential (clientId) used to create bank link sessions must have the Bank permission scope.
• Internal flow: Tingee handles the actual bank linking flow and the transactions with the bank gateway internally; partners do not need to call gateway APIs directly.

---

API catalog

Function	Method	Endpoint
Create a link session	POST	/v1/create-bank-link-session