Create a Pay-out Instance

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

Endpoint

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

Request 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.

Request Body

Field Name

Type

Description

isBuyTrade

number

Must be set to 0 for a Pay-out transaction.

userDetails

JSON Object

Custom fields associated with the user, supplied by the merchant. These fields are included in web-hook notifications and other API responses for easy reference and tracking. An empty object can be sent.

merchantOrderId

string

A UUID used by the merchant to reference this instance or any transaction related to it.

callBackUrl

string

The URL to which payment status updates are sent.

redirectUrl

string

The URL to redirect the user after completing the payment.

amount

number

Mandatory. This is the amount the user wants to withdraw in USDT or BRL equivalent.

currencySymbol

string

Supported Currency is "USDT" or "BRL" only.

autoPayout

integer

Set to 1 if you want the payout to be processed automatically, without requiring the user to interact with the Pay-Out widget.

When set to 0, the user must manually confirm the payout through the widget interface.

pixDetails

JSON Object

Mandatory if autoPayout = 1. Object containing PIX payout beneficiary details, including: (a) recipient’s full name, (b) PIX key type (CPF, EMAIL, MOBILE), (c) corresponding PIX key value, and (d) CPF. If autoPayout = 0, the user will be required to enter these details within the Payment widget.

If pixDetails are provided in this case, the Payment widget will be pre-populated with the supplied information. This information is used to identify and correctly route the PIX transaction to the intended beneficiary.

Important Note on autoPayout Usage

If using autoPayout = 1, please make note of the following:

KYC / Risk Triggers: If the payout request triggers a compliance or risk requirement (e.g., due to cumulative 30-day transaction volume or CPF-linked payment thresholds), the payout will fail automatically.
KYC Requirement: Users who exceed permitted payout limits may be required to complete KYC verification. Since the autoPayout flow does not invoke the payout widget, KYC submission cannot be completed automatically, and the payout will not proceed.
Recommended Approach: It is generally recommended to use the widget-based payout flow, which handles user KYC interactions seamlessly. However, autoPayout may be used for verified users or pre-approved payout routes where no compliance intervention is expected.
Widget URL Omission When autoPayout is set to 1, the payout widget URL will not be included in the API response, since no user interaction is required.

Code Snippet

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: 0, // 0 = Sell (Off-Ramp), 1 = Buy (On-Ramp)
  userDetails: {}, // Optional user metadata (e.g., email, phone, userId)
  merchantOrderId: crypto.randomUUID(),
  callBackUrl: 'https://www.test.com/callback',
  redirectUrl: 'https://www.test.com/callback',
  amount: 10,
  currencySymbol: 'BRL',
  autoPayout: 1, // 1 = Auto process payout, 0 = Manual via widget ( Default)
  pixDetails: { // Required if autoPayout is set to 1
    fullName: 'João Pereira',
    cpfKey: '12345678910',
    pixKeyType: 'CPF', // Accepted values: 'CPF', 'EMAIL', 'MOBILE'
    pixKey: '12345678910'
  }
};

// Print request body for reference
console.log('requestBody',requestBody);

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

import json
import hashlib
import hmac
import requests
import uuid

# 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": 0,
  "userDetails": {},
  "merchantOrderId": str(uuid.uuid4()),
  "callBackUrl": "https://www.test.com/callback",
  "redirectUrl": "https://www.test.com/callback",
  "amount": 10,
  "currencySymbol": "BRL",
  "autoPayout": 1,
  "pixDetails": {
    "fullName": "João Pereira",
    "cpfKey": "12345678910",
    "pixKeyType": "CPF",
    "pixKey": "12345678910"
  }
}

# Print request body for reference
print('requst_body',request_body)


# Send the request
response = send_post_request('https://api.tylt.money/v2/prime/BR/PIX/instance', request_body)
print("Response:", response)

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: 0, // 0 = Sell (Off-Ramp), 1 = Buy (On-Ramp)
  userDetails: {}, // Optional user metadata (e.g., email, phone, userId)
  merchantOrderId: crypto.randomUUID(),
  callBackUrl: 'https://www.test.com/callback',
  redirectUrl: 'https://www.test.com/callback',
  amount: 10.00,
  currencySymbol: 'BRL',
  autoPayout: 1, // 1 = Auto process payout, 0 = Manual via widget
  pixDetails: {
    fullName: 'João Pereira',
    cpfKey: '12345678910',
    pixKeyType: 'CPF', // Accepted values: 'CPF', 'EMAIL', 'MOBILE'
    pixKey: '12345678910'
  }
};

// Print request body for reference
console.log("requestBody", requestBody);

// 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/v2/prime/BR/PIX/instance', headers, raw)
    .then(result => console.log("Success:", result))
    .catch(error => console.error("Error:", error));

Response

{
    "msg": "Instance created successfully",
    "data": {
        "url": "https://app.tylt.money/prime-brl/d0f6cc25-e8f8-11ef-830e-02d8461243e9", // will not be sent if autoPayout is set to 1
        "instanceId": "d0f6cc25-e8f8-11ef-830e-02d8461243e9",
        "tradeId": 10432

        }    
}

PreviousPIX Payout (USDT → BRL)NextWebhook for Tylt CrossRamp ( Pay-out)

Last updated 24 days ago