Skip to main content
POST
Register a PIX destination for a customer.

Authorizations

X-API-Key
string
header
required

API Key

Headers

IDEMPOTENCY-KEY
string
required

a UUID ensuring an address is only registered once

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.

Body

application/json; charset=utf-8

The PIX address registration request

Register PIX Address Request

Request to register a PIX payout destination (Brazil / BRL).

customer_id
string<uuid>
required

The customer ID

recipient
RecipientPix · object
required

RecipientPix

A PIX payout recipient.

Example:
label
string

Optional label for the address

Response

Registration successful

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.

Example:
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