Tylt: API Documentation
  • Introduction
    • Introduction
    • Getting Started
    • Generating API Keys
    • Signing API Payloads
    • Important Concepts
    • Merchant Verification
    • Tylt Prime (UPI to Crypto Solution)
      • API Reference
        • Create a Pay-in Instance
        • Create a Pay-out Instance
        • Webhook for Tylt Prime
        • Get Instance Information
        • Get Pay-In Transaction Information
        • Get Pay-Out Transaction Information
    • Tylt Prime (UPI to Crypto Solution - H2H)
      • API Reference ( Pay-In)
        • Create a Pay-in Instance
        • Buyer Confirms Payment
        • Webhook for Tylt Prime
        • Get Instance Details
        • Get Pay-In Transaction Information
        • Get List of Fiat Currency and Supported Payment Methods
        • Get List of Supported Crypto Currency for Settlement
        • Get Conversion Rates
  • Tylt CPG (Crypto Payment Gateway)
    • API Reference
      • Accept Crypto Payments
        • Creating a Pay-in Request
        • Get Pay-In Transaction History
        • Get Pay-In Transaction Information
      • Make Crypto Payouts
        • Creating a Payout Request
        • Get Pay-Out Transaction History
        • Get Pay-Out Transaction Information
      • Supporting API's
        • Get Supported Crypto Currencies List
        • Get Supported Fiat Currencies
        • Get Account Balance / Holdings
        • Get Supported Crypto Networks
        • Supported Base Currency List
      • Webhook
    • Use Cases
      • E-commerce Flow
      • Withdrawal Flow
Powered by GitBook
On this page
  1. Introduction
  2. Tylt Prime (UPI to Crypto Solution - H2H)
  3. API Reference ( Pay-In)

Get Pay-In Transaction Information

This endpoint allows you to retrieve detailed information about a specific Pay-In transaction. The orderId passed as params in the request can be either:

  1. The orderId generated and returned by the getInstanceDetails API.

  2. The merchantOrderId provided by the merchant when calling the createPayinInstance API.

For Pay-In transactions, this endpoint should only be called after the transaction has been completed.

Endpoint

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

Example Request

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

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 params = {
  orderId: 'a49579dd-7711-11ef-8277-02d8461243e9'
};

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

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

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

const config = {
  method: 'get',
  url: url,
  headers: {
    'Content-Type': "application/json",
    'X-TLP-APIKEY': apiKey,
    'X-TLP-SIGNATURE': signature
  }
};

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

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

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()])
body_string = json.dumps(params, separators=(',', ':'), ensure_ascii=False)

signature = hmac.new(secret_key.encode(), body_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)

Response

{
    "msg": "",
    "data": {
        "orderId": "538ffd9a-fe4e-11ef-bcfd-42010a280107",
        "merchantOrderId": "merchant-test-111",
        "baseAmount": 2.208,
        "baseCurrency": "USDT",
        "settledCurrency": "USDT",
        "settledAmountRequested": 2.208,
        "settledAmountReceived": 2.208,
        "settledAmountCredited": 2.208,
        "commission": 0,
        "network": "TPNK",
        "depositAddress": "",
        "status": "Completed",
        "paymentURL": "",
        "redirectURL": "",
        "callBackURL": "",
        "transactions": [],
        "createdAt": "2025-03-11T07:57:20Z",
        "expiresAt": "2025-03-11T07:57:20Z",
        "updatedAt": "2025-03-11T07:57:22Z",
        "isFinal": 1,
        "isCredited": 1,
        "customerName": "",
        "comments": "",
        "accounts": {
            "MDR_Rate": 4,
            "localCurrency": "INR",
            "transactionType": "pay-in",
            "merchantAccountDebited": null,
            "merchantAccountCredited": 2.2079999999999997,
            "amountPaidInLocalCurrency": 215.04999999999998,
            "cryptoCurrencySymbol": "USDT",
            "amountPaidInCryptoCurrency": 2.3,
            "conversionRate": 93.5
        }
    }
}

Field Name

Type

Description

orderId

string

The order ID generated by TL Pay, used as a global identifier for the transaction.

merchantOrderId

string

The order ID provided by the Merchant, used for local reference (optional).

baseAmount

number

The base value of the good/service being supplied.

baseCurrency

string

The base currency of the good/service being supplied.

settledCurrency

string

The cryptocurrency/token in which the payment is to be made by the customer.

settledAmountRequested

number

The amount of cryptocurrency/token requested from the customer.

settledAmountReceived

number

The amount of cryptocurrency/token received from the customer.

settledAmountCredited

number

The amount of cryptocurrency/token credited to the merchant's balance (net).

commission

number

The commission deducted for the transaction.

network

string

The cryptocurrency network over which the payment is made.

depositAddress

string

The address for receiving the payment.

status

string

The status of the transaction (e.g., Expired, Pending, Completed).

paymentURL

string

The payment link that needs to be used by the customer to make the payment.

callBackURL

string

The callback URL for post-payment notifications (if applicable).

transactions

array

Details of the transactions resulting in the payment (if any).

createdAt

string

The timestamp when the transaction was created.

expiresAt

string

The timestamp when the transaction expires.

updatedAt

string

The timestamp when the transaction was last updated.

isFinal

number

Indicates if the transaction is complete (1) or still processing (0).

isCredited

number

Indicates if the payment has been credited to the merchant account (1: Yes, 0: No).

customerName

string

The name of the customer provided by the merchant (optional).

comments

string

Comments provided by the merchant about the transaction (optional).

PreviousGet Instance DetailsNextGet List of Fiat Currency and Supported Payment Methods

Last updated 2 months ago