curl --request POST \
--url https://api.clarian.finance/v1/{env}/pix/payouts/dict \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Workspace-Id: <api-key>' \
--data '
{
"pix_key": "<string>"
}
'import requests
url = "https://api.clarian.finance/v1/{env}/pix/payouts/dict"
payload = { "pix_key": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"X-Workspace-Id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Workspace-Id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({pix_key: '<string>'})
};
fetch('https://api.clarian.finance/v1/{env}/pix/payouts/dict', 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.clarian.finance/v1/{env}/pix/payouts/dict",
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>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Workspace-Id: <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.clarian.finance/v1/{env}/pix/payouts/dict"
payload := strings.NewReader("{\n \"pix_key\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Workspace-Id", "<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.clarian.finance/v1/{env}/pix/payouts/dict")
.header("Authorization", "Bearer <token>")
.header("X-Workspace-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"pix_key\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clarian.finance/v1/{env}/pix/payouts/dict")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Workspace-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"pix_key\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"pix_key": "<string>",
"holder_name": "<string>",
"document_masked": "<string>",
"bank_name": "<string>",
"bank_code": "<string>",
"account_type": "<string>"
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}DICT key lookup
The provider has no standalone lookup; outside the mock provider this answers 501 — a payout resolves the receiver when it initiates.
curl --request POST \
--url https://api.clarian.finance/v1/{env}/pix/payouts/dict \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Workspace-Id: <api-key>' \
--data '
{
"pix_key": "<string>"
}
'import requests
url = "https://api.clarian.finance/v1/{env}/pix/payouts/dict"
payload = { "pix_key": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"X-Workspace-Id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Workspace-Id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({pix_key: '<string>'})
};
fetch('https://api.clarian.finance/v1/{env}/pix/payouts/dict', 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.clarian.finance/v1/{env}/pix/payouts/dict",
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>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Workspace-Id: <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.clarian.finance/v1/{env}/pix/payouts/dict"
payload := strings.NewReader("{\n \"pix_key\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Workspace-Id", "<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.clarian.finance/v1/{env}/pix/payouts/dict")
.header("Authorization", "Bearer <token>")
.header("X-Workspace-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"pix_key\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clarian.finance/v1/{env}/pix/payouts/dict")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Workspace-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"pix_key\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"pix_key": "<string>",
"holder_name": "<string>",
"document_masked": "<string>",
"bank_name": "<string>",
"bank_code": "<string>",
"account_type": "<string>"
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Authorizations
Authorization: Bearer cl_test_sk_... (sandbox) or Bearer cl_live_sk_... (live). A live key additionally needs production enabled by the workspace owner. Using a live key against the sandbox path revokes it on sight (leak signal); a sandbox key on live is refused and logged, but not revoked.
The workspace (tenant) UUID. Always required, including on session-authenticated dashboard calls.
Path Parameters
test is also accepted on the wire as an alias of sandbox; the key prefix must match (cl_test_sk_ for sandbox/test, cl_live_sk_ for live).
sandbox, live Body
Response
OK
DICT key resolution. The provider has no standalone lookup endpoint — this answers 501 dict_lookup_unsupported outside the mock provider; a real payout resolves the receiver when it initiates instead.
Show child attributes
Show child attributes