Skip to main content
POST
/
management
/
clients
/
{clientId}
/
banks
/
pix
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"
    }
  }'

{
  "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"
}
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. 
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"
    }
  }'

{
  "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"
}