# 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 [**`GET`**](https://dev-api.tylt.money/v2/prime-fiat/instance/details)`https://api.tylt.money/v2/prime-fiat/instance/details?merchantOrderId=dOf6cc25-e9f9-11ef-830e-02d8461243e9` #### Example Request **`GET`**`https://api.tylt.money/v2/prime-fiat/instance/details?merchantOrderId=dOf6cc25-e9f9-11ef-830e-02d8461243e9` **Request Headers** {% tabs %} {% tab title="Headers" %}
NameTypeExampleDescription
X-TLP-APIKEYstring93ee3c5e133697251b5362bcf9cc8532476785t8768075616f58d88Your Tylt API Key, used to identify your account in API requests.
X-TLP-SIGNATUREstringd0afef3853dfc8489c8b9affa5825171fdd7y7685675e4966a05f66ed2b3eaf9462b3c9c0HMAC SHA-256 signature generated using the API Secret Key to secure the request.
{% endtab %} {% endtabs %} {% hint style="info" %} 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. {% endhint %} **Code Snippet** {% tabs %} {% tab title="JavaScript" %} ```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)); ``` {% endtab %} {% endtabs %} **Response** {% tabs %} {% tab title="Response Example" %} ```json { "msg": "Instance details fetched successfully.", "data": { "instanceId": "443bd1a8-944b-4595-8dcf-21e274e6386c", "isBuying": 0, "eventId": 4, "eventDescription": "Payment Completed", "fiatAmount": 30, "fiatCurrencySymbol": "EUR", "rate": 1.3, "cryptoAmount": 39, "cryptoCurrencySymbol": "USDC", "fees": 0.78, "bankStatementReference": "irf482bca625d9a9d", "callBackUrl": "https://www.callback.com", "redirectUrl": "https://www.google.com", "userDetails": { "firstName": "Test", "lastName": "User", "email": "testuser@testemail.com", "country": "Poland", "dob": "1990-01-01", "DocumentType": "Identity Card", "DocumentNumber": "426349253ZY8", "DocumentURL": "https://kyc.gaming.com/b1278191.jpeg" }, "payeeDetails": { "iban": "FR7630006000011234567890185" }, "merchantDetils":{ "merchantName": "Example Merchant Ltd", "merchantUrl": "https://www.examplemerchant.com", "merchantInternalId": "merchant-12345" }, "autoMerchantApproval": 1, "MDR": 2 } } ``` {% endtab %} {% tab title="Response Fields" %} | Field | Type | Description | | ------------------------ | ------ | ---------------------------------------------------------------------------- | | `instanceId` | String | Unique identifier for the payment instance. | | `isBuying` | Number | Indicates whether the transaction is a Pay-In (`1`) or Pay-Out (`0`). | | `eventId` | Number | Numeric code representing the current transaction lifecycle state. | | `eventDescription` | String | Human-readable description of the transaction status. | | `fiatAmount` | Number | Amount paid by the customer in fiat currency. | | `fiatCurrencySymbol` | String | Fiat currency symbol used in the transaction — always `"EUR"`. | | `rate` | Number | EUR → USDC conversion rate applied for the transaction. | | `cryptoAmount` | Number | Amount of USDC credited to the merchant after conversion. | | `cryptoCurrencySymbol` | String | Crypto currency used for settlement — always `"USDC"`. | | `fees` | Number | Total fees charged for processing the transaction. | | `bankStatementReference` | String | Unique reference shown in the customer’s bank statement. | | `callBackUrl` | String | Merchant-configured URL to receive payment or settlement callbacks. | | `redirectUrl` | String | URL used to redirect the customer to complete or authorize the payment. | | `userDetails` | Object | Merchant-defined metadata associated with the customer. | | `merchantDetails` | Object | Merchant-defined metadata associated with the merchant being paid. | | `payeeDetails` | Object | Object containing users bank account details where the payment will be made. | | `MDR` | Number | Merchant Discount Rate applied to the transaction (percentage). | | {% endtab %} | | | | {% endtabs %} | | | --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.tylt.money/introduction/tylt-crossramp-fiat-crypto-solutions/eu-open-banking/open-banking-payout-usdc-eur/get-instance-information.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.