Register your own (the integrator's) PIX payout destination
curl --request PUT \
--url https://api.example.com/v1/accounts/self/payout-config \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"pixKey": "acme@pix.example.com",
"name": "Acme Payments LTDA"
}
'import requests
url = "https://api.example.com/v1/accounts/self/payout-config"
payload = {
"pixKey": "acme@pix.example.com",
"name": "Acme Payments LTDA"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({pixKey: 'acme@pix.example.com', name: 'Acme Payments LTDA'})
};
fetch('https://api.example.com/v1/accounts/self/payout-config', 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.example.com/v1/accounts/self/payout-config",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'pixKey' => 'acme@pix.example.com',
'name' => 'Acme Payments LTDA'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <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.example.com/v1/accounts/self/payout-config"
payload := strings.NewReader("{\n \"pixKey\": \"acme@pix.example.com\",\n \"name\": \"Acme Payments LTDA\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-Key", "<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.put("https://api.example.com/v1/accounts/self/payout-config")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"pixKey\": \"acme@pix.example.com\",\n \"name\": \"Acme Payments LTDA\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/accounts/self/payout-config")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"pixKey\": \"acme@pix.example.com\",\n \"name\": \"Acme Payments LTDA\"\n}"
response = http.request(request)
puts response.read_body{
"hasBankAccount": true
}Accounts
Register your own (the integrator's) PIX payout destination
Register the integrator’s own fee-payout PIX destination at the settlement partner. The settlement partner infers the PIX key type from its format and returns an opaque bank-account id; Caratuva persists only that id — the raw PIX key is never stored. name defaults to the org legal name when omitted. Idempotent: re-PUTting replaces the destination.
PUT
/
v1
/
accounts
/
self
/
payout-config
Register your own (the integrator's) PIX payout destination
curl --request PUT \
--url https://api.example.com/v1/accounts/self/payout-config \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"pixKey": "acme@pix.example.com",
"name": "Acme Payments LTDA"
}
'import requests
url = "https://api.example.com/v1/accounts/self/payout-config"
payload = {
"pixKey": "acme@pix.example.com",
"name": "Acme Payments LTDA"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({pixKey: 'acme@pix.example.com', name: 'Acme Payments LTDA'})
};
fetch('https://api.example.com/v1/accounts/self/payout-config', 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.example.com/v1/accounts/self/payout-config",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'pixKey' => 'acme@pix.example.com',
'name' => 'Acme Payments LTDA'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <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.example.com/v1/accounts/self/payout-config"
payload := strings.NewReader("{\n \"pixKey\": \"acme@pix.example.com\",\n \"name\": \"Acme Payments LTDA\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-Key", "<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.put("https://api.example.com/v1/accounts/self/payout-config")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"pixKey\": \"acme@pix.example.com\",\n \"name\": \"Acme Payments LTDA\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/accounts/self/payout-config")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"pixKey\": \"acme@pix.example.com\",\n \"name\": \"Acme Payments LTDA\"\n}"
response = http.request(request)
puts response.read_body{
"hasBankAccount": true
}Authorizations
apiKeybearer
Body
application/json
Response
200 - application/json
Payout destination configured
⌘I