Create a Pay-in Instance

This endpoint allows you to create a new payment instance and receive a URL that can be used to launch the Tylt CrossRamp Open Banking Pay-In widget. Through the widget, the merchant's end customer can make a deposit or payment to the merchant using Open Banking. The payment is settled in USDC into the merchants wallet.

Endpoint

POSThttps://api.tylt.money/v2/prime-fiat/instance/payin

Request Headers

First Tab

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.

Request Body

Body

Field Name	Type	Description
userDetails	JSON Object	Custom fields associated with the end user making a payment to the merchant. These fields are echoed back in webhook notifications and other API responses for tracking and reconciliation.You may send an empty object ({}). Reserved keys (auto-populate payment widget) The following keys are reserved. If you include any of them, they will be used to pre-fill the corresponding fields in the hosted payment widget: firstName (string) lastName (string) email (string) country (string) dob (string, format: YYYY-MM-DD) If a reserved field is not provided, the end user will be prompted to enter that field in the widget (if required by the flow).
merchantOrderId	string	Mandatory. A UUID used by the merchant to reference this instance or any transaction related to it.
callBackUrl	string	Mandatory. The URL to which payment status updates are sent.
redirectUrl	string	Mandatory. The URL to redirect the user after completing the payment.
amount	number	Mandatory. This is the amount the user wants to deposit in EUR.
currencySymbol	string	Mandatory. Supported Currency is "EUR" only
merchantDetails	JSON Object	The merchantDetails object identifies the merchant on whose behalf the transaction is being processed. This information is required for transaction attribution, reconciliation, risk screening, and regulatory reporting. If the integrator is acting as a Merchant of Record, the details of the underlying end merchant must be provided If the integrator is the end merchant, the details of its own business must be provided. The following fields must be provided inside the merchantDetails object: merchantName The legal or DBA name of the merchant. merchantUrl The official website URL of the merchant. This must be a valid HTTPS URL representing the merchant’s active operating website. merchantInternalId A unique internal identifier assigned by the merchant. This identifier is used for reconciliation, reporting, and ongoing transaction tracking and must remain consistent across transactions. All fields within merchantDetails are mandatory. Transactions submitted without this object, or with incomplete merchant details, will be rejected. Transactions with new merchantDetails go through an automated internal review process.
cryptoUi	number	Controls the visual mode of the hosted payment widget. Default is 1. If set to 1, the widget UI is adapted to showcase a crypto purchase flow. If set to 0, the widget UI is adapted to showcase a fiat payment flow.

Code Snippet

JavaScript (Axios)

const axios = require('axios');
const crypto = require('crypto');

// Replace with your API Key and Secret
const apiKey = 'your-api-key';
const apiSecret = 'your-api-secret';

// Request body
const requestBody = {
    userDetails: {},
    merchantOrderId: 'b73b73b-87wtbc-q36gbc-331n3',
    callBackUrl: 'https://www.test.com/callback',
    redirectUrl: 'https://www.test.com/callback',
    amount: 10.00,
    currencySybmol: 'EUR',
    merchantDetails: {
        merchantName: "Example Merchant Ltd",
        merchantUrl: "https://www.examplemerchant.com",
        merchantInternalId: "merchant-12345"
    },
    userDetails: {
            firstName: "Test",
            lastName: "User",
            email: `[email protected]`,
            country: "Poland",
            dob: "1990-01-01",
            DocumentType: "Identity Card",
            DocumentNumber: "426349253ZY8",
            DocumentURL : "https://kyc.gaming.com/b1278191.jpeg"          
    }
};

// Convert request body to JSON
const raw = JSON.stringify(requestBody);

// Function to create HMAC SHA-256 signature
const createSignature = (secret, data) => {
    return crypto.createHmac('sha256', secret)
                 .update(data)
                 .digest('hex');
};

// Generate signature
const signature = createSignature(apiSecret, raw);

// Define headers
const headers = {
    "X-TLP-APIKEY": apiKey,
    "X-TLP-SIGNATURE": signature
};

// Send the request
axios.post('https://api.tylt.money/v2/prime-fiat/instance/payin', raw, { headers })
    .then(response => console.log("Success:", response.data))
    .catch(error => console.error("Error:", error));

Response

200

{
  "msg": "Ivy instance created successfully",
  "data": {
    "instanceId": "467153bc-72a8-466d-8fb1-59b080250554",
    "merchantOrderId": "merchant-test-gWsQ1fiLmk",
    "url": "https://app.tylt.money/prime-eur-instance/467153bc-72a8-466d-8fb1-59b080250554",
    "userDetails": {
      "firstName": "Test",
      "lastName": "User",
      "email": `[email protected]`,
      "country": "Poland",
      "dob": "1990-01-01",
      "DocumentType": "Identity Card",
      "DocumentNumber": "426349253ZY8",
      "DocumentURL": "https://kyc.gaming.com/b1278191.jpeg" 
    },
    "merchantDetils":{ 
            "merchantName": "Example Merchant Ltd",
            "merchantUrl": "https://www.examplemerchant.com",
            "merchantInternalId": "merchant-12345"
    },
    "fiatAmount": 4000,
    "fiatCurrencySymbol": "EUR",
    "cryptoAmount": 4686.58,
    "cryptoCurrencySymbol": "USDC",
    "rate": 0.8535
  }
}

Response Fields