curl --request POST \
--url https://api.clarian.finance/v1/{env}/payment-links \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Workspace-Id: <api-key>' \
--data '
{
"amount_minor": "<string>",
"allow_custom_amount": false,
"currency": "BRL",
"description": "<string>",
"slug": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"party_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {}
}
'import requests
url = "https://api.clarian.finance/v1/{env}/payment-links"
payload = {
"amount_minor": "<string>",
"allow_custom_amount": False,
"currency": "BRL",
"description": "<string>",
"slug": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"party_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {}
}
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({
amount_minor: '<string>',
allow_custom_amount: false,
currency: 'BRL',
description: '<string>',
slug: '<string>',
expires_at: '2023-11-07T05:31:56Z',
party_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
metadata: {}
})
};
fetch('https://api.clarian.finance/v1/{env}/payment-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.clarian.finance/v1/{env}/payment-links",
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([
'amount_minor' => '<string>',
'allow_custom_amount' => false,
'currency' => 'BRL',
'description' => '<string>',
'slug' => '<string>',
'expires_at' => '2023-11-07T05:31:56Z',
'party_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'metadata' => [
]
]),
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}/payment-links"
payload := strings.NewReader("{\n \"amount_minor\": \"<string>\",\n \"allow_custom_amount\": false,\n \"currency\": \"BRL\",\n \"description\": \"<string>\",\n \"slug\": \"<string>\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"party_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {}\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}/payment-links")
.header("Authorization", "Bearer <token>")
.header("X-Workspace-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount_minor\": \"<string>\",\n \"allow_custom_amount\": false,\n \"currency\": \"BRL\",\n \"description\": \"<string>\",\n \"slug\": \"<string>\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"party_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clarian.finance/v1/{env}/payment-links")
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 \"amount_minor\": \"<string>\",\n \"allow_custom_amount\": false,\n \"currency\": \"BRL\",\n \"description\": \"<string>\",\n \"slug\": \"<string>\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"party_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environment": "sandbox",
"party_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount_minor": "<string>",
"currency": "<string>",
"allow_custom_amount": true,
"status": "active",
"slug": "<string>",
"description": "<string>",
"design": {},
"expires_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"title": "<string>",
"metadata": {}
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Create payment link
curl --request POST \
--url https://api.clarian.finance/v1/{env}/payment-links \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Workspace-Id: <api-key>' \
--data '
{
"amount_minor": "<string>",
"allow_custom_amount": false,
"currency": "BRL",
"description": "<string>",
"slug": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"party_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {}
}
'import requests
url = "https://api.clarian.finance/v1/{env}/payment-links"
payload = {
"amount_minor": "<string>",
"allow_custom_amount": False,
"currency": "BRL",
"description": "<string>",
"slug": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"party_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {}
}
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({
amount_minor: '<string>',
allow_custom_amount: false,
currency: 'BRL',
description: '<string>',
slug: '<string>',
expires_at: '2023-11-07T05:31:56Z',
party_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
metadata: {}
})
};
fetch('https://api.clarian.finance/v1/{env}/payment-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.clarian.finance/v1/{env}/payment-links",
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([
'amount_minor' => '<string>',
'allow_custom_amount' => false,
'currency' => 'BRL',
'description' => '<string>',
'slug' => '<string>',
'expires_at' => '2023-11-07T05:31:56Z',
'party_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'metadata' => [
]
]),
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}/payment-links"
payload := strings.NewReader("{\n \"amount_minor\": \"<string>\",\n \"allow_custom_amount\": false,\n \"currency\": \"BRL\",\n \"description\": \"<string>\",\n \"slug\": \"<string>\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"party_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {}\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}/payment-links")
.header("Authorization", "Bearer <token>")
.header("X-Workspace-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount_minor\": \"<string>\",\n \"allow_custom_amount\": false,\n \"currency\": \"BRL\",\n \"description\": \"<string>\",\n \"slug\": \"<string>\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"party_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clarian.finance/v1/{env}/payment-links")
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 \"amount_minor\": \"<string>\",\n \"allow_custom_amount\": false,\n \"currency\": \"BRL\",\n \"description\": \"<string>\",\n \"slug\": \"<string>\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"party_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environment": "sandbox",
"party_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount_minor": "<string>",
"currency": "<string>",
"allow_custom_amount": true,
"status": "active",
"slug": "<string>",
"description": "<string>",
"design": {},
"expires_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"title": "<string>",
"metadata": {}
}
}{
"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.
Headers
Wallet-as-a-service: act on one of the caller's own sub-accounts (its ledger, parties and wallets) instead of the workspace itself. Only valid on balances/wallets/transactions/statement/crypto/pix/payment-links/rfq routes, only for a workspace-level caller (not a party-scoped key), and only for a sub-account the caller's workspace owns.
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
Either a fixed amount_minor, or allow_custom_amount=true for an open-amount page the buyer prices.
Required unless allow_custom_amount is true.
^[0-9]{1,16}$Globally unique across every merchant; a random one is generated when omitted.
Response
OK
Show child attributes
Show child attributes