curl --request POST \
--url https://api.sandbox.iron.xyz/api/addresses/pix \
--header 'Content-Type: application/json; charset=utf-8' \
--header 'IDEMPOTENCY-KEY: <idempotency-key>' \
--header 'X-API-Key: <api-key>' \
--data '
{
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recipient": {
"account": {
"key": "+5511987654321",
"type": "PHONE"
},
"recipient": {
"family_name": "Turing",
"given_name": "Alan",
"type": "Individual"
},
"tax_id": "12345678909"
},
"label": "<string>"
}
'import requests
url = "https://api.sandbox.iron.xyz/api/addresses/pix"
payload = {
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recipient": {
"account": {
"key": "+5511987654321",
"type": "PHONE"
},
"recipient": {
"family_name": "Turing",
"given_name": "Alan",
"type": "Individual"
},
"tax_id": "12345678909"
},
"label": "<string>"
}
headers = {
"IDEMPOTENCY-KEY": "<idempotency-key>",
"X-API-Key": "<api-key>",
"Content-Type": "application/json; charset=utf-8"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'IDEMPOTENCY-KEY': '<idempotency-key>',
'X-API-Key': '<api-key>',
'Content-Type': 'application/json; charset=utf-8'
},
body: JSON.stringify({
customer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
recipient: {
account: {key: '+5511987654321', type: 'PHONE'},
recipient: {family_name: 'Turing', given_name: 'Alan', type: 'Individual'},
tax_id: '12345678909'
},
label: '<string>'
})
};
fetch('https://api.sandbox.iron.xyz/api/addresses/pix', 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.sandbox.iron.xyz/api/addresses/pix",
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([
'customer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'recipient' => [
'account' => [
'key' => '+5511987654321',
'type' => 'PHONE'
],
'recipient' => [
'family_name' => 'Turing',
'given_name' => 'Alan',
'type' => 'Individual'
],
'tax_id' => '12345678909'
],
'label' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json; charset=utf-8",
"IDEMPOTENCY-KEY: <idempotency-key>",
"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.sandbox.iron.xyz/api/addresses/pix"
payload := strings.NewReader("{\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"recipient\": {\n \"account\": {\n \"key\": \"+5511987654321\",\n \"type\": \"PHONE\"\n },\n \"recipient\": {\n \"family_name\": \"Turing\",\n \"given_name\": \"Alan\",\n \"type\": \"Individual\"\n },\n \"tax_id\": \"12345678909\"\n },\n \"label\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("IDEMPOTENCY-KEY", "<idempotency-key>")
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json; charset=utf-8")
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.sandbox.iron.xyz/api/addresses/pix")
.header("IDEMPOTENCY-KEY", "<idempotency-key>")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json; charset=utf-8")
.body("{\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"recipient\": {\n \"account\": {\n \"key\": \"+5511987654321\",\n \"type\": \"PHONE\"\n },\n \"recipient\": {\n \"family_name\": \"Turing\",\n \"given_name\": \"Alan\",\n \"type\": \"Individual\"\n },\n \"tax_id\": \"12345678909\"\n },\n \"label\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.iron.xyz/api/addresses/pix")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["IDEMPOTENCY-KEY"] = '<idempotency-key>'
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json; charset=utf-8'
request.body = "{\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"recipient\": {\n \"account\": {\n \"key\": \"+5511987654321\",\n \"type\": \"PHONE\"\n },\n \"recipient\": {\n \"family_name\": \"Turing\",\n \"given_name\": \"Alan\",\n \"type\": \"Individual\"\n },\n \"tax_id\": \"12345678909\"\n },\n \"label\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"created_at": "2024-01-15T10:30:00.000Z",
"customer_id": "123e4567-e89b-12d3-a456-426614174000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"label": "Primary PIX",
"recipient": {
"account": {
"key": "+5511987654321",
"type": "PHONE"
},
"recipient": {
"family_name": "Turing",
"given_name": "Alan",
"type": "Individual"
},
"tax_id": "12345678909"
},
"status": "Registered",
"updated_at": "1970-01-01T00:00:00.000Z"
}"<string>"{
"message": "<string>",
"trace_id": "<string>"
}"<string>"{
"message": "<string>",
"trace_id": "<string>"
}Register a PIX destination for a customer.
Registers a PIX payout destination (Brazil / BRL). Check the returned
status to determine whether the destination can be used for payouts.
curl --request POST \
--url https://api.sandbox.iron.xyz/api/addresses/pix \
--header 'Content-Type: application/json; charset=utf-8' \
--header 'IDEMPOTENCY-KEY: <idempotency-key>' \
--header 'X-API-Key: <api-key>' \
--data '
{
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recipient": {
"account": {
"key": "+5511987654321",
"type": "PHONE"
},
"recipient": {
"family_name": "Turing",
"given_name": "Alan",
"type": "Individual"
},
"tax_id": "12345678909"
},
"label": "<string>"
}
'import requests
url = "https://api.sandbox.iron.xyz/api/addresses/pix"
payload = {
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recipient": {
"account": {
"key": "+5511987654321",
"type": "PHONE"
},
"recipient": {
"family_name": "Turing",
"given_name": "Alan",
"type": "Individual"
},
"tax_id": "12345678909"
},
"label": "<string>"
}
headers = {
"IDEMPOTENCY-KEY": "<idempotency-key>",
"X-API-Key": "<api-key>",
"Content-Type": "application/json; charset=utf-8"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'IDEMPOTENCY-KEY': '<idempotency-key>',
'X-API-Key': '<api-key>',
'Content-Type': 'application/json; charset=utf-8'
},
body: JSON.stringify({
customer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
recipient: {
account: {key: '+5511987654321', type: 'PHONE'},
recipient: {family_name: 'Turing', given_name: 'Alan', type: 'Individual'},
tax_id: '12345678909'
},
label: '<string>'
})
};
fetch('https://api.sandbox.iron.xyz/api/addresses/pix', 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.sandbox.iron.xyz/api/addresses/pix",
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([
'customer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'recipient' => [
'account' => [
'key' => '+5511987654321',
'type' => 'PHONE'
],
'recipient' => [
'family_name' => 'Turing',
'given_name' => 'Alan',
'type' => 'Individual'
],
'tax_id' => '12345678909'
],
'label' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json; charset=utf-8",
"IDEMPOTENCY-KEY: <idempotency-key>",
"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.sandbox.iron.xyz/api/addresses/pix"
payload := strings.NewReader("{\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"recipient\": {\n \"account\": {\n \"key\": \"+5511987654321\",\n \"type\": \"PHONE\"\n },\n \"recipient\": {\n \"family_name\": \"Turing\",\n \"given_name\": \"Alan\",\n \"type\": \"Individual\"\n },\n \"tax_id\": \"12345678909\"\n },\n \"label\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("IDEMPOTENCY-KEY", "<idempotency-key>")
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json; charset=utf-8")
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.sandbox.iron.xyz/api/addresses/pix")
.header("IDEMPOTENCY-KEY", "<idempotency-key>")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json; charset=utf-8")
.body("{\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"recipient\": {\n \"account\": {\n \"key\": \"+5511987654321\",\n \"type\": \"PHONE\"\n },\n \"recipient\": {\n \"family_name\": \"Turing\",\n \"given_name\": \"Alan\",\n \"type\": \"Individual\"\n },\n \"tax_id\": \"12345678909\"\n },\n \"label\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.iron.xyz/api/addresses/pix")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["IDEMPOTENCY-KEY"] = '<idempotency-key>'
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json; charset=utf-8'
request.body = "{\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"recipient\": {\n \"account\": {\n \"key\": \"+5511987654321\",\n \"type\": \"PHONE\"\n },\n \"recipient\": {\n \"family_name\": \"Turing\",\n \"given_name\": \"Alan\",\n \"type\": \"Individual\"\n },\n \"tax_id\": \"12345678909\"\n },\n \"label\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"created_at": "2024-01-15T10:30:00.000Z",
"customer_id": "123e4567-e89b-12d3-a456-426614174000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"label": "Primary PIX",
"recipient": {
"account": {
"key": "+5511987654321",
"type": "PHONE"
},
"recipient": {
"family_name": "Turing",
"given_name": "Alan",
"type": "Individual"
},
"tax_id": "12345678909"
},
"status": "Registered",
"updated_at": "1970-01-01T00:00:00.000Z"
}"<string>"{
"message": "<string>",
"trace_id": "<string>"
}"<string>"{
"message": "<string>",
"trace_id": "<string>"
}Authorizations
API Key
Headers
a UUID ensuring an address is only registered once
Selects the API version for this request, as an ISO date (YYYY-MM-DD). Omit to use the default version (2025-03-13). Supported versions: 2025-03-13, 2026-07-01.
Body
The PIX address registration request
Register PIX Address Request
Request to register a PIX payout destination (Brazil / BRL).
The customer ID
RecipientPix
A PIX payout recipient.
Show child attributes
Show child attributes
{
"account": { "key": "+5511987654321", "type": "PHONE" },
"recipient": {
"family_name": "Turing",
"given_name": "Alan",
"type": "Individual"
},
"tax_id": "12345678909"
}
Optional label for the address
Response
Registration successful
PIX Address
Response containing PIX destination details.
When the address was created
The customer ID
The ID of the address
RecipientPix
A PIX payout recipient.
Show child attributes
Show child attributes
{
"account": { "key": "+5511987654321", "type": "PHONE" },
"recipient": {
"family_name": "Turing",
"given_name": "Alan",
"type": "Individual"
},
"tax_id": "12345678909"
}
PIX Address Status
RegistrationPending, Registered, RegistrationFailed When the address was last updated
Optional label for the address
Was this page helpful?

