Open a PIX charge on a payment link
curl --request POST \
--url https://api.clarian.finance/v1/{env}/payment-links/{id}/charges \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'X-Workspace-Id: <api-key>' \
--data '
{
"payer_document": "<string>",
"payer_name": "<string>",
"amount_minor": "<string>",
"email": "<string>"
}
'import requests
url = "https://api.clarian.finance/v1/{env}/payment-links/{id}/charges"
payload = {
"payer_document": "<string>",
"payer_name": "<string>",
"amount_minor": "<string>",
"email": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"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: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'X-Workspace-Id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
payer_document: '<string>',
payer_name: '<string>',
amount_minor: '<string>',
email: '<string>'
})
};
fetch('https://api.clarian.finance/v1/{env}/payment-links/{id}/charges', 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/{id}/charges",
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([
'payer_document' => '<string>',
'payer_name' => '<string>',
'amount_minor' => '<string>',
'email' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"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/{id}/charges"
payload := strings.NewReader("{\n \"payer_document\": \"<string>\",\n \"payer_name\": \"<string>\",\n \"amount_minor\": \"<string>\",\n \"email\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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/{id}/charges")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("X-Workspace-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"payer_document\": \"<string>\",\n \"payer_name\": \"<string>\",\n \"amount_minor\": \"<string>\",\n \"email\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clarian.finance/v1/{env}/payment-links/{id}/charges")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["X-Workspace-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"payer_document\": \"<string>\",\n \"payer_name\": \"<string>\",\n \"amount_minor\": \"<string>\",\n \"email\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"payment_link_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"payment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"party_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environment": "sandbox",
"kind": "<string>",
"status": "created",
"amount_minor": "<string>",
"currency": "<string>",
"fee_minor": "<string>",
"description": "<string>",
"provider_ref": "<string>",
"pix_qr_code": "<string>",
"pix_tx_id": "<string>",
"pix_key": "<string>",
"to_address": "<string>",
"network": "<string>",
"tx_hash": "<string>",
"failure_reason": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"idempotency_key": "<string>",
"counterparty": {},
"pix_txid": "<string>",
"from_address": "<string>",
"wallet_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_currency": "<string>",
"target_currency": "<string>",
"exchange_rate": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"failed_at": "2023-11-07T05:31:56Z",
"quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"related_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
}{
"data": {
"payment_link_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"payment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"party_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environment": "sandbox",
"kind": "<string>",
"status": "created",
"amount_minor": "<string>",
"currency": "<string>",
"fee_minor": "<string>",
"description": "<string>",
"provider_ref": "<string>",
"pix_qr_code": "<string>",
"pix_tx_id": "<string>",
"pix_key": "<string>",
"to_address": "<string>",
"network": "<string>",
"tx_hash": "<string>",
"failure_reason": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"idempotency_key": "<string>",
"counterparty": {},
"pix_txid": "<string>",
"from_address": "<string>",
"wallet_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_currency": "<string>",
"target_currency": "<string>",
"exchange_rate": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"failed_at": "2023-11-07T05:31:56Z",
"quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"related_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}PaymentLinks
Open a PIX charge on a payment link
The merchant’s own backend opening a charge on its own checkout (gateway-style integration), as opposed to the public buyer-facing pay route.
POST
/
v1
/
{env}
/
payment-links
/
{id}
/
charges
Open a PIX charge on a payment link
curl --request POST \
--url https://api.clarian.finance/v1/{env}/payment-links/{id}/charges \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'X-Workspace-Id: <api-key>' \
--data '
{
"payer_document": "<string>",
"payer_name": "<string>",
"amount_minor": "<string>",
"email": "<string>"
}
'import requests
url = "https://api.clarian.finance/v1/{env}/payment-links/{id}/charges"
payload = {
"payer_document": "<string>",
"payer_name": "<string>",
"amount_minor": "<string>",
"email": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"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: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'X-Workspace-Id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
payer_document: '<string>',
payer_name: '<string>',
amount_minor: '<string>',
email: '<string>'
})
};
fetch('https://api.clarian.finance/v1/{env}/payment-links/{id}/charges', 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/{id}/charges",
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([
'payer_document' => '<string>',
'payer_name' => '<string>',
'amount_minor' => '<string>',
'email' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"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/{id}/charges"
payload := strings.NewReader("{\n \"payer_document\": \"<string>\",\n \"payer_name\": \"<string>\",\n \"amount_minor\": \"<string>\",\n \"email\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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/{id}/charges")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("X-Workspace-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"payer_document\": \"<string>\",\n \"payer_name\": \"<string>\",\n \"amount_minor\": \"<string>\",\n \"email\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clarian.finance/v1/{env}/payment-links/{id}/charges")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["X-Workspace-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"payer_document\": \"<string>\",\n \"payer_name\": \"<string>\",\n \"amount_minor\": \"<string>\",\n \"email\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"payment_link_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"payment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"party_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environment": "sandbox",
"kind": "<string>",
"status": "created",
"amount_minor": "<string>",
"currency": "<string>",
"fee_minor": "<string>",
"description": "<string>",
"provider_ref": "<string>",
"pix_qr_code": "<string>",
"pix_tx_id": "<string>",
"pix_key": "<string>",
"to_address": "<string>",
"network": "<string>",
"tx_hash": "<string>",
"failure_reason": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"idempotency_key": "<string>",
"counterparty": {},
"pix_txid": "<string>",
"from_address": "<string>",
"wallet_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_currency": "<string>",
"target_currency": "<string>",
"exchange_rate": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"failed_at": "2023-11-07T05:31:56Z",
"quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"related_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
}{
"data": {
"payment_link_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"payment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"party_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environment": "sandbox",
"kind": "<string>",
"status": "created",
"amount_minor": "<string>",
"currency": "<string>",
"fee_minor": "<string>",
"description": "<string>",
"provider_ref": "<string>",
"pix_qr_code": "<string>",
"pix_tx_id": "<string>",
"pix_key": "<string>",
"to_address": "<string>",
"network": "<string>",
"tx_hash": "<string>",
"failure_reason": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"idempotency_key": "<string>",
"counterparty": {},
"pix_txid": "<string>",
"from_address": "<string>",
"wallet_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_currency": "<string>",
"target_currency": "<string>",
"exchange_rate": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"failed_at": "2023-11-07T05:31:56Z",
"quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"related_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<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.
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.
Required. The same key with the same request body replays the stored result; the same key with a different body is 409 idempotency_key_reuse.
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).
Available options:
sandbox, live Payment link id.
Body
application/json
Response
Idempotency-Key replay.
Show child attributes
Show child attributes