This endpoint allows you to retrieve the history of all Pay-In transactions associated with your merchant account. The results are paginated, allowing you to specify the number of rows and the page number.
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
constaxios=require('axios');constcrypto=require('crypto');// Replace with your API Key and SecretconstapiKey='your-api-key';constapiSecret='your-api-secret';// Create signature for the GET requestconstparams={rows:20,page:1};constqueryParams=newURLSearchParams(params).toString();constsignature=crypto.createHmac('sha256',apiSecret).update( JSON.stringify(params) ).digest('hex');constconfig={method:'get',url:`https://api.tylt.money/transactions/merchant/getPayoutTransactionHistory?${queryParams}`,headers:{"X-TLP-APIKEY":apiKey,"X-TLP-SIGNATURE":signature}};axios(config).then(response=>{console.log(response.data);}).catch(error=>{console.error(error);});
Response
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).