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 Instance Details

This endpoint allows you to retrieve detailed information about a specific Pay-In transaction instance. The merchantOrderId is required, and it corresponds to the unique identifier generated by merchant at the time of creating a payment instance.

Endpoint

GEThttps://api.tylt.money/p2pRampsMerchant/getInstanceDetails?merchantOrderId={merchantOrderId}

Example Request

GEThttps://api.tylt.money/p2pRampsMerchant/getInstanceDetails?merchantOrderId=dOf6cc25-e9f9-11ef-830e-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 = {
  merchantOrderId: 'dOf6cc25-e9f9-11ef-830e-02d8461243e9'
};

const queryString = new URLSearchParams(params).toString();
const url = `https://api.tylt.money/p2pRampsMerchant/getInstanceDetails?${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/p2pRampsMerchant/getInstanceDetails"

params = {
  "merchantOrderId": 'dOf6cc25-e9f9-11ef-830e-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": {
        "trade": {
            "event": {
                "id": 4,
                "deadline": "2025-03-11T07:57:20Z",
                "description": "Seller Acknowledges Payment Receipt. Trade Completed."
            },
            "createdAt": "2025-03-11T07:56:19Z",
            "updatedAt": "2025-03-11T07:57:20Z",
            "isBuyTrade": 1,
            "fiatCurrency": {
                "name": "Indian Rupee",
                "symbol": "INR"
            },
            "priceDetails": {
                "price": 93.5,
                "amount": 2.3,
                "paymentAmount": 215.04999999999998
            },
            "cryptoCurrency": {
                "name": "Tether",
                "symbol": "USDT"
            },
            "paymentMethod": {
                 "details": {
                    "upiAddress": "p2ptrade@upi",
                    "qrString": "upi://pay?pa=p2ptrade@upi&pn=&am=215.04999999999998&cu=INR"
                }
            }
        },
        "transaction": {
            "amount": 2.2079999999999997,
            "status": "Completed",
            "isFinal": 1,
            "orderId": "538ffd9a-fe4e-11ef-bcfd-42010a280107",
            "createdAt": "2025-03-11T07:57:20Z",
            "updatedAt": "2025-03-11T07:57:22Z",
            "isCredited": 1,
            "merchantOrderId": "merchant-test-111"
        },
        "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
        },
        "user": {}
    }
}
Field
Type
Description

msg

string

Message providing additional context about the response.

data

object

Container for the response data.

data.trade

object

Details about the trade.

data.trade.isBuyTrade

number

Indicates if the trade is a buy trade (1 for buy, 0 for sell).

data.trade.event

object

Contains event details related to the trade lifecycle.

data.trade.event.id

number

data.trade.event.deadline

string

Deadline for completing the trade, in ISO 8601 format.

data.trade.event.description

string

A description of the eventId or its state.

data.trade.createdAt

string

Timestamp when the trade was created, in ISO 8601 format.

data.trade.updatedAt

string

Timestamp when the trade was last updated, in ISO 8601 format.

data.trade.fiatCurrency

object

Details about the fiat currency used in the trade.

data.trade.fiatCurrency.name

string

Name of the fiat currency (e.g., Indian Rupee).

data.trade.fiatCurrency.symbol

string

Symbol of the fiat currency (e.g., INR).

data.trade.priceDetails

object

Price-related details for the trade.

data.trade.priceDetails.price

number

The price per unit of the cryptocurrency in fiat currency.

data.trade.priceDetails.amount

number

The amount of cryptocurrency involved in the trade.

data.trade.priceDetails.paymentAmount

number

Total fiat payment amount for the trade.

data.trade.paymentMethod

object

Information about the payment method used.

data.trade.paymentMethod.details

string

Details of the payment method (e.g., UPI).

data.trade.cryptoCurrency

object

Details about the cryptocurrency used in the trade.

data.trade.cryptoCurrency.name

string

Name of the cryptocurrency (e.g., US Theather).

data.trade.cryptoCurrency.symbol

string

Symbol of the cryptocurrency (e.g., USDT).

data.transaction

object

Details about the associated transaction.

data.transaction.amount

number

The amount of fiat involved in the transaction.

data.transaction.status

string

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

data.transaction.isFinal

boolean

Indicates whether the transaction is in its final state.

data.transaction.orderId

string

Unique identifier for the transaction.

data.transaction.createdAt

string

Timestamp when the transaction was created, in ISO 8601 format.

data.transaction.updatedAt

string

Timestamp when the transaction was last updated, in ISO 8601 format.

data.transaction.isCredited

boolean

Indicates if the amount has been credited to the merchant.

data.transaction.merchantOrderId

string

Merchant-provided unique identifier for the transaction.

data.user

object

User-related information provided by the Merchant.

PreviousWebhook for Tylt PrimeNextGet Pay-In Transaction Information

Last updated 2 months ago

To better understand the payment process lifecycle and effectively utilize the data provided by the Get Instance Information API, refer to the detailed explanation of the event lifecycle

The event ID representing the current state of the trade. Read more about widget lifecycle

here
here