Create Pix Key

Create Pix Key

post

https://api.aurixpay.wshttps://sandbox.api.aurixpay.ws

/banking/v1/virtual-accounts/{virtual_account_id}/pix-keys

This endpoint creates a new PIX key for a virtual account.

scope: virtual-accounts.write

Path parameters

virtual_account_idstring · uuidRequiredExample: 019b6b3a-a5e3-7254-a50c-9b74dfc6f8af

Header parameters

AcceptstringOptionalExample: application/json

Content-TypestringOptionalExample: application/json

X-API-KeystringRequiredExample: {{API_KEY}}

Body

application/json

virtual_account_idstring · uuidRequired

pix_key_typestring · enumRequiredPossible values:

key_valuestringOptional

Responses

201

Success

application/json

400

Bad Request

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

post

/banking/v1/virtual-accounts/{virtual_account_id}/pix-keys

HTTP

POST /banking/v1/virtual-accounts/019b6b3a-a5e3-7254-a50c-9b74dfc6f8af/pix-keys HTTP/1.1
Host: api.aurixpay.ws
X-API-Key: text
Content-Type: application/json
Accept: application/json

{
  "virtual_account_id": "019b6b3a-a5e3-7254-a50c-9b74dfc6f8af",
  "pix_key_type": "random"
}

{
  "virtual_account_id": "019b6b3a-a5e3-7254-a50c-9b74dfc6f8af",
  "pix_key_type": "random",
  "pix_key": "43ff4c51-e50c-43ea-a7de-581cc4a6167b",
  "id": "019b6b6c-f50f-7294-8361-e2e1b9d8e73a",
  "updated_at": "2025-12-29T18:44:21.000000Z",
  "created_at": "2025-12-29T18:44:21.000000Z",
  "virtual_account": {
    "id": "019b6b3a-a5e3-7254-a50c-9b74dfc6f8af",
    "label": "pix key",
    "currency": "BRL"
  }
}