Get Balance

Retrieves the end user’s fiat/crypto balance summary.

Endpoint

GET /whitelabel/wallet/getBalance

Request Headers

x-tlp-apikey: <api-key>
x-tlp-signature: <hmac-signature>

Query Parameters

Provide at least one of the following user identifiers: endUserEmail, endUserId, or externalUserId.

Field	Type	Required	Description
endUserEmail	String	Conditional	End user’s registered email address
endUserId	Number	Conditional	Tylt end-user ID
externalUserId	String	Conditional	Merchant’s own user identifier

At least one identifier is required.

Example Request

GET /whitelabel/wallet/getBalance?externalUserId=user-10021

Signed query object:

{
  "endUserId": 20001, // Optional: Provide one user identifier only
  "endUserEmail": "[e-mail]", // Optional: Alternative to endUserId and externalUserId
  "externalUserId": "user-10021", // Optional: Alternative to endUserId and endUserEmail
}

The exact asset parameter name must be confirmed against the deployed balance API schema.

Code Snippet

JavaScript (Axios)

import crypto from 'crypto';
import axios from 'axios';

const apiKey = 'your-api-key';
const apiSecret = 'your-api-secret';

const queryParams = {
  endUserId: 20001, // Optional: Provide one user identifier only
  endUserEmail: "[e-mail]", // Optional: Alternative to endUserId and externalUserId
  externalUserId: "user-10021", // Optional: Alternative to endUserId and endUserEmail
};

const rawPayload = JSON.stringify(queryParams);
const signature = crypto.createHmac('sha256', apiSecret).update(rawPayload).digest('hex');

const headers = {
    'x-tlp-apikey': apiKey,
    'x-tlp-signature': signature
};

const queryString = new URLSearchParams(queryParams).toString();
axios.get(`https://api.tylt.money/whitelabel/wallet/getBalance?${queryString}`, { headers })

Example Response

{
  "msg": "",
    "data": {
      "personalBalance": 5.50165
    },
    "msg": ""
}

Use Cases

Use this endpoint before:

• Creating an on-chain payout

• Creating an internal transfer

• Displaying an asset-specific wallet screen

• Verifying whether sufficient funds are available

---