Get Instance Information

This endpoint allows you to retrieve detailed information about a specific Pay-In transaction. 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/v2/prime-fiat/instance/details?merchantOrderId=dOf6cc25-e9f9-11ef-830e-02d8461243e9

Example Request

GEThttps://api.tylt.money/v2/prime-fiat/instance/details?merchantOrderId=dOf6cc25-e9f9-11ef-830e-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

JavaScript

const crypto = require('crypto');

const params = {
  merchantOrderId: 'dOf6cc25-e9f9-11ef-830e-02d8461243e9'
};

const queryString = new URLSearchParams(params).toString();
const url = `https://api.tylt.money/v2/prime-fiat/instance/details??merchantOrderId?${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 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

Response Example

{
  "data": {
    "accounts": {
      "MDR": 2,
      "fees": 0.7,
      "rate": 0.8564,
      "fiatAmount": 5,
      "cryptoAmount": 5.84,
      "fiatCurrency": "EUR",
      "effectiveRate": 0.9728,
      "cryptoCurrency": "USDC",
      "toReleaseAmount": 5.14
    },
    "isBuying": 1,
    "instanceId": "9d6b5178-ce35-400a-8dd7-326e01f3d692",
    "callBackUrl": "https://gaming-demo.web.app/",
    "eventDetails": {
      "eventId": 14,
      "description": "Hold"
    },
    "walletDetails": {
      "address": "0x82e679f09bfd0c28506314dd851e379a083b5094",
      "network": "BSC"
    },
    "merchantOrderId": "ivytest1787202341649",
    "autoMerchantApproval": 1,
    "cryptoSettlementDetails": {
      "hash": "Pending",
      "Status": "hold",
      "Network": "BSC",
      "address": "0x82e679f09bfd0c28506314dd851e379a083b5094",
      "transferType": "external",
      "settlementTime": "2026-08-20T05:11:58Z",
      "settlementType": "T+1"
    }
  }
}

Response Fields

Field	Type	Description
instanceId	String	Unique identifier assigned by Tylt to the Pay-In instance.
merchantOrderId	String	Unique order identifier provided by the merchant for transaction identification and reconciliation.
url	String	URL used to redirect the end user to the Tylt Open Banking Pay-In flow.
userDetails	Object	End-user information associated with the transaction. This information is provided by the merchant at the time of user/account creation.
merchantDetails	Object	Merchant information associated with the transaction. This information is provided by the merchant at the time of account creation.
fiatAmount	Number	Fiat amount to be paid by the end user.
fiatCurrencySymbol	String	Fiat currency used for the transaction, such as EUR or GBP.
cryptoAmount	Number	Gross crypto amount calculated for the transaction.
cryptoCurrencySymbol	String	Crypto asset applicable to the transaction, such as USDC or USDT.
toReleaseAmount	Number	Net crypto amount to be credited or settled after applicable fees and pricing adjustments.
fees	Number	Total fees applied to the transaction, expressed in the crypto currency.
rate	Number	Base fiat-to-crypto conversion rate used for the transaction.
effectiveRate	Number	Effective conversion rate after applicable fees, spread, or commercial pricing.
walletDetails	Object	Contains the destination wallet details for transactions requiring an external crypto transfer.
walletDetails.address	String	Destination blockchain wallet address.
walletDetails.network	String	Blockchain network to be used for the external transfer, such as BSC.
cryptoSettlementDetails	Object	Contains information relating to the crypto settlement of the transaction.
cryptoSettlementDetails.Status	String	Current crypto settlement status, such as Pending.
cryptoSettlementDetails.hash	String	Blockchain transaction hash. May be Pending until the external settlement transaction is initiated or broadcast.
cryptoSettlementDetails.address	String	Destination wallet address for the crypto settlement.
cryptoSettlementDetails.Network	String	Blockchain network used for settlement, such as BSC.
cryptoSettlementDetails.transferType	String	Determines the settlement destination. external indicates transfer to an external wallet; internal indicates internal crediting.
cryptoSettlementDetails.settlementType	String	Configured settlement schedule, such as instant or T+1.
cryptoSettlementDetails.settlementTime	String	Settlement completion time or current settlement-time status. May be Pending until settlement is completed.