> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cryptomate.me/llms.txt
> Use this file to discover all available pages before exploring further.

# Create PIX bank account

> Register a Brazilian PIX bank account for a client.

<Warning>
  **Deprecated.** This endpoint is no longer available in the public API and is kept for reference only.
</Warning>

Creates a new Brazilian PIX bank account for the specified client. Requires an API key with access level 3 or higher.

## Path parameters

<ParamField path="clientId" type="string" required>
  Unique identifier of the client.
</ParamField>

## Body

<ParamField body="bank_name" type="string">
  Name of the bank.
</ParamField>

<ParamField body="account_alias" type="string">
  User-friendly alias for the account.
</ParamField>

<ParamField body="bank_holder_first_name" type="string">
  Account holder's first name.
</ParamField>

<ParamField body="bank_holder_last_name" type="string">
  Account holder's last name.
</ParamField>

<ParamField body="pix_key" type="string">
  PIX key (email, phone, CPF, or random key).
</ParamField>

<ParamField body="document_number" type="string">
  CPF or CNPJ document number.
</ParamField>

<ParamField body="country" type="string">
  ISO 3166-1 alpha-3 country code (e.g., `BRA`).
</ParamField>

<ParamField body="address" type="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).
</ParamField>

## Response

See [Create US bank account](/api-reference/management/clients/bank-accounts/create-us-bank-account) for the full field list. PIX accounts expose `pix_key` and `document_number`.

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST "https://api.cryptomate.me/management/clients/client_a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d/banks/pix" \
    -H "x-api-key: $CRYPTOMATE_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "bank_name": "Banco do Brasil",
      "account_alias": "Primary PIX Account",
      "bank_holder_first_name": "João",
      "bank_holder_last_name": "Silva",
      "pix_key": "customer@example.com",
      "document_number": "12345678900",
      "country": "BRA",
      "address": {
        "streetLine1": "Av. Paulista 1000",
        "city": "São Paulo",
        "postal_code": "01310-100",
        "state": "BRA-SP",
        "country": "BRA"
      }
    }'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 OK theme={null}
  {
    "id": "ba_jkl012",
    "client_id": "client_a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
    "bank_name": "Banco do Brasil",
    "type": "PIX",
    "currency": "BRL",
    "pix_key": "customer@example.com",
    "document_number": "12345678900"
  }
  ```

  ```json 404 Not Found theme={null}
  {
    "code": "NOT_FOUND",
    "message": "Client does not have a customer ID for provider BRIDGE"
  }
  ```
</ResponseExample>