Criar uma Instância de Pay-In

Este endpoint permite criar uma nova instância de pagamento e receber uma URL que pode ser utilizada para abrir o Widget de Pagamento (Pay-In) do Tylt Prime. Por meio do widget, o cliente final do comerciante pode realizar um depósito ou pagamento via PIX. O valor pago é liquidado em USDT diretamente na carteira do comerciante.

Endpoint

POSThttps://api.tylt.money/v2/prime/BR/PIX/instance

Request Headers

First Tab

Name	Type	Example	Description
X-TLP-APIKEY	string	93ee3c5e133697251b5362bcf9cc8532476785t8768075616f58d88	Sua Chave de API Tylt, utilizada para identificar sua conta nas requisições da API.
X-TLP-SIGNATURE	string	d0afef3853dfc8489c8b9affa5825171fdd7y7685675e4966a05f66ed2b3eaf9462b3c9c0	Assinatura HMAC SHA-256 gerada usando a Chave Secreta da API para proteger a requisição.

Ao utilizar a API, certifique-se de incluir sua Chave de API e gerar a assinatura da carga da requisição usando sua Chave Secreta da API. As tabelas fornecidas acima contêm valores de exemplo apenas para fins ilustrativos. Consulte os trechos de código para obter instruções detalhadas sobre como assinar a requisição e gerar a assinatura corretamente.

Request Body

Body

Field Name	Type	Description
isBuyTrade	number	Deve ser definido como 1 para uma transação de Pay-In (entrada de pagamento).
userDetails	JSON Object	Campos personalizados associados ao usuário, fornecidos pelo comerciante. Esses campos são incluídos nas notificações de webhook e em outras respostas da API, facilitando a referência e o rastreamento. Um objeto vazio pode ser enviado.
merchantOrderId	string	Um UUID utilizado pelo comerciante para referenciar esta instância ou qualquer transação relacionada a ela.
callBackUrl	string	A URL para a qual são enviadas as atualizações de status de pagamento.
redirectUrl	string	A URL para a qual o usuário será redirecionado após a conclusão do pagamento.
amount	number	Opcional. Este é o valor que o usuário deseja depositar em USDT ou no seu equivalente em BRL. Se este campo for deixado em branco, o usuário poderá inserir o valor durante o fluxo de pagamento.
currencySymbol	string	Deve ser utilizado se o campo amount for informado. As moedas suportadas são apenas "USDT" ou "BRL".

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 = {
    isBuyTrade: 1,
    userDetails: {},
    merchantOrderId: 'b73b73b-87wtbc-q36gbc-331n3',
    callBackUrl: 'https://www.test.com/callback',
    redirectUrl: 'https://www.test.com/callback',
    amount: 10.00,
    currencySybmol: 'BRL'
};

// 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/p2pRampsMerchant/createInstance', raw, { headers })
    .then(response => console.log("Success:", response.data))
    .catch(error => console.error("Error:", error));

Python

import json
import hashlib
import hmac
import requests

# Replace with your API Key and Secret
api_key = 'your-api-key'
api_secret = 'your-api-secret'

# Function to create HMAC SHA-256 signature
def create_signature(secret, data):
    return hmac.new(secret.encode(), data.encode(), hashlib.sha256).hexdigest()

# Function to send a POST request
def send_post_request(url, body):
    raw = json.dumps(body, separators=(',', ':'), ensure_ascii=False)
    signature = create_signature(api_secret, raw)

    headers = {
        'Content-Type': 'application/json',
        'X-TLP-APIKEY': api_key,
        'X-TLP-SIGNATURE': signature
    }

    response = requests.post(url, headers=headers, data=raw)
    return response.json()

# Request body
request_body = {
    "isBuyTrade": 1,
    "userDetails": {},
    "merchantOrderId": 'b73b73b-87wtbc-q36gbc-331n3',
    "callBackUrl": 'https://www.test.com/callback',
    "redirectUrl": 'https://www.test.com/callback',
    "amount": 10.00,
    "currencySymbol" : 'BRL'
}

# Send the request
response = send_post_request('https://api.tylt.money/p2pRampsMerchant/createInstance', request_body)
print("Response:", response)

JavaScript (Fetch)

const fetch = require('node-fetch');
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 = {
    isBuyTrade: 1,
    userDetails: {},
    merchantOrderId: 'b73b73b-87wtbc-q36gbc-331n3',
    callBackUrl: 'https://www.test.com/callback',
    redirectUrl: 'https://www.test.com/callback',
    amount: 10.00,
    currencySybmol: 'BRL'
};

// 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 = {
    "Content-Type": "application/json",
    "X-TLP-APIKEY": apiKey,
    "X-TLP-SIGNATURE": signature
};

// Function to send the request
const sendRequest = async (url, headers, body) => {
    const response = await fetch(url, {
        method: 'POST',
        headers: headers,
        body: body,
    });
    return response.json();
};

// Send the request
sendRequest('https://api.tylt.money/p2pRampsMerchant/createInstance', headers, raw)
    .then(result => console.log("Success:", result))
    .catch(error => console.error("Error:", error));

Response

200

{
    "msg": "Instance created successfully",
    "data": {
        "url": "https://app.tylt.money/prime-brl/d0f6cc25-e8f8-11ef-830e-02d8461243e9",
        "instanceId": "d0f6cc25-e8f8-11ef-830e-02d8461243e9",
        "tradeId": 10432

        }    
}

Response Fields

Field Name	Type	Description
url	string	O link exclusivo para o Widget de Pagamento do Tylt Prime. Você pode exibir essa URL em um iframe ou abri-la em um navegador.
instanceId	string	O ID da instância gerado pelo Tylt, utilizado como um identificador global do tipo UUID.
tradeId	number	O ID da transação gerado pelo Tylt, utilizado como um identificador global numérico e exclusivo.