For the complete documentation index, see llms.txt. This page is also available as Markdown.

Trade Details

This API allows merchants to manually fetch the exact callback / webhook payload for a specific instance. The response contains the current trade, transaction, account, user, and settlement-related details for the selected instance.

Endpoint

GEThttps://api.tylt.money/v2/prime-ntx/instance/{identifier}/trade-details

Parameter
Type
Required
Description

identifier

string / integer

Yes

The instance identifier. You may pass either the UUID instanceId or the numeric tradeId.

Example Request

GEThttps://api.tylt.money/v2/prime-ntx/instance/1563365/trade-details

GEThttps://api.tylt.money/v2/prime-ntx/instance/e12a29be-5725-41b5-9913-d783174f631b/trade-details

Request Parameters

Parameter
Type
Required
Description

date

string

Yes

Calendar date for which the report is required. Format: YYYY-MM-DD. The backend maps this date from 00:00:00Z to 23:59:59Z.

page

integer

No

Pagination page number. Defaults to 1.

limit

integer

No

Number of records to return per page. Defaults to 20. Maximum allowed value is 50.

Request Headers

Name
Type
Example
Description

X-TLP-APIKEY

string

93ee3c5e133697251b5362bcf9cc8532476785t8768075616f58d88

Your Tylt API Key, used to identify your account in API requests.

X-TLP-SIGNATURE

string

d0afef3853dfc8489c8b9affa5825171fdd7y7685675e4966a05f66ed2b3eaf9462b3c9c0

HMAC SHA-256 signature generated using the API Secret Key to secure the request.

When using the API, ensure to include your API Key and generate the signature for the request payload using your API Secret. The tables provided above contain example values for illustration purposes only. Please refer to the code snippets for detailed instructions on how to sign the request and generate the signature properly.

Code Snippet

const axios = require("axios");
const crypto = require("crypto");

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

const instanceId = "ccacfd2d-d277-4938-b0b3-07d04cb10dbb";

// Use this payload when using instanceId in the URL
const signingPayload = JSON.stringify({
  instanceId: String(instanceId),
});

const signature = crypto
  .createHmac("sha256", apiSecret)
  .update(signingPayload)
  .digest("hex");

axios
  .get(`https://api.tylt.money/v2/prime-ntx/instance/${instanceId}/trade-details`, {
    headers: {
      "X-TLP-APIKEY": apiKey,
      "X-TLP-SIGNATURE": signature,
    },
  })
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.error(error.response?.data || error.message);
  });

Response

Last updated