Skip to main content
POST
Deprecated. This endpoint is no longer available in the public API and is kept for reference only.
Creates a new Brazilian PIX bank account for the specified client. Requires an API key with access level 3 or higher.

Path parameters

clientId
string
required
Unique identifier of the client.

Body

bank_name
string
Name of the bank.
account_alias
string
User-friendly alias for the account.
bank_holder_first_name
string
Account holder’s first name.
bank_holder_last_name
string
Account holder’s last name.
pix_key
string
PIX key (email, phone, CPF, or random key).
document_number
string
CPF or CNPJ document number.
country
string
ISO 3166-1 alpha-3 country code (e.g., BRA).
address
object
Account holder’s address with street_line_1, street_line_2, city, postal_code, state, country.state uses ISO 3166-2 codes that identify country subdivisions in the format {COUNTRY}-{SUBDIVISION} (e.g., USA-CA for California).

Response

See Create US bank account for the full field list. PIX accounts expose pix_key and document_number.