Get a specific PIX destination by ID.

GET /addresses/pix/{customer_id}/{pix_address_id}

Get a specific PIX destination by ID.

cURL

curl --request GET \
  --url https://api.sandbox.iron.xyz/api/addresses/pix/{customer_id}/{pix_address_id} \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.sandbox.iron.xyz/api/addresses/pix/{customer_id}/{pix_address_id}"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.sandbox.iron.xyz/api/addresses/pix/{customer_id}/{pix_address_id}', 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/{customer_id}/{pix_address_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.iron.xyz/api/addresses/pix/{customer_id}/{pix_address_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.iron.xyz/api/addresses/pix/{customer_id}/{pix_address_id}")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.iron.xyz/api/addresses/pix/{customer_id}/{pix_address_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "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": "[phone]",
      "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>"
}

Authorizations

X-API-Key · string · header · required

API Key

Headers

X-API-Version · string

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.

Path Parameters

customer_id · string<uuid> · required

the ID of the customer

pix_address_id · string<uuid> · required

the ID of the PIX address

Response

200

application/json; charset=utf-8

GET Address Succeeded

PIX Address

Response containing PIX destination details.

created_at · string<date-time> · required

When the address was created

customer_id · string<uuid> · required

The customer ID

id · string<uuid> · required

The ID of the address

recipient · RecipientPix · object · required

RecipientPix

A PIX payout recipient.

Show child attributes

Example:

{
  "account": { "key": "[phone]", "type": "PHONE" },
  "recipient": {
    "family_name": "Turing",
    "given_name": "Alan",
    "type": "Individual"
  },
  "tax_id": "12345678909"
}

status · enum<string> · required

PIX Address Status

Available options: RegistrationPending, Registered, RegistrationFailed

updated_at · string<date-time> · required

When the address was last updated

label · string

Optional label for the address