Skip to main content
POST
/
transactions
/
v2
/
brl
/
initiate_offramp
BRL Auto Offramp
curl --request POST \
  --url https://api.linkio.world/transactions/v2/brl/initiate_offramp \
  --header 'Content-Type: application/json' \
  --header 'ngnc-sec-key: <api-key>' \
  --data '
{
  "pix_key": "<string>",
  "amount": "<string>",
  "wallet_address": "<string>",
  "stables": "USDC"
}
'
import requests

url = "https://api.linkio.world/transactions/v2/brl/initiate_offramp"

payload = {
"pix_key": "<string>",
"amount": "<string>",
"wallet_address": "<string>",
"stables": "USDC"
}
headers = {
"ngnc-sec-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'ngnc-sec-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
pix_key: '<string>',
amount: '<string>',
wallet_address: '<string>',
stables: 'USDC'
})
};

fetch('https://api.linkio.world/transactions/v2/brl/initiate_offramp', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.linkio.world/transactions/v2/brl/initiate_offramp",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'pix_key' => '<string>',
'amount' => '<string>',
'wallet_address' => '<string>',
'stables' => 'USDC'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"ngnc-sec-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.linkio.world/transactions/v2/brl/initiate_offramp"

payload := strings.NewReader("{\n \"pix_key\": \"<string>\",\n \"amount\": \"<string>\",\n \"wallet_address\": \"<string>\",\n \"stables\": \"USDC\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("ngnc-sec-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.linkio.world/transactions/v2/brl/initiate_offramp")
.header("ngnc-sec-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"pix_key\": \"<string>\",\n \"amount\": \"<string>\",\n \"wallet_address\": \"<string>\",\n \"stables\": \"USDC\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.linkio.world/transactions/v2/brl/initiate_offramp")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["ngnc-sec-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"pix_key\": \"<string>\",\n \"amount\": \"<string>\",\n \"wallet_address\": \"<string>\",\n \"stables\": \"USDC\"\n}"

response = http.request(request)
puts response.read_body
"{\n  \"status\": \"Success\",\n  \"message\": \"Off-ramp ticket created successfully\",\n  \"ticket_id\": \"ticket_789xyz\",\n  \"payment_code\": \"000201010212...\",\n  \"validity\": \"5 minutes\",\n  \"paymentWalletAddress\": \"0x211...\",// Valid  for Offramp. where to send USDC to.\n}"

Authorizations

ngnc-sec-key
string
header
default:""
required

Body

application/json
pix_key
string
required

The registered PIX key (BRL payout account) where BRL will be sent after swap.

amount
string
required

Amount in USDC/USDT to convert into BRL.

wallet_address
string
required

On-chain address customer used to send their USDC/USDT

stables
string
default:USDC
required

Stablecoin tøken to send in. USDC/USDT.

Response

200 - application/json