Skip to main content
GET
/
addresses
/
pix
/
{customer_id}
Get a customer's PIX destinations.
curl --request GET \
  --url https://api.sandbox.iron.xyz/api/addresses/pix/{customer_id} \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "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"
    }
  ],
  "cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "prev_cursor": null
}

Authorizations

​
X-API-Key
string
header
required

API Key

Path Parameters

​
customer_id
string<uuid>
required

the ID of the customer

Response

GET Addresses Succeeded

PagedList

A list of items with cursors used to fetch the next or previous page

​
items
PixAddress · object[]
required

The list of items

​
cursor
string<uuid>

The cursor used to fetch the next page

​
prev_cursor
string<uuid>

The cursor used to fetch the previous page