Consultar link de onboarding ativo
curl --request GET \
--url https://api.uvvipay.com.br/v2/submerchants/links \
--header 'client-id: <api-key>' \
--header 'client-secret: <api-key>'import requests
url = "https://api.uvvipay.com.br/v2/submerchants/links"
headers = {
"client-secret": "<api-key>",
"client-id": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'client-secret': '<api-key>', 'client-id': '<api-key>'}
};
fetch('https://api.uvvipay.com.br/v2/submerchants/links', 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.uvvipay.com.br/v2/submerchants/links",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"client-id: <api-key>",
"client-secret: <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"
"net/http"
"io"
)
func main() {
url := "https://api.uvvipay.com.br/v2/submerchants/links"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("client-secret", "<api-key>")
req.Header.Add("client-id", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.uvvipay.com.br/v2/submerchants/links")
.header("client-secret", "<api-key>")
.header("client-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uvvipay.com.br/v2/submerchants/links")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["client-secret"] = '<api-key>'
request["client-id"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"url": "https://app.uvvipay.com/onboarding/2f1c8b9a-4d3e-4f6a-9b1c-0a1b2c3d4e5f",
"status": "active",
"created_at": "2026-07-16T18:00:00.000Z"
}Links de onboarding
Consultar link de onboarding
Retorna o link de onboarding ativo da organização autenticada, ou null quando não houver link ativo.
GET
/
v2
/
submerchants
/
links
Consultar link de onboarding ativo
curl --request GET \
--url https://api.uvvipay.com.br/v2/submerchants/links \
--header 'client-id: <api-key>' \
--header 'client-secret: <api-key>'import requests
url = "https://api.uvvipay.com.br/v2/submerchants/links"
headers = {
"client-secret": "<api-key>",
"client-id": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'client-secret': '<api-key>', 'client-id': '<api-key>'}
};
fetch('https://api.uvvipay.com.br/v2/submerchants/links', 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.uvvipay.com.br/v2/submerchants/links",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"client-id: <api-key>",
"client-secret: <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"
"net/http"
"io"
)
func main() {
url := "https://api.uvvipay.com.br/v2/submerchants/links"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("client-secret", "<api-key>")
req.Header.Add("client-id", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.uvvipay.com.br/v2/submerchants/links")
.header("client-secret", "<api-key>")
.header("client-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uvvipay.com.br/v2/submerchants/links")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["client-secret"] = '<api-key>'
request["client-id"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"url": "https://app.uvvipay.com/onboarding/2f1c8b9a-4d3e-4f6a-9b1c-0a1b2c3d4e5f",
"status": "active",
"created_at": "2026-07-16T18:00:00.000Z"
}Retorna o link de onboarding ativo da organização, ou
null quando não
houver link ativo. Exige headers client-id + client-secret.Headers
Secret da credencial do merchant
ID público da credencial do merchant
Response
object | null
Link ativo ou null
Link de onboarding ativo, ou null quando inexistente
URL completa do onboarding com token
Example:
"https://app.uvvipay.com/onboarding/2f1c8b9a-4d3e-4f6a-9b1c-0a1b2c3d4e5f"
Status do link de onboarding
Available options:
active, inactive, cancelled Example:
"active"
Data de criação do link
Example:
"2026-07-16T18:00:00.000Z"

