| 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. |
| 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:
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, GBP. |
currencySymbol | string | Mandatory. Supported Currency is "EUR" , "GBP" only. |
transferType | string | Settlement destination. Supported values are "internal" and "external". Defaults to "internal". |
settlementType | string | Settlement schedule. Defaults to "instant". Other approved values may use the T+N format, such as "T+1" |
walletDetails | object | External wallet address to which the USDC, USDT settlement will be delivered. Required if settlementType is "external" |
| string | External wallet address to which the USDC, USDT settlement will be delivered. |
| string | Blockchain network associated with the wallet address, such as "ETH" or "BSC" or "TRX" or "POL" |
merchantDetails | JSON Object | The
All fields within |
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. |
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 = {
merchantOrderId: 'b73b73b-87wtbc-q36gbc-331n3', // please use a unique order id per request
callBackUrl: 'https://www.test.com/callback',
redirectUrl: 'https://www.test.com/callback',
amount: 10.00,
currencySymbol: 'EUR',
merchantDetails: {
merchantName: "Example Merchant Ltd",
merchantUrl: "https://www.examplemerchant.com",
merchantInternalId: "merchant-12345"
},
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"
}
};
// 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));
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 = {
merchantOrderId: 'b73b73b-87wtbc-q36gbc-331n3', // please use a unique order id per request
callBackUrl: 'https://www.test.com/callback',
redirectUrl: 'https://www.test.com/callback',
amount: 10.00,
currencySymbol: 'EUR',
merchantDetails: {
merchantName: "Example Merchant Ltd",
merchantUrl: "https://www.examplemerchant.com",
merchantInternalId: "merchant-12345"
},
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"
},
transferType: "external",
settlementType: "T+1"
walletDetails: {
address:"0x48AF3Bd03E9c707e037a3d8623eEXXXXXXXXXXB3",
network:"POL"
}
};
// 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));