Get Pay-Out Transaction Information

This endpoint allows you to retrieve detailed information about a specific Pay-Out transaction. The orderId is required, and it corresponds to the unique identifier generated by Tylt for the transaction.

Endpoint

GEThttps://api.tylt.money/transactions/merchant/getPayoutTransactionInformation?orderId={orderId}

Example Request

GEThttps://api.tylt.money/transactions/merchant/getPayoutTransactionInformation?orderId=a49579dd-7711-11ef-8277-02d8461243e9

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');

const params = {
  orderId: 'a49579dd-7711-11ef-8277-02d8461243e9'
};

const queryString = new URLSearchParams(params).toString();
const url = `https://api.tylt.money/transactions/merchant/getPayoutTransactionInformation?${queryString}`;

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

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

const config = {
  method: 'get',
  url: url,
  headers: {
    'X-TLP-APIKEY': apiKey,
    'X-TLP-SIGNATURE': signature
  }
};

axios.request(config)
  .then((response) => {
    console.log(JSON.stringify(response.data));
  })
  .catch((error) => {
    console.error(error);
  });

Python

import requests
import hashlib
import hmac

url = "https://api.tylt.money/transactions/merchant/getPayoutTransactionInformation"

params = {
    'orderId': 'a49579dd-7711-11ef-8277-02d8461243e9'
}

api_key = 'your-api-key'
secret_key = 'your-secret-key'

query_string = '&'.join([f"{key}={value}" for key, value in params.items()])
signature = hmac.new(secret_key.encode(), query_string.encode(), hashlib.sha256).hexdigest()

headers = {
    'X-TLP-APIKEY': api_key,
    'X-TLP-SIGNATURE': signature
}

response = requests.get(url, headers=headers, params=params)
print(response.text)

JavaScript

const crypto = require('crypto');

const params = {
  orderId: 'a49579dd-7711-11ef-8277-02d8461243e9'
};

const queryString = new URLSearchParams(params).toString();
const url = `https://api.tylt.money/transactions/merchant/getPayoutTransactionInformation?${queryString}`;

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

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

const requestOptions = {
  method: 'GET',
  headers: {
    'X-TLP-APIKEY': apiKey,
    'X-TLP-SIGNATURE': signature
  },
  redirect: 'follow'
};

fetch(url, requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.error('error', error));

Response

200

{
    "msg": "",
    "data": {
        "orderId": "85831093-7692-11ef-8277-02d8461243e9",
        "merchantOrderId": "85831093-7692-11ef-8277-02d8461243e9",
        "settledCurrency": "USDT",
        "settledAmountRequested": 2,
        "settledAmountDebited": 2,
        "settledAmountSent": 2,
        "commission": 0,
        "network": "BSC",
        "toAddress": "0xd2AF4B117EfE474B66Fc79E6A8E1938D41a60F4c",
        "status": "Completed",
        "insufficientBalance": 0,
        "paymentURL": "",
        "callBackURL": "",
        "transactions": [
            {
                "amount": 2,
                "createdAt": "2024-09-19 14:24:47.000000",
                "updatedAt": "2024-09-19 14:25:36.000000",
                "fromAddress": "0x1B3ec402Df254a66B97DE199541295AF2e0F5baA",
                "transactionHash": "0xb8a583a821234484a6811215d1ecc8b16e5bf35bc01699f8676d646db3b74a5b",
                "confirmationStatus": 1
            }
        ],
        "createdAt": "2024-09-19T14:21:54Z",
        "expiresAt": "2024-09-19T14:21:54Z",
        "updatedAt": "2024-09-19T14:25:36Z",
        "isFinal": 1,
        "isDebited": 1,
        "customerName": "",
        "comments": ""
    }
}

400

{
    "msg": "Not a payout order id",
    "data": {}
}

Response Fields

Field Name	Type	Description
orderId	String	The order ID generated by TL Pay, used as a global identifier.
merchantOrderId	String	The merchant's local order ID for reference (optional).
settledCurrency	String	The cryptocurrency or token used for payout.
settledAmountRequested	Number	The amount of cryptocurrency or token requested to be paid out.
settledAmountDebited	Number	The amount of cryptocurrency debited from your merchant balance.
settledAmountSent	Number	The total amount of cryptocurrency sent to the recipient.
commission	Number	The commission deducted from the payout transaction.
network	String	The blockchain network over which the payout is made (e.g., "BSC").
toAddress	String	The recipient's wallet address where the payout will be sent.
status	String	The status of the payout (e.g., "Pending", "Completed", "Failed").
insufficientBalance	Number	Indicates if there is insufficient balance for the transaction (1 = Yes, 0 = No).
paymentURL	String	The URL where the customer can make the payment (if applicable).
callBackURL	String	The callback URL specified by the merchant (optional).
transactions	Array	Details of any individual transactions linked to this payout (if applicable).
createdAt	String	The timestamp when the payout request was created.
expiresAt	String	The timestamp when the payout request will expire.
updatedAt	String	The timestamp when the payout request was last updated.
isFinal	Number	Indicates if the transaction is final (1 for completed, 0 for pending).
isDebited	Number	Indicates if the payout amount has been debited from your merchant account.
customerName	String	The name of the customer associated with the transaction (optional).
comments	String	Any comments or notes provided by the merchant (optional).