curl --request GET \
--url https://api.yuvexpay.com/v1/splits/partners \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.yuvexpay.com/v1/splits/partners"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.yuvexpay.com/v1/splits/partners', 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.yuvexpay.com/v1/splits/partners",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.yuvexpay.com/v1/splits/partners"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.yuvexpay.com/v1/splits/partners")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yuvexpay.com/v1/splits/partners")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"partners": [
{
"id": "0f0e1f5e-1d6a-4a77-9c1b-1c1a9f2a44c1",
"companyId": "7b1f2a2c-5f0b-4a3a-9b62-2e9a1f0c3d55",
"tradeName": "Ateliê Norte",
"direction": "OUTGOING",
"status": "ACCEPTED",
"requestedAt": "2026-09-10T12:00:00.000Z",
"acceptedAt": "2026-09-10T18:22:41.000Z"
},
{
"id": "3c5c5d61-9a21-4f65-b2a1-8a0e5d2c7b90",
"companyId": "a41c0f22-6e2d-4a10-8f3b-5d77cbb0a912",
"tradeName": "Studio Sul",
"direction": "OUTGOING",
"status": "REVOKED",
"requestedAt": "2026-08-02T09:14:00.000Z",
"acceptedAt": "2026-08-02T10:01:12.000Z"
}
]
}{
"error": {
"code": "INVALID_API_KEY",
"message": "Invalid or revoked API key"
}
}{
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "Required scope missing: balance:read"
}
}{
"error": {
"code": "RATE_LIMIT_EXCEEDED",
"message": "Too many requests"
}
}List split partners
Return the companies your account may split payments with, in both directions, for the environment of the API key. A pair is created in the dashboard: the originating company invites the recipient by company ID and the recipient accepts. There is no API to invite, accept, decline or revoke — accepting is a human act. Use this endpoint to discover which companyId values you may send as recipientCompanyId in splits[]: only a partner whose status is ACCEPTED is usable. The list carries the live row for each pair, plus the most recent answered row for a pair that has no live one, so a rejected or revoked pair is still visible. Requires the payments:read scope.
curl --request GET \
--url https://api.yuvexpay.com/v1/splits/partners \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.yuvexpay.com/v1/splits/partners"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.yuvexpay.com/v1/splits/partners', 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.yuvexpay.com/v1/splits/partners",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.yuvexpay.com/v1/splits/partners"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.yuvexpay.com/v1/splits/partners")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yuvexpay.com/v1/splits/partners")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"partners": [
{
"id": "0f0e1f5e-1d6a-4a77-9c1b-1c1a9f2a44c1",
"companyId": "7b1f2a2c-5f0b-4a3a-9b62-2e9a1f0c3d55",
"tradeName": "Ateliê Norte",
"direction": "OUTGOING",
"status": "ACCEPTED",
"requestedAt": "2026-09-10T12:00:00.000Z",
"acceptedAt": "2026-09-10T18:22:41.000Z"
},
{
"id": "3c5c5d61-9a21-4f65-b2a1-8a0e5d2c7b90",
"companyId": "a41c0f22-6e2d-4a10-8f3b-5d77cbb0a912",
"tradeName": "Studio Sul",
"direction": "OUTGOING",
"status": "REVOKED",
"requestedAt": "2026-08-02T09:14:00.000Z",
"acceptedAt": "2026-08-02T10:01:12.000Z"
}
]
}{
"error": {
"code": "INVALID_API_KEY",
"message": "Invalid or revoked API key"
}
}{
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "Required scope missing: balance:read"
}
}{
"error": {
"code": "RATE_LIMIT_EXCEEDED",
"message": "Too many requests"
}
}Authorizations
YuvexPay API key. Include as Authorization: Bearer ypk_<env>_<kid>_<secret> where <env> is test (sandbox) or live (production). Create and manage keys in the dashboard under Settings > API Keys.
Query Parameters
Return only partners in this state.
PENDING, ACCEPTED, REVOKED, DECLINED, CANCELLED OUTGOING lists companies you may split to; INCOMING lists companies that split to you.
OUTGOING, INCOMING Response
Partners listed.
Show child attributes
Show child attributes

