Order Analytics: PIX

This endpoint allows merchants to retrieve analytics for PIX Pay-In orders processed through Tylt. The response provides a summary of transaction activity, including order counts, completed orders, expired orders, pending orders, total PIX volume, settlement amount, fees, and day-wise transaction performance.

Endpoint

GEThttps://api.tylt.money/transactions/merchant/orderAnalyticsPix

Example Request

GEThttps://api.tylt.money/transactions/merchant/orderAnalyticsPix?mo th=2026-06

Request Parameters

The request requires the month parameter.

Name	Type	Example	Description
month	string	2026-06	The month for which PIX order analytics are to be retrieved. The required format is YYYY-MM.

Request Headers

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

Node JS

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

// Replace with your API Key and Secret
const apiKey = 'your-api-key';
const apiSecret = 'your-api-secret';

const params = {
  month: '2026-06'
};

// Create query string
const queryString = new URLSearchParams(params).toString();

// Create HMAC SHA-256 signature
const signaturePayload = JSON.stringify(params);

const signature = crypto
  .createHmac('sha256', apiSecret)
  .update(signaturePayload)
  .digest('hex');

// Define headers
const headers = {
  'X-TLP-APIKEY': apiKey,
  'X-TLP-SIGNATURE': signature
};

// Send the GET request
axios
  .get(`https://api.tylt.money/transactions/merchant/orderAnalyticsPix?${queryString}`, { headers })
  .then(response => console.log(response.data))
  .catch(error => console.error(error));

Response

Note: The first object in the rows array represents the monthly aggregate for the selected month and is marked as MONTH TOTAL. All subsequent objects represent date-wise analytics, returned in descending order based on the transaction date in UTC.

200

{
  "data": {
    "month": "2026-06",
    "rows": [
      {
        "date": "MONTH TOTAL",
        "totalOrdersPayIn": 144,
        "completedPayIn": 30,
        "conversionPctPayIn": 20.83,
        "brlPayIn": 484,
        "usdtPayIn": 92.88,
        "feesPayIn": 2.58,
        "totalOrdersPayOut": 54,
        "completedPayOut": 36,
        "conversionPctPayOut": 66.67,
        "brlPayOut": 441,
        "usdtPayOut": 85.72,
        "feesPayOut": 2.99
      },
      {
        "date": "2026-06-01",
        "totalOrdersPayIn": 6,
        "completedPayIn": 0,
        "conversionPctPayIn": 0,
        "brlPayIn": 0,
        "usdtPayIn": 0,
        "feesPayIn": 0,
        "totalOrdersPayOut": 0,
        "completedPayOut": 0,
        "conversionPctPayOut": 0,
        "brlPayOut": 0,
        "usdtPayOut": 0,
        "feesPayOut": 0
      },
      {
        "date": "2026-06-02",
        "totalOrdersPayIn": 1,
        "completedPayIn": 1,
        "conversionPctPayIn": 100,
        "brlPayIn": 1,
        "usdtPayIn": 0.2,
        "feesPayIn": 0.05,
        "totalOrdersPayOut": 2,
        "completedPayOut": 0,
        "conversionPctPayOut": 0,
        "brlPayOut": 0,
        "usdtPayOut": 0,
        "feesPayOut": 0
      }
    ]
  },
  "errorCode": 0,
  "msg": "Retrieved PIX order analytics for 2026-06"
}

Response Fields

Field Name	Type	Description
data	object	Contains the PIX order analytics data for the requested month.
month	string	The month for which the analytics are returned, in YYYY-MM format.
rows	array	List of analytics rows. The first row provides the monthly total, followed by date-wise analytics rows.
date	string	The date for the analytics row. MONTH TOTAL represents the aggregated monthly total. Date-wise rows are returned in YYYY-MM-DD format.
totalOrdersPayIn	number	Total number of PIX Pay-In orders created for the relevant row.
completedPayIn	number	Number of PIX Pay-In orders completed for the relevant row.
conversionPctPayIn	number	Percentage of PIX Pay-In orders that were completed.
brlPayIn	number	Total completed PIX Pay-In volume in BRL.
usdtPayIn	number	Total completed PIX Pay-In volume in USDT.
feesPayIn	number	Total fees charged on completed PIX Pay-In transactions.
totalOrdersPayOut	number	Total number of PIX Pay-Out orders created for the relevant row.
completedPayOut	number	Number of PIX Pay-Out orders completed for the relevant row.
conversionPctPayOut	number	Percentage of PIX Pay-Out orders that were completed.
brlPayOut	number	Total completed PIX Pay-Out volume in BRL.
usdtPayOut	number	Total completed PIX Pay-Out volume in USDT.
feesPayOut	number	Total fees charged on completed PIX Pay-Out transactions.
errorCode	number	Error code returned by the API. A value of 0 indicates a successful request.
msg	string	Message describing the result of the request.